Deliveries

Amend Delivery

View as Markdown

Amend a delivery’s details before it has been dispatched to a carrier. Once a delivery has been assigned a consignment number (i.e. booked with a provider), it can no longer be amended via this endpoint.

Amending automatically re-quotes the delivery with available providers and recalculates SLA windows based on any updated timing.

Endpoint

PATCH {{domain}}/{{tenant_id}}/deliveries/{{delivery_id}}/amend

Authentication: Bearer token required via the Authorization header.

Request Payload

ready_for_pickup_at is required. All other fields are optional — only include the fields you want to change. All delivery fields can be amended, including parcels, line_items, delivery_type, and reference.

PATCH /{{tenant_id}}/deliveries/{{delivery_id}}/amend
1{
2    "ready_for_pickup_at": "2026-02-05T10:00:00+11:00",
3    "special_instructions": "Leave at side door",
4    "reference": "ORDER-98765",
5    "delivery_type": "fast",
6    "address": {
7        "address": "10 Smith Street",
8        "city": "Collingwood",
9        "state": "VIC",
10        "post_code": "3066",
11        "country": "AU"
12    },
13    "customer": {
14        "first_name": "Jane",
15        "last_name": "Doe",
16        "phone": "0411000000",
17        "email": "jane@doe.com"
18    },
19    "line_items": [
20        {
21            "code": "sku-code-001",
22            "name": "SKU Item Name #001",
23            "price_cents": 999,
24            "quantity": 2
25        }
26    ],
27    "parcels": [
28        {
29            "reference": "PARCEL_001",
30            "length_cm": 20,
31            "width_cm": 40,
32            "height_cm": 60,
33            "weight_kg": 1,
34            "quantity": 1,
35            "type": "carton"
36        }
37    ]
38}

Amendable Fields

FieldRequiredDescription
ready_for_pickup_atYesThe updated time the order will be ready for carrier collection. Triggers re-quoting and SLA recalculation.
special_instructionsNoUpdated delivery instructions for the driver.
referenceNoYour internal order or shipment reference.
delivery_typeNoThe requested service level — e.g. fast, flexible, standard, express.
addressNoThe updated delivery destination. Triggers re-quoting with the new address.
customerNoUpdated recipient contact details.
line_itemsNoThe full updated list of line items. Replaces the existing line_items array.
parcelsNoThe full updated list of parcels. Replaces the existing parcels array.

Amendments are only possible before a consignment number has been assigned. Attempting to amend a booked delivery will return an error.