Skip to content

Create Return

POST /returns command bearer

Initiates a return request against a closed order, creating a Return record with the lines to be returned.

Overview
ID create-return-api
Method POST
Path /returns
Classification command
Domain fulfillment
Capability returns-management
Service request-return
Application fms — FMS
Auth bearer

Request Body
Business Object order
Description Confirmed commercial commitment created from checkout or assisted selling.
Classification aggregate-root
Lifecycle draft → confirmed → in-fulfilment → partially-fulfilled → completed → return-in-progress → cancelled

Response
Business Object return
Description Return request and execution record for merchandise or order value moving back from a customer.
Lifecycle requested → approved → in-transit → received → inspected → refunded → exchanged → rejected

Events Emitted

Event Classification Object Description
return-requested created return A customer submitted a request to return one or more items from an order.
return-created created return A Return request has been created against a closed order.

Scenarios using returns-management

Scenario Description
Buy Online, Return In Store Customer purchased online (any channel) and returns the item at a physical store. The store processe
Exchange Anywhere Customer exchanges an item purchased in any channel at any supported touchpoint. The original item i
Unified Return Customer returns an item regardless of the original purchase channel. The return may be initiated on
API Method Path Type
Get Fulfillment Order GET /fulfillment/orders/{id} query
Dispatch Fulfillment Order POST /fulfillment/orders/{id}/dispatch action
Create Picking Order POST /picking-orders command
Update Picking Status PUT /picking-orders/{id}/status action
Track Shipment GET /shipments/{id}/tracking query
Generate Shipping Label POST /shipments/{id}/label command