v1
latestOpenAPI 3.1.02026-07-134488210.8 KBReturns
Create Return
Create a return for specific order line items. Requires the returns_write scope.
post/stores/{storeId}/returns
Headers
Idempotency-Keystring
Optional idempotency key for safely retrying create requests.
Request body
Example request
{
"data": {
"provider": "shopify"
}
}Response
Success (idempotent replay; existing return returned)
Example response
{
"return": {
"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"
}
}