For the complete documentation index, see llms.txt.

Orders
GET/api/orders/unshipped

List Orders (Unshipped)

Get a list of all unshipped orders (default: orders updated in the last 24 hours)

View as MarkdownCopy for LLM

Orders

Create, search, update, tag, archive, restore, and list orders before shipping.

18 related endpoints

Endpoint

Endpoint URL

https://api.starshipit.com/api/orders/unshipped

Details

Get a list of all unshipped orders (default: orders updated in the last 24 hours)

Request Parameters

Parameter Description Example Value Accepted values
since_order_date (optional) Show orders created after date in UTC (date-time in RFC3339 format) 2024-05-27T06:00:00.000Z
since_last_updated (optional) Show orders recently updated after date in UTC (date-time in RFC3339 format) 2024-05-27T06:00:00.000Z
ids_only (optional) Show all unshipped order_ids false true
limit (optional) Amount of results (default: 50) (maximum: 250) 50 1, 2, 3, ..., 250
page (optional) Page to show (default: 1) 1 1, 2, 3, ...

List Orders (Unshipped) Response

Attribute Type Description
orders list of orders List of unshipped orders details (Full Order Model)
order_ids list of order_ids List of unshipped order_ids (only present if ids_only is set to true)
total_pages integer Total number of pages available
success boolean Determines whether the request was successfully submitted
errors object list List of detailed errors (Error Model) (only present if the request resulted in an error)

Response examples

List Orders (Unshipped) (200)
{
    "orders": [
        {
            "order_id": 440482182,
            "order_date": "2024-06-16T23:41:13",
            "order_number": "#1148-1",
            "reference": "#1148",
            "carrier": "DHL",
            "carrier_name": "DHL Express",
            "carrier_service_code": "WPX",
            "signature_required": false,
            "dangerous_goods": false,
            "currency": "NZD",
            "sender_details": {
                "name": "Frank's Flowers",
                "email": "frank@flowers.com",
                "phone": "0215671234",
                "building": "Building A",
                "company": "Frank's Flowers",
                "street": "10 Rose Street",
                "suburb": "redfern",
                "city": "redfern",
                "state": "NSW",
                "post_code": "2016",
                "country": "Australia",
                "tax_numbers": []
            },
            "destination": {
                "name": "John Smith",
                "email": "john@smith.com",
                "phone": "0225671289",
                "building": "1A",
                "company": "John Smith Tools",
                "street": "10 Federal Street",
                "city": "Auckland",
                "state": "Auckland",
                "post_code": "1010",
                "country": "New Zealand",
                "delivery_instructions": "",
                "tax_numbers": []
            },
            "items": [
                {
                    "item_id": 1286216642,
                    "description": "Rose",
                    "sku": "",
                    "country_of_origin": "AU",
                    "quantity": 1,
                    "quantity_to_ship": 1,
                    "weight": 0.88,
                    "height": 0,
                    "width": 0,
                    "length": 0,
                    "value": 0,
                    "stock_on_hand": 0
                }
            ],
            "packages": [
                {
                    "package_id": 553567691,
                    "weight": 1,
                    "height": 0.1,
                    "width": 0.1,
                    "length": 0.1,
                    "packaging_type": ""
                }
            ],
            "metadatas": [
                {
                    "metafield_key": "ADDRESSVALIDATED",
                    "value": "True",
                    "required": false
                },
                {
                    "metafield_key": "SOURCE",
                    "value": "Shopify",
                    "required": false
                },
                {
                    "metafield_key": "DTP",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "INSURANCE",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "INSURANCEVALUE",
                    "value": "0.00",
                    "required": false
                },
                {
                    "metafield_key": "GREENSERVICE",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "ADULT_SIGNATURE",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "ATL",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "BATTERY",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "SATURDAY",
                    "value": "False",
                    "required": false
                },
                {
                    "metafield_key": "CUSTOMSINCOTERM",
                    "value": "Not Set",
                    "required": false
                },
                {
                    "metafield_key": "CUSTOMSEXPORTREASON",
                    "value": "Not Set",
                    "required": false
                },
                {
                    "metafield_key": "CUSTOMSDUTYACCOUNTNUMBER",
                    "value": "",
                    "required": false
                }
            ],
            "declared_value": 0,
            "archived": false,
            "manifest_number": 0,
            "address_validation": "NotChecked",
            "create_return": false,
            "dtp": false,
            "add_insurance": false,
            "insurance_value": 0,
            "plt": false,
            "type": "Outgoing",
            "platform": "Manual",
            "status": "Unshipped"
        }
    ],
    "total_pages": 1,
    "success": true
}
ids_only (200)
{
    "order_ids": [
        400000000,
        400000001,
        400000002
    ],
    "total_pages": 1,
    "success": true
}

Related endpoints