Update an order responses

Updating an order responses

Status	Meaning	Description
200	OK	Details of the order
400	Bad Request	Returned when Shippit has a problem with the input parameters
403	Forbidden	Returned when the API key given doesn’t match a valid merchant account
404	Not Found	Returned when the given ID isn’t found
422	Unprocessable Entity	Returned when the order is in a state that means it can’t be updated

To perform this operation, you must authenticate with an authentication token.

Success examples

Returns details of the order

{
    "authority_to_leave": "Yes",
    "cash_on_delivery_amount": 0.0,
    "courier_type": "standard",
    "courier_allocation": "CouriersPlease",
    "receiver_contact_number": "0400000000",
    "receiver_name": "Receiver Name",
    "receiver_language_code": "EN",
    "retailer_invoice": "Retailer Invoice",
    "retailer_reference": "Retailer Reference",
    "product_currency": "AUD",
    "suppress_communications": false,
    "tracking_only": false,
    "features": [],
    "description": "",
    "duties": 0.0,
    "tax_amount": 0.0,
    "customs_clearance_attributes": {
        "tax_id_type": "GBVAT",
        "tax_id_country_code": "GB",
        "tax_id_number": "GB 334 8373 88",
        "incoterm": "DDP",
        "export_reason": "Personal Belongings or Personal Use",
        "receiver_freight_charge_amount": 10.0,
        "recipient_id": "123"
    },
    "return": false,
    "pickup_at": "2025-12-30T08:59:59+11:00",
    "pickup_deadline_at": "2025-12-30T08:59:59+11:00",
    "dropoff_at": "2025-12-31T08:59:59+11:00",
    "dropoff_deadline_at": "2025-12-31T08:59:59+11:00",
    "delivery_company": "Delivery Company",
    "delivery_address": "1 Test Street",
    "delivery_suburb": "Sydney",
    "delivery_state": "NSW",
    "delivery_postcode": "2000",
    "delivery_country_code": "AU",
    "delivery_timezone": "Australia/Sydney",
    "delivery_instructions": "Leave on door",
    "state": "processing",
    "user_attributes": {
        "email": "test@example.com",
        "first_name": "Test",
        "last_name": "Example",
        "mobile": "0400000000"
    },
    "parcel_attributes": [
        {
            "qty": 1,
            "length": 0.1,
            "width": 0.2,
            "depth": 0.3,
            "weight": 20.0,
            "label_number": "PARCELLABEL01"
        }
    ],
    "product_attributes": [
        {
            "price": 12.34,
            "tariff_code": "62121000",
            "quantity": 1,
            "title": "Title",
            "sku": "SKU12345",
            "dangerous_goods_code": "1",
            "dangerous_goods_text": "Explosives",
            "origin_country_code": "AU",
            "product_line_id": "PL1",
            "location": "Loc1",
            "dangerous_goods_class": "EXP",
            "packed": 1
        }
    ]
}

Failure examples

Returned when the API key given doesn’t match a valid merchant account.

403 response

{
  "error": "invalid_merchant_account",
  "error_description": "An unknown error has occurred."
}

404 response

Returned when the given ID can’t be found.

{
  "error": "not_found",
  "error_description": "The requested resource could not be found."
}

422 response

Returned when the order can’t be updated due to invalid input.

{
    "details": {
        "user_attributes": [
            "is missing"
        ]
    },
    "error": "order_cannot_be_updated",
    "error_description": "The order could not be updated"
}

Returned when the order is in a state that means it can’t be updated.

{
    "error": "invalid",
    "error_description": "Cannot update tracking-only orders"
}