List of Example API payloads
Order API
The Order API will submit an order to Shippit.
At minimum, an Order requires a delivery location, user details, and parcel details. Shippit will then generate the order, allocate the courier, and fill in the origin location based on the provided info and merchant configuration on Shippit.
The Purpose of this document is to provide working samples of API payloads. The example payloads have been created to enable you to test the Shippit integration via a service such as Postman.
Click and Collect Order
A Click & Collect order is an order which a customer will collect from the store, rather than having it delivered to their home. Unlike standard / express orders, Click & Collect orders do not proceed to the Ready to Ship page. They remain in the New Orders page until you call either the Book API or click the Label button.
{
"order": {
"courier_type": "click_and_collect",
"delivery_address": "1 Test",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123",
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
}
],
"product_attributes": [{
"quantity": 2,
"title": "Blue Hat",
"price": 21.90
}
],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}Express Order
An Express order is an order which is scheduled for delivery the day after the order is placed. If an order is placed on a Monday, for example, it will be scheduled for delivery on Tuesday.
{
"order": {
"courier_type": "express",
"delivery_address": "1 Test",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123",
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
}
],
"product_attributes": [{
"quantity": 2,
"title": "Blue Hat",
"price": 21.90
}
],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}International Order
An International order is is an order which is picked up from an address within Australia, and delivered to an address outside of Australia.
{
"order": {
"courier_allocation": "DhlExpressInternational",
"customer_shipping_fee_paid": "95.00",
"delivery_country_code": "NZ",
"delivery_address": "1 Test",
"delivery_postcode": "1061",
"delivery_state": "Auckland",
"delivery_suburb": "Onehunga",
"authority_to_leave": "Yes",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123",
"description": "Description of parcel",
"duties": 12.90,
"tax_amount": 5.00,
"customs_clearance_attributes": {
"tax_id_type": "VAT/GST",
"tax_id_country_code": "NZ",
"tax_id_number": "987123210845654",
"incoterm": "DDU",
"export_reason": "Gift",
"recipient_id": "PA1992991"
},
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
}],
"product_attributes": [{
"quantity": 1,
"title": "Blue Hat",
"price": 21.90
}],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}Standard Order
A Standard order is an order which is scheduled for delivery within 3 to 5 business days.
💡For indicative service levels, check out: Carrier Service Levels.
{
"order": {
"courier_type": "standard",
"delivery_address": "1 Test",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123standard",
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
}
],
"product_attributes": [{
"quantity": 2,
"title": "Blue Hat",
"price": 21.90
}
],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}Track only with tracking histories
A Track Only order is an order where the courier has already been booked and allocated outside of Shippit, and only tracking notifications are required for the order within Shippit.
{
"order": {
"courier_allocation": "Eparcel",
"courier_job_id": "SAMPLE-LN-000",
"tracking_only": true,
"tracking_histories": [
{
"status": "order_placed",
"timestamp": "2023-08-01T12:34:56Z"
},
{
"status": "ready_for_pickup",
"timestamp": "2023-08-05T12:34:56Z"
}
],
"delivery_address": "1 Union Street",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"parcel_attributes": [
{
"qty": 1,
"weight": 2.1,
"label_number": "SAMPLE-LN-888888"
}
],
"user_attributes": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith",
"mobile": "0401152002"
}
}
}Plain Label Order
A Plain Label order is an order where no courier is required, as the merchant will be organising their own method of delivery to the customer.
{
"order": {
"courier_allocation": "PlainLabel",
"delivery_address": "1 Test",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123plainlabel",
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
}
],
"product_attributes": [{
"quantity": 2,
"title": "Blue Hat",
"price": 21.90
}
],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}On Demand Order
An On Demand order is an order that is automatically booked by Shippit for an ASAP pick-up, respecting store pick-and-pack time, for delivery within 3 hours.
{
"order": {
"courier_type": "on_demand",
"delivery_address": "1 Union Street",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"delivery_date": "2016-07-26T00:00:00.000Z",
"delivery_instructions": "We have an old dog who is very friendly",
"retailer_invoice": "SO-123",
"authority_to_leave": "Yes",
"parcel_attributes": [
{
"qty": 1,
"weight": 1.1,
"width": 0.1,
"length": 0.1,
"depth": 0.1
}
],
"user_attributes": {
"email": "[email protected]",
"first_name": "John",
"last_name": "Smith"
},
"receiver_contact_number": "0400000000"
}
}Priority Order
A Priority order is an order that is automatically booked by Shippit for pick-up and delivery within the same day. Priority and On Demand orders will remain on the New Orders page until dismissed, either by clicking the Label button within the UI or by making a GET Label request via API.
{
"order": {
"courier_type": "priority",
"delivery_address": "1 Test",
"delivery_postcode": "2009",
"delivery_state": "NSW",
"delivery_suburb": "Pyrmont",
"authority_to_leave": "Yes",
"delivery_date": "2023-09-01",
"delivery_window": "09:00-10:00",
"receiver_contact_number": "0411000444",
"retailer_invoice": "SO-123",
"parcel_attributes": [{
"qty": 1,
"weight": 4.1,
"length": 0.2,
"depth": 0.1,
"width": 0.9
},
{
"qty": 1,
"weight": 2.1,
"length": 0.1,
"depth": 0.1,
"width": 0.1
}
],
"product_attributes": [{
"quantity": 2,
"title": "Blue Hat",
"price": 21.90
},
{
"quantity": 1,
"title": "Red Hat",
"price": 10.95
}
],
"user_attributes": {
"email": "[email protected]",
"mobile": "0411000000",
"first_name": "John",
"last_name": "Smith"
}
}
}More on Shippit API
💡To learn more on the Shippit API and to gain an insight of store setups, API Authentication requirements and on how to integrate into your order flow, check out: Getting started with API Integrations.
For further technical specifications on the Shippit, check out: Shippit API documentation