Get Orders

GET

https://sandbox-api.shipbob.com/2026-01/order

GET

/2026-01/order

$ curl -G https://sandbox-api.shipbob.com/2026-01/order \
>      -H "Authorization: Bearer <token>" \
>      -d Page=1 \
>      -d Limit=1 \
>      -d IDs=0 \
>      -d ReferenceIds=string \
>      --data-urlencode StartDate=2019-08-24T14:15:22+00:00 \
>      --data-urlencode EndDate=2019-08-24T14:15:22+00:00 \
>      -d SortOrder=Newest \
>      -d HasTracking=true \
>      --data-urlencode LastUpdateStartDate=2019-08-24T14:15:22+00:00 \
>      --data-urlencode LastUpdateEndDate=2019-08-24T14:15:22+00:00 \
>      -d IsTrackingUploaded=true \
>      --data-urlencode LastTrackingUpdateStartDate=2019-08-24T14:15:22+00:00 \
>      --data-urlencode LastTrackingUpdateEndDate=2019-08-24T14:15:22+00:00

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

Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.

curl -G https://sandbox-api.shipbob.com/2026-01/order \
     -H "Authorization: Bearer <token>" \
     -d Page=1 \
     -d Limit=1 \
     -d IDs=0 \
     -d ReferenceIds=string \
     --data-urlencode StartDate=2019-08-24T14:15:22+00:00 \
     --data-urlencode EndDate=2019-08-24T14:15:22+00:00 \
     -d SortOrder=Newest \
     -d HasTracking=true \
     --data-urlencode LastUpdateStartDate=2019-08-24T14:15:22+00:00 \
     --data-urlencode LastUpdateEndDate=2019-08-24T14:15:22+00:00 \
     -d IsTrackingUploaded=true \
     --data-urlencode LastTrackingUpdateStartDate=2019-08-24T14:15:22+00:00 \
     --data-urlencode LastTrackingUpdateEndDate=2019-08-24T14:15:22+00:00

[
  {
    "channel": {
      "id": 0,
      "name": "ShipBobs-Shopify-Store"
    },
    "created_date": "2019-08-24T14:15:22+00:00",
    "financials": {
      "total_price": 0.1
    },
    "gift_message": "string",
    "id": 0,
    "order_number": "string",
    "products": [
      {
        "external_line_id": 0,
        "gtin": "string",
        "id": 0,
        "quantity": 0,
        "quantity_unit_of_measure_code": "string",
        "reference_id": "TShirtBlueM",
        "sku": "TShirtBlueM",
        "unit_price": 0.1,
        "upc": "string"
      }
    ],
    "purchase_date": "2019-08-24T14:15:22+00:00",
    "recipient": {
      "address": null,
      "name": "John Doe",
      "email": "john@example.com",
      "phone_number": "555-555-5555"
    },
    "reference_id": "string",
    "retailer_program_data": {
      "addresses": [
        {
          "address1": "100 Nowhere Blvd",
          "city": "Gotham City",
          "country": "US",
          "type": "MarkFor",
          "address2": "Suite 100",
          "company_name": "Wayne Enterprises",
          "state": "NJ",
          "zip_code": "07093"
        }
      ],
      "customer_ticket_number": "string",
      "delivery_date": "2019-08-24T14:15:22+00:00",
      "department": "string",
      "doNotShipBeforeDate": "2019-08-24T14:15:22+00:00",
      "mark_for_store": "string",
      "purchase_order_number": "string",
      "retailer_program_type": "string",
      "shipByDate": "2019-08-24T14:15:22+00:00"
    },
    "shipments": [
      {
        "actual_fulfillment_date": "2019-08-24T14:15:22+00:00",
        "created_date": "2019-08-24T14:15:22+00:00",
        "delivery_date": "2019-08-24T14:15:22+00:00",
        "estimated_fulfillment_date": "2019-08-24T14:15:22+00:00",
        "estimated_fulfillment_date_status": "AwaitingInventoryAllocation",
        "gift_message": "string",
        "id": 0,
        "insurance_value": 0,
        "invoice_amount": 0,
        "invoice_currency_code": "string",
        "is_tracking_uploaded": true,
        "last_tracking_update_at": "2019-08-24T14:15:22+00:00",
        "last_update_at": "2019-08-24T14:15:22+00:00",
        "location": {
          "id": 0,
          "name": "Cicero (IL)"
        },
        "measurements": {
          "depth_in": 0,
          "length_in": 0,
          "total_weight_oz": 0,
          "width_in": 0
        },
        "order_id": 0,
        "package_material_type": "Unknown",
        "parent_cartons": [
          {
            "barcode": "string",
            "cartons": [
              {
                "barcode": "string",
                "carton_details": [
                  {
                    "products": [
                      {
                        "id": 0,
                        "inventory_items": [
                          {
                            "expiration_date": "2019-08-24T14:15:22+00:00",
                            "id": 0,
                            "is_dangerous_goods": true,
                            "lot": "22222",
                            "name": "Medium Blue T-Shirt",
                            "quantity": 0,
                            "quantity_committed": 0,
                            "serial_numbers": [
                              "string"
                            ]
                          }
                        ],
                        "name": "Medium Blue T-Shirt",
                        "reference_id": "TShirtBlueM",
                        "sku": "TShirtBlueM"
                      }
                    ]
                  }
                ],
                "id": 0,
                "measurements": {
                  "depth_in": 0.1,
                  "length_in": 0.1,
                  "total_weight_oz": 0.1,
                  "width_in": 0.1
                },
                "type": "Box or pallet"
              }
            ],
            "measurements": {
              "depth_in": 0.1,
              "length_in": 0.1,
              "total_weight_oz": 0.1,
              "width_in": 0.1
            },
            "type": "Box or pallet"
          }
        ],
        "products": [
          {
            "id": 0,
            "inventory_items": [
              {
                "expiration_date": "2019-08-24T14:15:22+00:00",
                "id": 0,
                "is_dangerous_goods": true,
                "lot": "22222",
                "name": "Medium Blue T-Shirt",
                "quantity": 0,
                "quantity_committed": 0,
                "serial_numbers": [
                  "string"
                ]
              }
            ],
            "name": "Medium Blue T-Shirt",
            "reference_id": "TShirtBlueM",
            "sku": "TShirtBlueM"
          }
        ],
        "recipient": {
          "address": null,
          "email": "john@example.com",
          "full_name": "John Doe",
          "name": "John Doe",
          "phone_number": "555-555-5555"
        },
        "reference_id": "string",
        "require_signature": true,
        "ship_option": "Standard",
        "status": "None",
        "status_details": [
          {
            "description": "string",
            "exception_fulfillment_center_id": 0,
            "extra_information": {
              "validation_messages": [
                "string"
              ]
            },
            "id": 0,
            "inventory_id": 0,
            "name": "string"
          }
        ],
        "tracking": {
          "bol": "string",
          "carrier": "USPS",
          "carrier_service": "Priority",
          "pro_number": "string",
          "scac": "string",
          "shipping_date": "2019-08-24T14:15:22+00:00",
          "tracking_number": "860C8CDC8F0B4FC7AB69AC86C20539EC",
          "tracking_url": "https://www.example.com/tracking?id=860C8CDC8F0B4FC7AB69AC86C20539EC"
        }
      }
    ],
    "shipping_method": "Free 2-day Shipping",
    "shipping_terms": {
      "carrier_type": "Parcel",
      "payment_term": "Collect"
    },
    "status": "Processing",
    "tags": [
      {
        "name": "Handling instructions",
        "value": "Fragile"
      }
    ],
    "type": "DTC"
  }
]

