Get an order

PUT /orders/{tracking_number}

Updates an order in Shippit.

To use this endpoint, you need to retrieve the order details GET endpoint, pass the details to this endpoint in a JSON wrapper, and edit any fields that you want to change.

There are a number of types of orders that are currently unable to be updated, including priority and on-demand orders, return orders, tracking-only orders, and those which are cancelled or labelled.

For more information, see the Order modification section in the Developer Guide.

Body

{
    "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,
        "features": [],
        "description": "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,
        "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",
        "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
            }
        ]
    }
}