List Return Reasons

Retrieve a list of Return Reasons. This is useful when implementing a Create Return flow in the storefront.

Responses

🟢200OK

application/json

Body

The list of return reasons.

return_reasons

array[object (Return Reason) {11}]

required

An array of return reasons details.

string

required

The return reason's ID

Example:

rr_01G8X82GCCV2KSQHDBHSSAH5TQ

value

string

required

The value to identify the reason by.

Example:

damaged

label

string

required

A text that can be displayed to the Customer as a reason.

Example:

Damaged goods

description

string | null

required

A description of the Reason.

Example:

Items that are damaged

parent_return_reason_id

string | null

required

The ID of the parent reason.

Example:

null

parent_return_reason

object | null

optional

The details of the parent reason.

return_reason_children

object

optional

The details of the child reasons.

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

Example

{
  "return_reasons": [
    {
      "id": "rr_01G8X82GCCV2KSQHDBHSSAH5TQ",
      "value": "damaged",
      "label": "Damaged goods",
      "description": "Items that are damaged",
      "parent_return_reason_id": null,
      "parent_return_reason": {},
      "return_reason_children": {},
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      }
    }
  ]
}

🟠400Client Error or Multiple Errors

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

List Return Reasons

Request

Request samples

Responses