Backend API
Fields
Unique identifier for the return.
ID of the order this return was created for.
Indicates the return was canceled.
ID of a third-party carrier offering the service, if applicable.
Name of a third-party carrier offering the service, if applicable.
Total amount of taxes credited to the order for the returned items.
Total amount of additional credit applied to the order.
Three-letter ISO currency code in uppercase. Defaults to the store's base currency.
Date and time the return was created.
Date the expected return shipment is meant to arrive at a warehouse, if applicable.
Date and time the return was last updated.
The intended return destination.
ID of the intended return destination, if applicable.
Arbitrary amount to apply to the order as compensation for their inconvenience.
Total quantity of line items that can still be received in a return shipment.
Total quantity of line items that have been received in a return shipment.
Total quantity of line items that can still be restocked to product inventory.
Total quantity of line items that have been restocked to product inventory.
Internal admin notes, not visible to the customer.
Expandable list of notifications sent on behalf of the products returned.
Unique incremental return number, assigned automatically.
Expandable link to the order.
The customer's location of origin for the return shipment.
Origin customer name.
Two-letter ISO country code in uppercase.
Origin address line 1: street address/PO box/company name.
Origin address line 2: apartment/suite/unit/building.
Origin city/district/suburb/town/village.
Origin state/county/province/region.
Origin zip/postal code.
Origin phone number.
Code indicating the reason for the return.
Indicates that all items have been received in a return shipment.
Amount to charge the customer for re-stocking the returned items.
ID of a shipping service as configured in shipment settings.
Name of the return shipping service.
Amount to apply to the order as a credit as compensation for the original shipping tax.
Amount to apply to the order as a credit as compensation for the original shipping price.
Tracking code used to identify the return shipment, if applicable.
The return model
{
"id": "60f199509111e70000000078",
"items": [
{
"id": "5ca537326a0ec32a521139dd",
"order_item_id": "5a9ea7ba3f95740a914267f2",
"product_id": "5cad15bc9b14d1990724663b",
"quantity": 2,
"quantity_received": 0,
"quantity_receivable": 2,
"quantity_restocked": 0,
"quantity_restockable": 2
}
],
"order_id": "60f199509111e7000000007a",
"currency": "USD",
"date_created": "2021-07-16T14:36:00.399Z",
"date_updated": "2021-07-16T14:36:00.399Z",
"origin": {
"name": "Jon Snow",
"address1": "1 Main Street",
"city": "Brooklyn",
"state": "NY",
"zip": 11201,
"country": "US",
"phone": "(555) 555-5555"
},
"received": false,
"service": "fedex_ground",
"tracking_code": "T192000000XYZ"
}