Create Return Order
Creates a new return order for a previously shipped order. Specify the original shipment, inventory items to return, and requested return actions. If purchase_label is true, also purchases a return shipping label using origin_address, falling back to the original_shipment_id address when no origin_address is provided; when both are supplied, origin_address takes precedence. tracking_number is not allowed when purchase_label is true. Each inventory item can be identified by id (inventory ID) or sku; when both are supplied, id takes precedence.
Authentication
Authentication using Personal Access Token (PAT) token
Headers
Retrieve your channel ID from the GET /channel endpoint. Use the channel ID that has write scopes.
Query parameters
Request
Response
Return order created successfully. When purchase_label is true and the label purchase succeeds, both return and label are populated. When purchase_label is false, only return is populated. When purchase_label is true but the label purchase fails, return is populated, label is null, and label_error explains the failure.
Return shipping label details. Populated only when purchase_label is true and the label purchase succeeded. Null when purchase_label is false or the label purchase failed (in which case label_error explains why).
Human-readable error message if label purchase was requested but failed. The return is still created in this case — only the label step failed.