v1
latestOpenAPI 3.1.02026-07-134488210.8 KBReturns
List Returns
List returns, sorted by most recent to least recent. Requires the returns_read scope.
get/stores/{storeId}/returns
Query parameters
updated_at_maxstring date-time
Maximum updated time, exclusive
updated_at_minstring date-time
Minimum updated time, inclusive
shopify_order_namestring
Example:XYZ1025
Shopify specific order name
provider_order_namestring
Example:XYZ1025
Provider specific order name
status'open' | 'in_transit' | 'delivered' | 'needs_review' | 'in_review' | 'complete' | 'rejected' | 'flagged' | 'pre_shipment' | 'deleted'
Return status.
- open: Return has been approved and is awaiting shipment.
- in_transit: Return shipment is in transit.
- delivered: Return shipment has been delivered and awaiting processing.
- needs_review: Return requires review before further action.
- in_review: Return is currently being reviewed.
- complete: The return has been completed successfully.
- rejected: The return has been rejected.
- flagged: A problem with return processing requires merchant action.
- pre_shipment: Return requires pre-shipment merchant authorization.
- deleted: The return has been deleted (Reset).
Example:open
Filter returns by status
Headers
X-Page-Continuestring
Page marker, from X-Page-Next header
X-Page-Sizeinteger
Page size, defaults to 20
Response
Success
Example response
{
"orders": [
{
"customer": {
"name": {
"given": "John",
"surname": "Smith"
},
"phoneNumber": "+15555555555"
},
"discounts": {
"amount": "50.2",
"currency": "USD"
},
"externalId": "1073459971",
"id": "64e4da943dd822979a70bd12",
"items": [
{
"externalId": "123",
"fulfillmentLocationId": "123",
"price": {
"amount": "50.2",
"currency": "USD"
},
"quantity": 1,
"variant": {
"weight": {
"kg": 0.021
}
}
}
],
"lineItemsTotal": {
"amount": "50.2",
"currency": "USD"
},
"name": "#123",
"shippingCost": {
"amount": "50.2",
"currency": "USD"
},
"taxes": {
"amount": "50.2",
"currency": "USD"
},
"total": {
"amount": "50.2",
"currency": "USD"
}
}
],
"returns": [
{
"destination": {
"mailingAddress": {
"city": "Anytown",
"country": "US",
"line1": "123 Main St",
"postalCode": "12345",
"state": "WA"
},
"phoneNumber": "+15555555555"
},
"exchange": {
"items": [
{
"quantity": 1,
"variant": {
"weight": {
"kg": 0.021
}
}
}
],
"provision": "deferred"
},
"externalReturnIds": [
{
"provider": "shopify",
"value": "12345"
}
],
"giftCards": [
{
"amount": {
"amount": "50.2",
"currency": "USD"
}
}
],
"id": "64df65d4c5a4ca3eff4b4e43",
"items": [
{
"reason": "Too big",
"refund": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
},
"productValueNoTaxNoAdjustment": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
}
}
],
"order": {
"id": "64e4da943dd822979a70bd12",
"name": "#123"
},
"source": {
"mailingAddress": {
"city": "Anytown",
"country": "US",
"line1": "123 Main St",
"postalCode": "12345",
"state": "WA"
},
"name": {
"given": "John",
"surname": "Smith"
},
"phoneNumber": "+15555555555"
},
"status": "open",
"totals": {
"charge": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
},
"exchange": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
},
"refund": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
},
"storeCredit": {
"amount": {
"amount": "50.2",
"currency": "USD"
}
}
},
"type": "return"
}
]
}