Create split order example

You can create a split order using the group order API endpoint. It creates a group order given a reference number and returns the group order ID:

JSON

{
    "reference_number":  "R12345"
}

When you have created a group order ID using the group order API, you can add individual orders to the group order using the order API endpoint. When you create the individual orders, make sure you include the group order ID to ensure that they're assigned to the correct group order:

Standard order with group order code example

JSON

{
    "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": "john.smith@example.com",
            "mobile": "0411000000",
            "first_name": "John",
            "last_name": "Smith"
        },
        "group_order": {
            "id": "GOhIyYRuDwxuK"
        }
    }
}

Express order with group order code example

JSON

{
    "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": "john.smith@example.com",
            "mobile": "0411000000",
            "first_name": "John",
            "last_name": "Smith"
        },
        "group_order": {
            "id": "GOhIyYRuDwxuK"
        }
    }
}

Priority order with group order code example

JSON

{
    "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": "john.smith@example.com",
            "mobile": "0411000000",
            "first_name": "John",
            "last_name": "Smith"
        },
        "group_order": {
            "id": "GOhIyYRuDwxuK"
        }
    }
}

On demand order with group order code example

JSON

{
    "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": "test@example.com",
        "first_name": "John",
        "last_name": "Smith"
        },
        "receiver_contact_number": "0400000000",
        "group_order": {
            "id": "GOhIyYRuDwxuK"
        }
    }
}

International order with group order code example

JSON

{
    "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": "john.smith@example.com",
            "mobile": "0411000000",
            "first_name": "John",
            "last_name": "Smith"
        },
        "group_order": {
            "id": "GOhIyYRuDwxuK"
        }
    }
}