For the complete documentation index, see llms.txt.
Orders
GET
/api/orders/deliveredList Orders (Delivered)
Get a list of all delivered orders with a given order reference
Orders
Create, search, update, tag, archive, restore, and list orders before shipping.
18 related endpoints
Endpoint
Endpoint URL
https://api.starshipit.com/api/orders/delivered?order_ref=12345
Details
Get a list of all delivered orders with a given order reference
Request Parameters
List Orders (Delivered) Response
Response examples
List Orders (Delivered) (200)
{
"orders": [
{
"order_id": 400000001,
"order_date": "2022-02-22T23:57:51.3774738",
"order_number": "5370",
"reference": "12345",
"carrier": "AusPost",
"carrier_name": "Australia Post",
"carrier_service_code": "7B05",
"signature_required": false,
"dangerous_goods": false,
"currency": "NZD",
"sender_details": {
"name": "Sender Name",
"email": "sender.email@starshipit.com",
"phone": "0201234567",
"company": "Starshipit",
"street": "10 George Street",
"suburb": "City Centre",
"city": "Melbourne",
"state": "VIC",
"post_code": "1234",
"country": "Australia",
"tax_numbers": []
},
"destination": {
"name": "John Smith",
"email": "john.smith@example.com",
"phone": "",
"building": "",
"company": "",
"street": "10 George St",
"suburb": "Redfern",
"city": "",
"state": "NSW",
"post_code": "2016",
"country": "AUSTRALIA",
"delivery_instructions": "",
"tax_numbers": []
},
"packages": [
{
"package_id": 200000001,
"name": "Test Package",
"weight": 6,
"height": 0.01,
"width": 0.05,
"length": 0.1,
"packaging_type": "Carton",
"carrier_service_code": "7B05",
"carrier_service_name": "PARCEL POST + SIGNATURE",
"tracking_number": "2XD890127901000935103",
"tracking_url": "https://auspost.com.au/mypost/track/details/2XD890127901000935103",
"delivery_status": "Printed",
"shipment_type": "Outgoing",
"label_created_date": "2022-02-23T00:00:43.8986313",
"barcode": "0199312650999998912XD890127901000935103"
}
],
"metadatas": [
{
"metafield_key": "ADDRESSVALIDATED",
"value": "True",
"required": false
},
{
"metafield_key": "SOURCE",
"value": "Manual",
"required": false
},
{
"metafield_key": "ATL",
"value": "False",
"required": false
},
{
"metafield_key": "SAFEDROP",
"value": "True",
"required": false
},
{
"metafield_key": "CREATERETURN",
"value": "False",
"required": false
},
{
"metafield_key": "INSURANCE",
"value": "False",
"required": false
},
{
"metafield_key": "INSURANCEVALUE",
"value": "0.00",
"required": false
},
{
"metafield_key": "DANGEROUSGOODS",
"value": "False",
"required": false
},
{
"metafield_key": "EXPORTTYPE",
"value": "Sale of Goods",
"required": false
},
{
"metafield_key": "COMMERCIALVALUE",
"value": "False",
"required": false
},
{
"metafield_key": "EXPORTNUMBER",
"value": "",
"required": false
}
],
"declared_value": 0,
"archived": false,
"manifest_number": 12345678,
"writeback_status": "Not required",
"writeback_details": "Not Required",
"address_validation": "Valid",
"create_return": false,
"dtp": false,
"export_type": "Sale of Goods",
"add_insurance": false,
"insurance_value": 0,
"plt": false,
"type": "Outgoing",
"platform": "Manual",
"status": "Delivered6",
"manifested": true,
"has_commercial_invoice": false,
"is_fully_packed": false
}
],
"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 SummaryGET /api/orders/summarySearch OrdersGET /api/orders/searchGet 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