List Returns

curl --request GET \
  --url https://api.getredo.com/v2.2/stores/{storeId}/returns \
  --header 'Authorization: Bearer <token>'

{
  "orders": [
    {
      "customer": {
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "emailAddress": "[email protected]",
        "phoneNumber": "<string>"
      },
      "discounts": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "id": "64e4da943dd822979a70bd12",
      "items": [
        {
          "fulfillmentLocationId": "123",
          "id": "<string>",
          "price": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          },
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "externalId": "123"
        }
      ],
      "lineItemsTotal": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "name": "<string>",
      "shippingCost": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "taxes": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "total": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "externalId": "<string>"
    }
  ],
  "returns": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "phoneNumber": "<string>"
      },
      "giftCards": [
        {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "code": "<string>",
          "externalId": "<string>"
        }
      ],
      "id": "<string>",
      "items": [
        {
          "id": "<string>",
          "orderItem": {
            "id": "<string>",
            "line_item_id": "<string>"
          },
          "quantity": 123,
          "reason": "<string>",
          "assessments": [
            {
              "assignedUser": {
                "email": "<string>",
                "firstName": "<string>",
                "id": "<string>",
                "lastName": "<string>",
                "name": "<string>"
              },
              "responses": [
                {
                  "type": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "customerComment": "<string>",
          "exchangeItem": {
            "product": {
              "externalId": "<string>",
              "name": "<string>"
            },
            "quantity": 123,
            "variant": {
              "externalId": "<string>",
              "name": "<string>"
            }
          },
          "greenReturn": true,
          "multipleChoiceQuestions": [
            {
              "answer": "<string>",
              "question": "<string>"
            }
          ],
          "productAdjustment": "<string>",
          "productId": "<string>",
          "reasonCode": "<string>",
          "reasonCodes": [
            "<string>"
          ],
          "reasons": [
            "<string>"
          ],
          "refund": {
            "amount": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "type": "<string>"
          },
          "sku": "<string>",
          "status": "<string>",
          "variantId": "<string>"
        }
      ],
      "order": {
        "id": "abc123"
      },
      "source": {
        "emailAddress": "[email protected]",
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "phoneNumber": "<string>"
      },
      "status": "open",
      "updatedAt": "2023-11-07T05:31:56Z",
      "compensationMethods": [
        "refund"
      ],
      "exchange": {
        "items": [
          {
            "id": "<string>",
            "quantity": 1,
            "variant": {
              "name": "<string>",
              "externalId": "<string>",
              "sku": "<string>",
              "weight": {
                "kg": 1
              }
            },
            "originalPrice": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "price": {
              "amount": "<string>",
              "currency": "<string>",
              "tax": "<string>"
            },
            "product": {
              "name": "<string>",
              "externalId": "<string>"
            }
          }
        ],
        "provision": "deferred",
        "itemCount": 123,
        "order": {
          "externalId": "<string>"
        },
        "totalTax": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "externalOrderIds": [
        "<string>"
      ],
      "internalCreatedByName": "<string>",
      "notes": [
        {
          "message": "<string>",
          "image": "<string>"
        }
      ],
      "shipment": {
        "carrier": "<string>",
        "postageLabel": "<string>",
        "status": "unknown",
        "tracker": "<string>",
        "trackingUrl": "<string>"
      },
      "shipments": [
        {
          "carrier": "<string>",
          "postageLabel": "<string>",
          "status": "unknown",
          "tracker": "<string>",
          "trackingUrl": "<string>"
        }
      ],
      "shopifyOrderIds": [
        "<string>"
      ],
      "totals": {
        "charge": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "exchange": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "storeCredit": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        }
      },
      "type": "return"
    }
  ]
}

GET

stores

{storeId}

returns

List Returns

curl --request GET \
  --url https://api.getredo.com/v2.2/stores/{storeId}/returns \
  --header 'Authorization: Bearer <token>'

{
  "orders": [
    {
      "customer": {
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "emailAddress": "[email protected]",
        "phoneNumber": "<string>"
      },
      "discounts": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "id": "64e4da943dd822979a70bd12",
      "items": [
        {
          "fulfillmentLocationId": "123",
          "id": "<string>",
          "price": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          },
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "externalId": "123"
        }
      ],
      "lineItemsTotal": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "name": "<string>",
      "shippingCost": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "taxes": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "total": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "externalId": "<string>"
    }
  ],
  "returns": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "phoneNumber": "<string>"
      },
      "giftCards": [
        {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "code": "<string>",
          "externalId": "<string>"
        }
      ],
      "id": "<string>",
      "items": [
        {
          "id": "<string>",
          "orderItem": {
            "id": "<string>",
            "line_item_id": "<string>"
          },
          "quantity": 123,
          "reason": "<string>",
          "assessments": [
            {
              "assignedUser": {
                "email": "<string>",
                "firstName": "<string>",
                "id": "<string>",
                "lastName": "<string>",
                "name": "<string>"
              },
              "responses": [
                {
                  "type": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "customerComment": "<string>",
          "exchangeItem": {
            "product": {
              "externalId": "<string>",
              "name": "<string>"
            },
            "quantity": 123,
            "variant": {
              "externalId": "<string>",
              "name": "<string>"
            }
          },
          "greenReturn": true,
          "multipleChoiceQuestions": [
            {
              "answer": "<string>",
              "question": "<string>"
            }
          ],
          "productAdjustment": "<string>",
          "productId": "<string>",
          "reasonCode": "<string>",
          "reasonCodes": [
            "<string>"
          ],
          "reasons": [
            "<string>"
          ],
          "refund": {
            "amount": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "type": "<string>"
          },
          "sku": "<string>",
          "status": "<string>",
          "variantId": "<string>"
        }
      ],
      "order": {
        "id": "abc123"
      },
      "source": {
        "emailAddress": "[email protected]",
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "phoneNumber": "<string>"
      },
      "status": "open",
      "updatedAt": "2023-11-07T05:31:56Z",
      "compensationMethods": [
        "refund"
      ],
      "exchange": {
        "items": [
          {
            "id": "<string>",
            "quantity": 1,
            "variant": {
              "name": "<string>",
              "externalId": "<string>",
              "sku": "<string>",
              "weight": {
                "kg": 1
              }
            },
            "originalPrice": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "price": {
              "amount": "<string>",
              "currency": "<string>",
              "tax": "<string>"
            },
            "product": {
              "name": "<string>",
              "externalId": "<string>"
            }
          }
        ],
        "provision": "deferred",
        "itemCount": 123,
        "order": {
          "externalId": "<string>"
        },
        "totalTax": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "externalOrderIds": [
        "<string>"
      ],
      "internalCreatedByName": "<string>",
      "notes": [
        {
          "message": "<string>",
          "image": "<string>"
        }
      ],
      "shipment": {
        "carrier": "<string>",
        "postageLabel": "<string>",
        "status": "unknown",
        "tracker": "<string>",
        "trackingUrl": "<string>"
      },
      "shipments": [
        {
          "carrier": "<string>",
          "postageLabel": "<string>",
          "status": "unknown",
          "tracker": "<string>",
          "trackingUrl": "<string>"
        }
      ],
      "shopifyOrderIds": [
        "<string>"
      ],
      "totals": {
        "charge": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "exchange": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "storeCredit": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        }
      },
      "type": "return"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Page-Continue

string

Page marker, from X-Page-Next header

X-Page-Size

integer

Page size, defaults to 20

Required range: 1 <= x <= 500

Path Parameters

storeId

string

required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Query Parameters

updated_at_max

string<date-time>

Maximum updated time, exclusive

updated_at_min

string<date-time>

Minimum updated time, inclusive

shopify_order_name

string

Shopify specific order name

Example:

"XYZ1025"

provider_order_name

string

Provider specific order name

Example:

"XYZ1025"

Response

Success

orders

Order · object[]

required

Show child attributes

orders.customer

object

required

Show child attributes

orders.customer.name

Name · object

required

Name of customer.

Show child attributes

orders.customer.name.given

string

required

Given name

orders.customer.name.surname

string

required

Surname

orders.customer.emailAddress

string<email>

Email address of customer.

orders.customer.phoneNumber

string

Phone number of customer.

orders.discounts

Discounts · object

required

The total amount discounted on the order before returns. This includes both order and line level discounts.

Show child attributes

orders.discounts.amount

string

orders.discounts.currency

string

orders.id

string

required

Order ID

Example:

"64e4da943dd822979a70bd12"

orders.items

Line items · object[]

required

Show child attributes

orders.items.fulfillmentLocationId

string | null

required

ID of the location where the item was be fulfilled.

Example:

"123"

orders.items.id

string

required

Line item ID

orders.items.price

Price · object

required

Currency amount

Show child attributes

orders.items.price.amount

string

orders.items.price.currency

string

orders.items.product

Product · object

required

Product.

Show child attributes

orders.items.product.name

string

required

Product title

orders.items.product.externalId

string

Product ID in external system (e.g. shopify).

orders.items.quantity

number

required

Item quantity.

Example:

1

orders.items.variant

Variant · object

required

Show child attributes

orders.items.variant.name

string

required

orders.items.variant.externalId

string

orders.items.variant.sku

string

orders.items.variant.weight

Weight · object

Weight.

Show child attributes

orders.items.variant.weight.kg

number

Weight in kilograms

Required range: x >= 0

orders.items.externalId

string

Example:

"123"

orders.lineItemsTotal

Line Items Total · object

required

Total price of all line items before discounts, shipping, and taxes.

Show child attributes

orders.lineItemsTotal.amount

string

orders.lineItemsTotal.currency

string

orders.name

string

required

Shopify name.

orders.shippingCost

Shipping Cost · object

required

The total shipping cost for the order. This includes fees and any related discounts that were refunded.

Show child attributes

orders.shippingCost.amount

string

orders.shippingCost.currency

string

orders.taxes

Taxes · object

required

Total taxes applied to the order.

Show child attributes

orders.taxes.amount

string

orders.taxes.currency

string

orders.total

Total · object

required

The total price of the order, before returns. This includes taxes, discounts, and shipping costs.

Show child attributes

orders.total.amount

string

orders.total.currency

string

orders.externalId

string

Shopify ID

returns

Return · object[]

required

Show child attributes

returns.createdAt

string<date-time>

required

Time of creation.

returns.destination

object

required

Show child attributes

returns.destination.mailingAddress

Mailing address · object

Mailing address to send the returned items.

Show child attributes

returns.destination.mailingAddress.city

string

required

City name

returns.destination.mailingAddress.country

string

required

Country code

returns.destination.mailingAddress.line1

string

required

Line 1

returns.destination.mailingAddress.postalCode

string

required

Postal or ZIP code

returns.destination.mailingAddress.state

string

required

State or province

returns.destination.mailingAddress.line2

string

default:""

Line 2

returns.destination.phoneNumber

string

Phone number of the destination.

returns.giftCards

Gift cards · object[]

required

Gift card(s) created for return

Show child attributes

returns.giftCards.amount

Amount · object

required

Currency amount

Show child attributes

returns.giftCards.amount.amount

string

returns.giftCards.amount.currency

string

returns.giftCards.code

string

required

Gift card 16 digit code.

returns.giftCards.externalId

string

required

Gift card ID.

returns.id

string

required

Return identifier.

returns.items

object[]

required

Return items

Show child attributes

returns.items.id

string

required

Return item ID.

returns.items.orderItem

Order item · object

required

Order line item

Show child attributes

returns.items.orderItem.id

string

required

Line item reference ID in format: {orderId}/{lineItemIndex}

returns.items.orderItem.line_item_id

string

Original Shopify line item ID

returns.items.quantity

integer

required

Quantity of items being returned

returns.items.reason

string

required

Primary return reason

returns.items.assessments

object[]

Assessment records for this return item. Only applicable for warranties.

Show child attributes

returns.items.assessments.assignedUser

object

required

User assigned to this assessment

Show child attributes

returns.items.assessments.assignedUser.email

string

required

returns.items.assessments.assignedUser.firstName

string

required

returns.items.assessments.assignedUser.id

string

required

returns.items.assessments.assignedUser.lastName

string

required

returns.items.assessments.assignedUser.name

string

required

returns.items.assessments.responses

required

Assessment responses

Show child attributes

returns.items.assessments.responses.type

string

required

Allowed value: "short_text"

returns.items.assessments.responses.value

string

required

Short text response value

returns.items.customerComment

string

Customer's comment about the return

returns.items.exchangeItem

Exchange item · object

Exchange item details if this return item is being exchanged

Show child attributes

returns.items.exchangeItem.product

object

Show child attributes

returns.items.exchangeItem.product.externalId

string

returns.items.exchangeItem.product.name

string

returns.items.exchangeItem.quantity

integer

returns.items.exchangeItem.variant

object

Show child attributes

returns.items.exchangeItem.variant.externalId

string

returns.items.exchangeItem.variant.name

string

returns.items.greenReturn

boolean

Whether this is a green return (no physical return required)

returns.items.multipleChoiceQuestions

object[]

Multiple choice questions and answers for this return item

Show child attributes

returns.items.multipleChoiceQuestions.answer

string

required

The selected answer

returns.items.multipleChoiceQuestions.question

string

required

The question text

returns.items.productAdjustment

string

Product adjustment details

returns.items.productId

string

Product ID

returns.items.reasonCode

string

Return reason code

returns.items.reasonCodes

string[]

Array of return reason codes

returns.items.reasons

string[]

Array of return reasons

returns.items.refund

object

Refund details

Show child attributes

returns.items.refund.amount

Amount · object

required

Currency amount

Show child attributes

returns.items.refund.amount.amount

string

returns.items.refund.amount.currency

string

returns.items.refund.type

string

Refund strategy

returns.items.sku

string

Product SKU

returns.items.status

string

Return item status

returns.items.variantId

string

Product variant ID

returns.order

Order · object

required

Original order.

Show child attributes

returns.order.id

string

required

Order ID.

Example:

"abc123"

returns.source

object

required

Show child attributes

returns.source.emailAddress

string<email>

required

Email address.

returns.source.mailingAddress

Mailing address · object

required

Mailing address returned items are sent from.

Show child attributes

returns.source.mailingAddress.city

string

required

City name

returns.source.mailingAddress.country

string

required

Country code

returns.source.mailingAddress.line1

string

required

Line 1

returns.source.mailingAddress.postalCode

string

required

Postal or ZIP code

returns.source.mailingAddress.state

string

required

State or province

returns.source.mailingAddress.line2

string

default:""

Line 2

returns.source.name

Name · object

required

Name of returner.

Show child attributes

returns.source.name.given

string

required

Given name

returns.source.name.surname

string

required

Surname

returns.source.phoneNumber

string

required

Phone number of returner.

returns.status

enum<string>

required

Return status.

Available options:

open,

in_transit,

delivered,

needs_review,

in_review,

complete,

rejected,

flagged,

pre_shipment,

deleted

Example:

"open"

returns.updatedAt

string<date-time>

required

Time of last update.

returns.compensationMethods

enum<string>[]

Array of compensation methods available for this return

Available options:

refund,

store_credit,

exchange

returns.exchange

Exchange · object

Exchange order

Show child attributes

returns.exchange.items

Line items · object[]

required

Show child attributes

returns.exchange.items.id

string

required

returns.exchange.items.quantity

number

required

Item quantity.

Example:

1

returns.exchange.items.variant

Product variant · object

required

Show child attributes

returns.exchange.items.variant.name

string

required

returns.exchange.items.variant.externalId

string

returns.exchange.items.variant.sku

string

returns.exchange.items.variant.weight

Weight · object

Weight.

Show child attributes

returns.exchange.items.variant.weight.kg

number

Weight in kilograms

Required range: x >= 0

returns.exchange.items.originalPrice

object

Original price for the exchange item without discounts and taxes

Show child attributes

returns.exchange.items.originalPrice.amount

string

returns.exchange.items.originalPrice.currency

string

returns.exchange.items.price

object

Subtotal price for the exchange item including discounts

Show child attributes

returns.exchange.items.price.amount

string

returns.exchange.items.price.currency

string

returns.exchange.items.price.tax

string

returns.exchange.items.product

Product · object

Product.

Show child attributes

returns.exchange.items.product.name

string

required

Product title

returns.exchange.items.product.externalId

string

Product ID in external system (e.g. shopify).

returns.exchange.provision

enum<string>

required

Available options:

instant,

deferred

Example:

"deferred"

returns.exchange.itemCount

integer

Total quantity of all exchange items

returns.exchange.order

object

Show child attributes

returns.exchange.order.externalId

string

ID of external order

returns.exchange.totalTax

object

Total tax for exchange items

Show child attributes

returns.exchange.totalTax.amount

string

returns.exchange.totalTax.currency

string

returns.externalOrderIds

string[]

Array of external order IDs associated with this return

returns.internalCreatedByName

string

Name of the internal team member who created this return

returns.notes

Notes · object[]

Teammembers generated notes and comments on the return

Show child attributes

returns.notes.message

string

required

The note text

returns.notes.image

string

Optional image URL attached to the note

returns.shipment

Shipment · object

Shipment, if has been made

Show child attributes

returns.shipment.carrier

string

Carrier code

returns.shipment.postageLabel

string

Postage label URL

returns.shipment.status

enum<string>

Status of shipment

Available options:

unknown,

pre_transit,

in_transit,

out_for_delivery,

available_for_pickup,

cancelled,

delivered,

error,

failure,

return_to_sender,

expired

returns.shipment.tracker

string

Tracking number

returns.shipment.trackingUrl

string

Tracking URL

returns.shipments

Return Shipment · object[]

Array of all shipments associated with this return

Show child attributes

returns.shipments.carrier

string

Carrier code

returns.shipments.postageLabel

string

Postage label URL

returns.shipments.status

enum<string>

Status of shipment

Available options:

unknown,

pre_transit,

in_transit,

out_for_delivery,

available_for_pickup,

cancelled,

delivered,

error,

failure,

return_to_sender,

expired

returns.shipments.tracker

string

Tracking number

returns.shipments.trackingUrl

string

Tracking URL

returns.shopifyOrderIds

string[]

Array of Shopify order IDs (deprecated, use externalOrderIds)

returns.totals

Totals · object

Calculated totals for the return

Show child attributes

returns.totals.charge

object

required

The upsell amount for the exchange order

Show child attributes

returns.totals.charge.amount

Money · object

required

Currency amount

Show child attributes

returns.totals.charge.amount.amount

string

returns.totals.charge.amount.currency

string

returns.totals.exchange

object

required

Total value of new items in exchange

Show child attributes

returns.totals.exchange.amount

Money · object

required

Currency amount

Show child attributes

returns.totals.exchange.amount.amount

string

returns.totals.exchange.amount.currency

string

returns.totals.refund

object

required

Total refund amount excluding shipping

Show child attributes

returns.totals.refund.amount

Money · object

required

Currency amount

Show child attributes

returns.totals.refund.amount.amount

string

returns.totals.refund.amount.currency

string

returns.totals.storeCredit

object

required

Total store credit amount

Show child attributes

returns.totals.storeCredit.amount

Money · object

required

Currency amount

Show child attributes

returns.totals.storeCredit.amount.amount

string

returns.totals.storeCredit.amount.currency

string

returns.type

enum<string>

Return type.

Available options:

claim,

return,

warranty

Example:

"return"

Update Return Status

Return event

⌘I

Getting Started

Endpoints

List Returns

Authorizations

Headers

Path Parameters

Query Parameters

Response