Retrieves a paginated list of orders from your ShipBob account with optional filters. All filter parameters use AND logic, meaning orders must match all provided criteria to be returned.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

AuthorizationBearer

OAuth2 authentication using JWT tokens

Query parameters

PageintegerOptional1-2147483647

Page of orders to get

LimitintegerOptional1-250

Amount of orders per page to request

IDslist of integersOptional

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

ReferenceIdslist of stringsOptional

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

SortOrderenumOptional

Order to sort results in

Allowed values:

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

Gift message associated with the order

idinteger

Unique id of the order

order_numberstring

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

List of products included in the order

purchase_datedatetime

Date this order was purchase by the end user

recipientobject

Information about the recipient of an order

reference_idstring

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

Shipments affiliated with the order

shipping_methodstring

Client-defined shipping method

shipping_termsobject

Contains shipping properties that need to be used for fulfilling an order.

statusenum

tagslist of objects

Client-defined order tags

typeenum

Allowed values:

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

Get Orders

Get Orders

Authentication

Headers

Query parameters

Response

Errors

Authentication

Headers

Query parameters

Response

Errors

$	curl -G https://sandbox-api.shipbob.com/2026-01/order \
>	-H "Authorization: Bearer <token>" \
>	-d Page=1 \
>	-d Limit=1 \
>	-d IDs=0 \
>	-d ReferenceIds=string \
>	--data-urlencode StartDate=2019-08-24T14:15:22+00:00 \
>	--data-urlencode EndDate=2019-08-24T14:15:22+00:00 \
>	-d SortOrder=Newest \
>	-d HasTracking=true \
>	--data-urlencode LastUpdateStartDate=2019-08-24T14:15:22+00:00 \
>	--data-urlencode LastUpdateEndDate=2019-08-24T14:15:22+00:00 \
>	-d IsTrackingUploaded=true \
>	--data-urlencode LastTrackingUpdateStartDate=2019-08-24T14:15:22+00:00 \
>	--data-urlencode LastTrackingUpdateEndDate=2019-08-24T14:15:22+00:00

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