For the complete documentation index, see llms.txt.
Orders
GET
/api/ordersGet Order(s)
Get order details by either order_id or order_number. If neither order_id or order_number is provided, this endpoint can be used to return multiple orders that match the criteria.
Orders
Create, search, update, tag, archive, restore, and list orders before shipping.
18 related endpoints
Endpoint
Endpoint URL
https://api.starshipit.com/api/orders
Details
Get order details by either order_id or order_number. If neither order_id or order_number is provided, this endpoint can be used to return multiple orders that match the criteria.
Request Parameters
Get Order Response
Response examples
Get Order by order id (200)
{
"order":{
"order_id":1020304051,
"order_date":"2020-04-29T22:46:59.7155669Z",
"order_number":"10001",
"reference":"Online Order",
"carrier":"AusPost",
"carrier_name":"Australia Post",
"carrier_service_code":"7B05",
"shipping_method":"Express Shipping",
"signature_required":false,
"dangerous_goods":false,
"destination":{
"name":"John Smith",
"phone":"0290988227",
"street":"20 George Street",
"suburb":"Sydney",
"state":"NSW",
"post_code":"2000",
"country":"Australia",
"delivery_instructions":"Leave at door"
},
"items":[
{
"item_id":1065580746,
"description":"Mobile Phone",
"sku":"MOBILE",
"quantity":1,
"quantity_to_ship":0,
"weight":0.65,
"value":125
},
{
"item_id":1065580747,
"description":"Mobile Case (Black)",
"sku":"MOBILE-CASE-BLK",
"quantity":1,
"quantity_to_ship":0,
"weight":0.05,
"value":20
}
],
"packages":[
{
"package_id":1035548017,
"weight":0.7,
"height":0.04,
"width":0.08,
"length":0.12
}
],
"declared_value":0
},
"success":true
}Get Order by order number (200)
{
"order":{
"order_id":1020304051,
"order_date":"2020-04-29T22:46:59.7155669Z",
"order_number":"10001",
"reference":"Online Order",
"carrier":"AusPost",
"carrier_name":"Australia Post",
"carrier_service_code":"7B05",
"shipping_method":"Express Shipping",
"signature_required":false,
"dangerous_goods":false,
"destination":{
"name":"John Smith",
"phone":"0290988227",
"street":"20 George Street",
"suburb":"Sydney",
"state":"NSW",
"post_code":"2000",
"country":"Australia",
"delivery_instructions":"Leave at door"
},
"items":[
{
"item_id":1065580746,
"description":"Mobile Phone",
"sku":"MOBILE",
"quantity":1,
"quantity_to_ship":0,
"weight":0.65,
"value":125
},
{
"item_id":1065580747,
"description":"Mobile Case (Black)",
"sku":"MOBILE-CASE-BLK",
"quantity":1,
"quantity_to_ship":0,
"weight":0.05,
"value":20
}
],
"packages":[
{
"package_id":1035548017,
"weight":0.7,
"height":0.04,
"width":0.08,
"length":0.12
}
],
"declared_value":0
},
"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/summarySearch OrdersGET /api/orders/searchCreate 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