Skip to main content
GET
/
2.0
/
return
Get Return Orders
curl --request GET \
  --url https://api.shipbob.com/2.0/return \
  --header 'Authorization: Bearer <token>'
[
  {
    "channel": {
      "id": 0,
      "name": "ShipBobs-Shopify-Store"
    },
    "completed_date": "2019-08-24T14:15:22Z",
    "customer_name": "string",
    "fulfillment_center": {
      "id": 0,
      "name": "Cicero (IL)"
    },
    "id": 0,
    "insert_date": "2019-08-24T14:15:22Z",
    "inventory": [
      {
        "action_requested": {
          "action": "Default",
          "action_type": "InventoryDefault",
          "instructions": "string"
        },
        "action_taken": [
          {
            "action": "Default",
            "action_reason": "string",
            "lot_information": [
              {
                "expiration_date": "2019-08-24T14:15:22Z",
                "lot_number": "string",
                "quantity_processed": 0
              }
            ],
            "quantity_processed": 1
          }
        ],
        "id": 0,
        "name": "string",
        "quantity": 0
      }
    ],
    "invoice_amount": 0.1,
    "original_shipment_id": 0,
    "reference_id": "string",
    "return_type": "Regular",
    "status": "AwaitingArrival",
    "store_order_id": "string",
    "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
    "transactions": [
      {
        "amount": 2.5,
        "transaction_type": "ReturnLabelInvoice"
      }
    ]
  }
]

Authorizations

Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

shipbob_channel_id
string<int32>

Query Parameters

Page
string<int32>

Page of return orders to get

Limit
string<int32>

Amount of return orders per page to request

SortOrder
string<int32>

Order to sort results by

StartDate
string<date-time>

Start date to filter orders inserted later than

EndDate
string<date-time>

End date to filter orders inserted earlier than

IDs
string

Comma separated list of return orders ids to filter by

ReferenceIds
string

Comma separated list of reference ids to filter by

Status
string

Comma separated list of statuses to filter by

FulfillmentCenterIds
string

Comma separated list of destination 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 contained in return to filter by

Response

Success

channel
object
completed_date
string<date-time> | null
customer_name
string | null
fulfillment_center
object
id
integer
insert_date
string<date-time>
inventory
object[] | null
invoice_amount
number | null
original_shipment_id
integer | null
reference_id
string | null
return_type
enum<string>

Regular

ReturnToSender

Available options:
Regular,
ReturnToSender
status
enum<string>

AwaitingArrival

Arrived

Processing

Completed

Cancelled

Available options:
AwaitingArrival,
Arrived,
Processing,
Completed,
Cancelled
store_order_id
string | null
tags
object[] | null
tracking_number
string | null
transactions
object[] | null