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
      • POSTCreate Order
      • GETGet Orders
      • GETGet Order
      • GETGet one Shipment by Shipment Id
      • POSTCancel multiple Shipments by Shipment Id
      • POSTUpdate Tracking Uploaded Status for Multiple Shipments by Shipment Id
    • OpenAPI spec
LogoLogo
API ReferenceOrders

Get Orders

||View as Markdown|
GET
/2025-07/order
GET
/2025-07/order
$curl https://api.shipbob.com/2025-07/order \
>     -H "Authorization: Bearer <token>"
1[
2  {
3    "channel": {
4      "id": 0,
5      "name": "ShipBobs-Shopify-Store"
6    },
7    "created_date": "2019-08-24T14:15:22Z",
8    "financials": {
9      "total_price": 0.1
10    },
11    "gift_message": "string",
12    "id": 0,
13    "order_number": "string",
14    "products": [
15      {
16        "external_line_id": 0,
17        "gtin": "string",
18        "id": 0,
19        "quantity": 0,
20        "quantity_unit_of_measure_code": "string",
21        "reference_id": "TShirtBlueM",
22        "sku": "TShirtBlueM",
23        "unit_price": 0.1,
24        "upc": "string"
25      }
26    ],
27    "purchase_date": "2019-08-24T14:15:22Z",
28    "recipient": {
29      "address": {
30        "address1": "100 Nowhere Blvd",
31        "address2": "Suite 100",
32        "city": "Gotham City",
33        "company_name": "Wayne Enterprises",
34        "country": "US",
35        "state": "NJ",
36        "zip_code": "07093"
37      },
38      "name": "John Doe",
39      "email": "john@example.com",
40      "phone_number": "555-555-5555"
41    },
42    "reference_id": "string",
43    "retailer_program_data": {
44      "addresses": [
45        {
46          "address1": "100 Nowhere Blvd",
47          "city": "Gotham City",
48          "country": "US",
49          "type": "MarkFor",
50          "address2": "Suite 100",
51          "company_name": "Wayne Enterprises",
52          "state": "NJ",
53          "zip_code": "07093"
54        }
55      ],
56      "customer_ticket_number": "string",
57      "delivery_date": "2019-08-24T14:15:22Z",
58      "department": "string",
59      "doNotShipBeforeDate": "2019-08-24T14:15:22Z",
60      "mark_for_store": "string",
61      "purchase_order_number": "string",
62      "retailer_program_type": "string",
63      "shipByDate": "2019-08-24T14:15:22Z"
64    },
65    "shipments": [
66      {
67        "actual_fulfillment_date": "2019-08-24T14:15:22Z",
68        "created_date": "2019-08-24T14:15:22Z",
69        "delivery_date": "2019-08-24T14:15:22Z",
70        "estimated_fulfillment_date": "2019-08-24T14:15:22Z",
71        "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
72        "gift_message": "string",
73        "id": 0,
74        "insurance_value": 0,
75        "invoice_amount": 0,
76        "invoice_currency_code": "string",
77        "is_tracking_uploaded": true,
78        "last_tracking_update_at": "2019-08-24T14:15:22Z",
79        "last_update_at": "2019-08-24T14:15:22Z",
80        "location": {
81          "id": 0,
82          "name": "Cicero (IL)"
83        },
84        "measurements": {
85          "depth_in": 0,
86          "length_in": 0,
87          "total_weight_oz": 0,
88          "width_in": 0
89        },
90        "order_id": 0,
91        "package_material_type": "Unknown",
92        "parent_cartons": [
93          {
94            "barcode": "string",
95            "cartons": [
96              {
97                "barcode": "string",
98                "carton_details": [
99                  {
100                    "products": [
101                      {
102                        "id": 0,
103                        "inventory_items": [
104                          {
105                            "expiration_date": "2019-08-24T14:15:22Z",
106                            "id": 0,
107                            "is_dangerous_goods": true,
108                            "lot": "22222",
109                            "name": "Medium Blue T-Shirt",
110                            "quantity": 0,
111                            "quantity_committed": 0,
112                            "serial_numbers": [
113                              "string"
114                            ]
115                          }
116                        ],
117                        "name": "Medium Blue T-Shirt",
118                        "reference_id": "TShirtBlueM",
119                        "sku": "TShirtBlueM"
120                      }
121                    ]
122                  }
123                ],
124                "id": 0,
125                "measurements": {
126                  "depth_in": 0.1,
127                  "length_in": 0.1,
128                  "total_weight_oz": 0.1,
129                  "width_in": 0.1
130                },
131                "type": "Box or pallet"
132              }
133            ],
134            "measurements": {
135              "depth_in": 0.1,
136              "length_in": 0.1,
137              "total_weight_oz": 0.1,
138              "width_in": 0.1
139            },
140            "type": "Box or pallet"
141          }
142        ],
143        "products": [
144          {
145            "id": 0,
146            "inventory_items": [
147              {
148                "expiration_date": "2019-08-24T14:15:22Z",
149                "id": 0,
150                "is_dangerous_goods": true,
151                "lot": "22222",
152                "name": "Medium Blue T-Shirt",
153                "quantity": 0,
154                "quantity_committed": 0,
155                "serial_numbers": [
156                  "string"
157                ]
158              }
159            ],
160            "name": "Medium Blue T-Shirt",
161            "reference_id": "TShirtBlueM",
162            "sku": "TShirtBlueM"
163          }
164        ],
165        "recipient": {
166          "address": {
167            "address1": "100 Nowhere Blvd",
168            "address2": "Suite 100",
169            "city": "Gotham City",
170            "company_name": "Wayne Enterprises",
171            "country": "US",
172            "state": "NJ",
173            "zip_code": "07093"
174          },
175          "email": "john@example.com",
176          "full_name": "John Doe",
177          "name": "John Doe",
178          "phone_number": "555-555-5555"
179        },
180        "reference_id": "string",
181        "require_signature": true,
182        "ship_option": "Standard",
183        "status": "None",
184        "status_details": [
185          {
186            "description": "string",
187            "exception_fulfillment_center_id": 0,
188            "extra_information": {
189              "validation_messages": [
190                "string"
191              ]
192            },
193            "id": 0,
194            "inventory_id": 0,
195            "name": "string"
196          }
197        ],
198        "tracking": {
199          "bol": "string",
200          "carrier": "USPS",
201          "carrier_service": "Priority",
202          "pro_number": "string",
203          "scac": "string",
204          "shipping_date": "2019-08-24T14:15:22Z",
205          "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
206          "tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
207        }
208      }
209    ],
210    "shipping_method": "Free 2-day Shipping",
211    "shipping_terms": {
212      "carrier_type": "Parcel",
213      "payment_term": "Collect"
214    },
215    "status": "Processing",
216    "tags": [
217      {
218        "name": "Handling instructions",
219        "value": "Fragile"
220      }
221    ],
222    "type": "DTC"
223  }
224]
All parameters are AND filters
Was this page helpful?
Previous

