Skip to main content
GET
/
2026-01
/
return
Get Return Orders 
curl --request GET \
  --url https://sandbox-api.shipbob.com/2026-01/return \
  --header 'Authorization: Bearer <token>'
{
  "first": "http://example.com",
  "items": [
    {
      "arrived_date": "2019-08-24T14:15:22Z",
      "awaiting_arrival_date": "2019-08-24T14:15:22Z",
      "cancelled_date": "2019-08-24T14:15:22Z",
      "channel": {
        "id": 0,
        "name": "string"
      },
      "completed_date": "2019-08-24T14:15:22Z",
      "customer_name": "string",
      "fulfillment_center": {
        "id": 0,
        "name": "string"
      },
      "id": 0,
      "insert_date": "2019-08-24T14:15:22Z",
      "inventory": [
        {
          "action_requested": {
            "action": "string",
            "action_type": "string",
            "instructions": "string"
          },
          "action_taken": [
            {
              "action": "string",
              "action_reason": "string",
              "image_url": "http://example.com",
              "quantity_processed": 0
            }
          ],
          "barcodes": [
            "string"
          ],
          "id": 0,
          "lot_information": {
            "expiration": "2019-08-24T14:15:22Z",
            "minimumShelfLife": 0,
            "number": "string"
          },
          "name": "string",
          "quantity": 0,
          "sku": "string"
        }
      ],
      "invoice": {
        "amount": 0.1,
        "currency_code": "string"
      },
      "original_shipment_id": 0,
      "processing_date": "2019-08-24T14:15:22Z",
      "reference_id": "string",
      "return_type": "string",
      "shipment_tracking_number": "string",
      "status": "string",
      "status_history": [
        {
          "status": "string",
          "timestamp": "2019-08-24T14:15:22Z"
        }
      ],
      "store_order_id": "string",
      "tracking_number": "string",
      "transactions": [
        {
          "amount": 0.1,
          "transaction_type": "string"
        }
      ]
    }
  ],
  "last": "http://example.com",
  "next": "http://example.com",
  "prev": "http://example.com"
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>

Channel Id for operation

Query Parameters

​
Ids
string

The IDs of the returns to fetch. Accepts a comma-separated list of return IDs (e.g., 123,456,789).

​
ReferenceIds
string

Comma-separated list of return reference IDs (RMA numbers) to filter by.

​
Status
string

Comma-separated list of return statuses to filter by (e.g., AwaitingArrival,Arrived,Processing,Completed,Cancelled).

​
FulfillmentCenterIds
string

Comma-separated list of fulfillment center IDs to filter by.

​
TrackingNumbers
string

Comma-separated list of tracking numbers to filter by.

​
OriginalShipmentIds
string

Comma-separated list of original shipment IDs to filter by.

​
InventoryIds
string

Comma-separated list of inventory IDs to filter by.

​
StartDate
string<date-time>

Filter returns created on or after this date (ISO 8601 format).

​
EndDate
string<date-time>

Filter returns created on or before this date (ISO 8601 format).

​
ReturnTypes
string

Comma-separated list of return types to filter by (e.g., Regular,ReturnToSender).

​
ReturnActions
string

Comma-separated list of return actions to filter by (e.g., Restock,Quarantine,Dispose).

​
StoreOrderIds
string

Comma-separated list of store order IDs to filter by.

​
Sortby
string

Field to sort results by.

​
CompletedStartDate
string<date-time>

Filter returns completed on or after this date (ISO 8601 format).

​
CompletedEndDate
string<date-time>

Filter returns completed on or before this date (ISO 8601 format).

​
Cursor
number<int32>

Page number to retrieve. Used for pagination through result sets.

Required range: 1 <= x <= 2147483647
​
Limit
number<int32>

Maximum number of records to return per page.

​
SortOrder
enum<string>

Sort order for results. Desc = newest to oldest, Asc = oldest to newest, Desc is default

Available options:
Asc,
Desc

Response

OK

​
first
string<uri> | null

Return url for first cursor

​
items
object[] | null

Return records

​
last
string<uri> | null

Return url for last cursor

​
next
string<uri> | null

Return url for next cursor

​
prev
string<uri> | null

Return url for prev cursor