Create an Order Return

Initiate a return request for one or more items in an order. This creates a return authorization record in the connected platform, which the merchant can then approve, reject, or process. The return request typically includes the items to be returned, quantities, and the reason for the return.

Common use cases include automating return request creation from a customer self-service portal and triggering platform-side return workflows from an external OMS.

Note: Required fields, accepted return reasons, and the return flow (approval-based vs. automatic) vary by platform.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Available platforms

This endpoint is supported by 2 platforms. Click on each platform to see its specific required fields and return flow.

Shopify · TikTok

Same schema, platform-aware details. Required fields, accepted return reasons, and whether the return requires approval vary by platform.

Path Params
string
required

The unique identifier of the order.

Body Params

Return request data. Required fields vary by platform.

string

Reason for the return (e.g., defective, not_as_described, changed_mind, wrong_item). Accepted values vary by platform.

string

Additional notes from the customer explaining the reason for the return. Optional.

lineItems
array of objects

List of order line items to include in this return request.

lineItems
number

Refund amount to issue when the return is approved. Some platforms calculate this automatically. Optional.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json