For the complete documentation index, see llms.txt.
Orders
GET
/api/orders/searchSearch Orders
Find a known order by order number, tracking number, reference or receiver name.
Orders
Create, search, update, tag, archive, restore, and list orders before shipping.
18 related endpoints
Endpoint
Endpoint URL
https://api.starshipit.com/api/orders/search?phrase=EXAMPLE-ORDER&status=All&fields=All
Details
Find a known order by order number, tracking number, reference or receiver name.
Supply a non-empty phrase and set status=All with fields=All to include matching unshipped, shipped and archived orders. Check each result's archived boolean to identify an archived order. This endpoint does not provide an archived-only list or a tag-based search of archived orders.
Request Parameters
Search Orders Response
Response examples
Search Orders by order number (200)
{
"orders": [
{
"order_id": 10001,
"order_date": "2020-04-29T22:46:59.6374472Z",
"order_number": "12345",
"name": "John Smith",
"carrier_name": "Australia Post",
"tracking_number": "A123456",
"country": "Australia",
"archived": false
}
],
"total_pages": 1,
"success": true
}Search Orders by tracking number (200)
{
"orders": [
{
"order_id": 10001,
"order_date": "2020-04-29T22:46:59.6374472Z",
"order_number": "12345",
"name": "John Smith",
"carrier_name": "Australia Post",
"tracking_number": "A123456",
"country": "Australia",
"archived": false
}
],
"total_pages": 1,
"success": true
}Related endpoints
List Orders (Unshipped)GET /api/orders/unshippedList Orders (Printed or Unmanifested)GET /api/orders/shipmentsList Orders (Shipped)GET /api/orders/shippedList Orders (Delivered)GET /api/orders/deliveredList Orders SummaryGET /api/orders/summaryGet Order(s)GET /api/ordersCreate OrderPOST /api/ordersCreate OrdersPOST /api/orders/importUpdate OrderPUT /api/ordersUpdate OrdersPUT /api/orders/updateBatch Update OrdersPUT /api/orders/batchupdateDelete OrderDELETE /api/orders/deleteArchive OrderPOST /api/orders/archiveRestore OrderPOST /api/orders/restoreMerge OrdersPOST /api/orders/mergeGet Suggested MergesGET /api/orders/mergeableAssign OrdersPOST /api/orders/assign