Create order
shippit_create_orderWRITE: create a domestic shipping order in Shippit. Shippit then allocates a carrier (your account rules, or the carrier named in courier_allocation) and, unless suppress_communications is true, emails the recipient tracking notifications. Requires confirm: true. Standard, express and click-and-collect orders are only booked with the carrier later, by shippit_label_order and shippit_book_orders (priority and on-demand orders, which book inside the create request, are not supported here). validate defaults to true: the order is not saved when the suburb and postcode do not match (a suggested address is returned instead). Creating twice creates two orders. International orders (customs data) are not supported here. POST /orders.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| tags | No | Your own labels for filtering. | |
| confirm | Yes | Must be true. The order is real: it can email the customer and, for a named on-demand carrier, book it at once. Ask the user to confirm first. | |
| parcels | Yes | The parcels (qty and weight are the minimum; leave qty out when you also send products). | |
| features | No | Carrier add-on services; some need prior approval from Shippit. | |
| products | No | Optional line items for the packing slip. | |
| validate | No | Reject the order if suburb and postcode do not match (default true). | |
| courier_type | No | Service level (default standard). Give this or courier_allocation. | |
| receiver_name | No | Name of the person receiving it, if different from the customer. | |
| customer_email | Yes | The customer's email (Shippit sends tracking notifications here unless suppressed). | |
| delivery_state | Yes | State. Australian orders use NSW, VIC, QLD, WA, SA, TAS, ACT or NT. | |
| customer_mobile | No | ||
| delivery_suburb | Yes | ||
| delivery_address | Yes | ||
| delivery_company | No | ||
| retailer_invoice | No | Your order number, printed on the label and packing slip. | |
| delivery_postcode | Yes | ||
| authority_to_leave | No | Whether the parcel may be left unattended. | |
| courier_allocation | No | A specific carrier keyword, e.g. CouriersPlease (see the Shippit carriers list). Instead of courier_type. | |
| customer_last_name | No | ||
| retailer_reference | No | ||
| customer_first_name | Yes | ||
| delivery_country_code | No | Two-letter country code (default: the merchant's home country, usually AU). | |
| delivery_instructions | No | Instructions for the driver, at most 55 characters. | |
| receiver_contact_number | No | ||
| suppress_communications | No | true = Shippit sends no tracking notifications to the customer for this order (default false: it does). |