Your browser does not support Java Script or javascript is disabled. Please ensure that your browser supports it for full compatibility with our services.

Combine Shipments

Combine Shipments

After you've created all the shipments you need, you have to combine them using the method below. "main_shipment" parameter allows you to create a single shipment for delivering whole order to a place where it will be split into separate shipments, (e.g. the Rosebery warehouse for DHL). It is optional for users with the "Free pickup" option. 

Request

Orders
URI
/shipments/
Method PUT
Authorization
required

Parameters

Name
Required
Type
Description
shipments[]
required list List of shipments IDs acquired from this function: "Create Shipment".
main_shipment
required/optional shipment object Shipment for delivering whole order to place where it will be split into separate shipments. Optional for clients with the "Free pickup" option.
main_shipment.transient_id
optional string Id returned with response. It allows distinguishing of shipments.
main_shipment.service.code
required string Chosen service. Service codes can be obtained using this functionality: "Get Quote".
main_shipment.collection_type
required string Collection type.
main_shipment.collection
required/
optional
collection object Collection address data, required for "pickup" collection type.
main_shipment.collection.first_name
required string First name.
main_shipment.collection.last_name
required string Last name.
main_shipment.collection.company
optional string Company.
main_shipment.collection.email
required string Email address.
main_shipment.collection.phone
required string Phone number.
main_shipment.collection.country
required string - two letter country code Country code.
main_shipment.collection.postcode
required  string Post code.
main_shipment.collection.city
required string City.
main_shipment.collection.address_lines
required  list of strings List containing collection address lines. First line is required and should always be present.
main_shipment.collection.pickup
required  pickup object Pick up information
main_shipment.collection.pickup.date
required  string - date in iso8601 format Pick up date
main_shipment.collection.pickup.time_earliest
required  string - time in iso8601 format Pick up earliest time
main_shipment.collection.pickup.time_latest
required  string - time in iso8601 format Pick up latest time
main_shipment.delivery
required delivery object Delivery address data
main_shipment.delivery.first_name
required string First name 
main_shipment.delivery.last_name
required string Last name 
main_shipment.delivery.company
optional string Company
main_shipment.delivery.email
required string Email address
main_shipment.delivery.phone
required string Phone number
main_shipment.delivery.country
required string - two letter country code Country code.
main_shipment.delivery.postcode
required  string Post code 
main_shipment.delivery.city
required string City 
main_shipment.delivery.address_lines
required  list of strings List containing delivery address lines. First line is required and should always be present. 
main_shipment.packages
required list of packages

List containing information concerning each package.

main_shipment.packages[].height
required decimal number Package height
main_shipment.packages[].width
required decimal number Package width
main_shipment.packages[].length
required decimal number Package length
main_shipment.packages[].weight
required decimal number Package weight
main_shipment.packages[].unit
required string - 'cm' or 'in' Measure/Weight unit, either 'cm' for centimetres and kilograms or 'in' for inches and pounds.
main_shipment.customs_information
required customs information object

Customs information.

main_shipment.customs_information.description
optional string Additional comments about shipment.
main_shipment.customs_information.reason
required string Reason for shipping. Possible values: Gift, Purchase, Sale, Sample, Return, Repair or Personal Effects.
main_shipment.customs_information.tax_status
required string Tax status: Private or Company.
main_shipment.customs_information.items
required list of items

List containing descriptions of items inside package.

main_shipment.customs_information.items[].description
required string Item Description
main_shipment.customs_information.items[].quantity
required integer number Quantity of particular item type.
main_shipment.customs_information.items[].value
required decimal number

Value of a single item. Total value of all items can not exceed 7500 AUD.

main_shipment.customs_information.items[].currency
required string - three letter currency code Currency for value. For now we support only AUD.
main_shipment.customs_information.items[].madein
required string Country of manufacture
main_shipment.description
required string

Brief description of goods.

main_shipment.options.digital_signature
optional .png or .jpg in BASE64 code

Encoded image of digital signature, used during generation of documents.

Request body

{

    "request": {

        "shipments": [

            "S2AS004531"

        ],

        "main_shipment": {

            "transient_id": "123",

            "service": {

                "code": "6001"

            },

            "collection_type": "pickup",

            "collection": {

                "first_name": "Johnny",

                "last_name": "Good",

                "company": "Bee.",

                "email": "johny.good@gmail.com",

                "phone": "+55555555",

                "country": "AU",

                "postcode": "3000",

                "city": "Melbourne",

                "address_lines": [

                    "Level 1 339 William Street"

                ],

                "pickup": {

                    "date": "2014-05-03",

                    "time_earliest": "09:00",

                    "time_latest": "14:00"

                }

            },

            "delivery": {

                "first_name": "test firstname",

                "last_name": "test last name",

                "company": "test company",

                "email": "test_test@testemail.com",

                "phone": "+64441231",

                "country": "AU",

                "postcode": "2018",

                "city": "Rosebery",

                "address_lines": [

                    "test street"

                ]

            },

            "packages": [

                {

                    "length": 10,

                    "width": 10,

                    "height": 20,

                    "weight": 2,

                    "unit": "cm"

                }

            ],            "customs_information": {

                "description": "laptop,camera",

                "reason": "repair",

                "tax_status": "company",

                "lithium": false,

                "items": [

                    {

                        "description": "shoes",

                        "quantity": 1,

                        "value": 300,

                        "currency": "AUD",

                        "madein": "US"

                    }

                ]

            },

            "description": "aaaaa"

        }

    }

}