Create Order

Next

Get Order

Built with

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Headers

shipbob_channel_idstringOptionalformat: "int32"
Channel Id for Operation

Query parameters

PageintegerOptional1-2147483647
Page of orders to get
LimitintegerOptional1-250
Amount of orders per page to request
IDsstringOptional

order ids to filter by, comma separated
Example: ?IDs=1,2

ReferenceIdsstringOptional

Reference ids to filter by, comma separated
Example: ?ReferenceIds=Ref1,Ref2

StartDatedatetimeOptional
Start date to filter orders inserted later than
EndDatedatetimeOptional
End date to filter orders inserted earlier than
SortOrderstringOptional
Order to sort results in
HasTrackingbooleanOptional
Has any portion of this order been assigned a tracking number
LastUpdateStartDatedatetimeOptional
Start date to filter orders updated later than
LastUpdateEndDatedatetimeOptional
End date to filter orders updated later than
IsTrackingUploadedbooleanOptional
Filter orders that their tracking information was fully uploaded
LastTrackingUpdateStartDatedatetimeOptional
Start date to filter orders with tracking updates later than the supplied date. Will only return orders that have tracking information
LastTrackingUpdateEndDatedatetimeOptional
End date to filter orders updated later than the supplied date. Will only return orders that have tracking information

Response

Success
channelobject
Created by channel metadata
created_datedatetime
Date this order was created
financialsobject
gift_messagestring or null
Gift message associated with the order
idinteger
Unique id of the order
order_numberstring or null
User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used
productslist of objects or null
List of products included in the order
purchase_datedatetime or null
Date this order was purchase by the end user
recipientobject
Information about the recipient of an order
reference_idstring or null

Client-defined external unique id of the order

retailer_program_dataobject

Contains properties that needs to be used for fulfilling B2B/Dropship orders.

shipmentslist of objects or null
Shipments affiliated with the order
shipping_methodstring or null

Client-defined shipping method

shipping_termsobject
Contains shipping properties that need to be used for fulfilling an order.
statusenum
tagslist of objects or null

Client-defined order tags

typeenum
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error