Skip to content

Request a return / 14-day withdrawal on MY order (no IDOR)

POST
/store/v1/customers/me/orders/{orderId}/returns
curl --request POST \
--url https://your-store.example.com/store/v1/customers/me/orders/example/returns \
--header 'Content-Type: application/json' \
--data '{ "type": "return", "items": [ { "orderItemId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1 } ], "reason": "example" }'
orderId
required
string
Media type application/json
object
type
required
string
Allowed values: return withdrawal
items
required
Array<object>
>= 1 items
object
orderItemId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
quantity
required
integer
> 0 <= 9007199254740991
reason
string
>= 1 characters <= 1000 characters