Response

{
    "message": "OK",
    "code": 200,
    "result": {
        "order": {
            "status": "NEW",
            "shipments": [
                {
                    "status": "PEN",
                    "delivery": {
                        "phone": "+452345678",
                        "first_name": "Wiktoria",
                        "last_name": "Krolowa",
                        "postcode": "4653",
                        "city": "Karise",
                        "country": "DK",
                        "company": "Wiktoria Krolowa",
                        "address_lines": [
                            "Kwiatowa7/7",
                            "",
                            ""
                        ],
                        "email": "zlomek@gmail.com"
                    },
                    "tracking_number": "AUMAG000002004531",
                    "collection_type": "pickup",
                    "description": "uuujjj",
                    "service": {
                        "price": {
                            "currency": "AUD",
                            "amount": 18.43,
                            "total": 18.43,
                            "insurance": 0,
                            "gst": 0
                        },
                        "code": "7002",
                        "name": "GlobalMail"
                    },
                    "customs_information": {
                        "tax_status": "Company",
                        "reason": "Repair",
                        "description": "laptop",
                        "items": [
                            {
                                "currency": "AUD",
                                "madein": "AU",
                                "description": " Olympus Stylus 750 7.1MP Digital Camera",
                                "value": 161.94,
                                "quantity": 1
                            }
                        ]
                    },
                    "packages": [
                        {
                            "width": 10,
                            "length": 10,
                            "unit_weight": "CM",
                            "weight": 1,
                            "height": 10
                        }
                    ],
                    "id": "S2AS004531",
                    "collection": {
                        "phone": "+61447543630087",
                        "first_name": "Johnny",
                        "last_name": "Good",
                        "postcode": "3000",
                        "city": "Melbourne",
                        "country": "AU",
                        "company": "Beee.",
                        "address_lines": [
                            "Level 1 339 William Street",
                            "",
                            ""
                        ],
                        "pickup": {
                            "date": "2014-04-30T00:00:00",
                            "time_latest": "04:00",
                            "time_earliest": "00:00"
                        },
                        "email": "johnny.good@gmail.com"
                    }
                },
                {
                    "status": "NEW",
                    "description": "aaaaa",
                    "collection": {
                        "phone": "+61447543630087",
                        "first_name": "Johnny",
                        "last_name": "Good",
                        "postcode": "3000",
                        "city": "Melbourne",
                        "country": "AU",
                        "company": "Bee.",
                        "address_lines": [
                            "Level 1 339 William Street",
                            "",
                            ""
                        ],
                        "pickup": {
                            "date": "2014-05-03T00:00:00",
                            "time_latest": "14:00",
                            "time_earliest": "09:00"
                        },
                        "email": "johnny.good@gmail.com"
                    },
                    "delivery": {
                        "phone": "+611231231231",
                        "first_name": "test firstname",
                        "last_name": "test last name",
                        "postcode": "2018",
                        "city": "Rosebery",
                        "country": "AU",
                        "company": "test company",
                        "address_lines": [
                            "test street",
                            "",
                            ""
                        ],
                        "email": "test_test@testemail.com"
                    },
                    "collection_type": "pickup",
                    "packages": [
                        {
                            "width": 10,
                            "length": 10,
                            "unit_weight": "CM",
                            "weight": 2,
                            "height": 20
                        }
                    ],
                    "id": "S2AS004532",
                    "customs_information": {
                        "tax_status": "Company",
                        "reason": "Repair",
                        "description": "laptop,camera",
                        "items": [
                            {
                                "currency": "AUD",
                                "madein": "US",
                                "description": "shoes",
                                "value": 300,
                                "quantity": 1
                            }
                        ]
                    },
                    "transient_id": "123",
                    "service": {
                        "price": {
                            "currency": "AUD",
                            "amount": 15.05,
                            "total": 16.55,
                            "insurance": 0,
                            "gst": 1.5
                        },
                        "code": "6001",
                        "name": "Toll Priority\r\nAuthority to Leave (ATL)"
                    },
                    "tracking_number": "N/A"
                }
            ],
            "price": {
                "gst": "1.50",
                "currency": "AUD",
                "amount": "33.48",
                "summary_child_shipments": "18.43",
                "total": "34.98",
                "insurance": "0.00"
            },
            "id": "S2AO001769"
        }
    }
}

After parent shipment is created you can accept it as regular order using this method: Accept Order.