Skip to main content
GET
/
1.0
/
return
Get Return Orders 
curl --request GET \
  --url https://api.shipbob.com/1.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

Headers

​
shipbob_channel_id
string<int32>

Query Parameters

​
Page
string<int32>
​
Limit
string<int32>
​
SortOrder
string
​
StartDate
string<date-time>
​
EndDate
string<date-time>
​
IDs
string
​
ReferenceIds
string
​
Status
string
​
FulfillmentCenterIds
string
​
TrackingNumbers
string
​
OriginalShipmentIds
string
​
InventoryIds
string

Response

​
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>
Available options:
Regular,
ReturnToSender
​
status
enum<string>
Available options:
AwaitingArrival,
Arrived,
Processing,
Completed,
Cancelled
​
store_order_id
string | null
​
tracking_number
string | null
Example:
​
transactions
object[] | null