API ReferenceReturns

Get Return Order

View as Markdown
Retrieves the complete details of a specific return order by its unique ID. Use this to view return status, inventory items, transactions, and processing history.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Path parameters

idstringRequiredformat: "int32"
The Id of the Return

Headers

shipbob_channel_idstringOptionalformat: "int32"

Retrieve your channel ID from the GET /channel endpoint. Use the channel ID that has write scopes.

Response

OK
arrived_datedatetime or null
The date and time when the return arrived at the fulfillment center
awaiting_arrival_datedatetime or null
The date and time when the return entered Awaiting Arrival status
cancelled_datedatetime or null
The date and time when the return was cancelled, if applicable
channelobject or null
The details of a Channel
completed_datedatetime or null
The date and time for when the return order was completely processed
customer_namestring or null
Name of merchant that return belongs to
fulfillment_centerobject or null
The details of a Fulfillment Center
idinteger or null
Unique id of the return order
insert_datedatetime or null
The date and time for when the return order was created
inventorylist of objects or null
List of inventory items in return order
invoiceobject or null
The invoice amount and curency
original_shipment_idinteger or null
ShipmentId for which return was created
processing_datedatetime or null
The date and time when the return started processing
reference_idstring or null
Unique reference id of the return order. Created by merchant if a regular return.
return_typestring or null
Type of the return, i.e. Regular, RTS
shipment_tracking_numberstring or null
The tracking number of the original shipment
statusstring or null
Status of the return order, i.e. Awaiting Arrival
status_historylist of objects or null
List of status history in return order
store_order_idstring or null
Reference to external order id
tracking_numberstring or null
The tracking number of the return shipping label
transactionslist of objects or null
List of transactions that make up the billable amount to invoice a merchant

Errors