For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
DocumentationAPI Reference
DocumentationAPI Reference
  • API Reference
      • GETGet Return Order
      • PUTModify Return Order
      • GETGet Return Orders
      • POSTCreate Return Order
      • POSTCancel Return order
LogoLogo
API ReferenceReturns

Get Return Order

||View as Markdown|
GET
https://sandbox-api.shipbob.com/2025-07/return/:id
GET
/2025-07/return/:id
$curl https://sandbox-api.shipbob.com/2025-07/return/1 \
>     -H "Authorization: Bearer <token>"
1{
2  "arrived_date": "2019-08-24T14:15:22+00:00",
3  "awaiting_arrival_date": "2019-08-24T14:15:22+00:00",
4  "cancelled_date": "2019-08-24T14:15:22+00:00",
5  "channel": {
6    "id": 0,
7    "name": "string"
8  },
9  "completed_date": "2019-08-24T14:15:22+00:00",
10  "customer_name": "string",
11  "fulfillment_center": {
12    "id": 0,
13    "name": "string"
14  },
15  "id": 0,
16  "insert_date": "2019-08-24T14:15:22+00:00",
17  "inventory": [
18    {
19      "action_requested": {
20        "action": "string",
21        "action_type": "string",
22        "instructions": "string"
23      },
24      "action_taken": [
25        {
26          "action": "string",
27          "action_reason": "string",
28          "image_url": "http://example.com",
29          "quantity_processed": 0
30        }
31      ],
32      "barcodes": [
33        "string"
34      ],
35      "id": 0,
36      "lot_information": {
37        "expiration": "2019-08-24T14:15:22+00:00",
38        "minimumShelfLife": 0,
39        "number": "string"
40      },
41      "name": "string",
42      "quantity": 0,
43      "sku": "string"
44    }
45  ],
46  "invoice": {
47    "amount": 0.1,
48    "currency_code": "string"
49  },
50  "original_shipment_id": 0,
51  "processing_date": "2019-08-24T14:15:22+00:00",
52  "reference_id": "string",
53  "return_type": "string",
54  "shipment_tracking_number": "string",
55  "status": "string",
56  "status_history": [
57    {
58      "status": "string",
59      "timestamp": "2019-08-24T14:15:22+00:00"
60    }
61  ],
62  "store_order_id": "string",
63  "tracking_number": "string",
64  "transactions": [
65    {
66      "amount": 0.1,
67      "transaction_type": "string"
68    }
69  ]
70}
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.
Was this page helpful?
Previous

Get Inventory Distributions by WRO ID

Next

Modify Return Order

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Path parameters

idintegerRequired
The Id of the Return

Headers

shipbob_channel_idintegerOptional
Channel Id for Operation

Response

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

Status of the return order, i.e. Awaiting Arrival, Arrived, Processing, Completed Cancelled

status_historylist of objects
List of status history in return order
store_order_idstring
Reference to external order id
tracking_numberstring
The tracking number of the return shipping label
transactionslist of objects
List of transactions that make up the billable amount to invoice a merchant

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error