Invocation URL: /v6/fastlabel/addconsignment

Descripton:

Adds a consignment to the specified manifest. This call may return an error if you supply unknown address information and the manifest's AutoImport flag is false.

Parameters:

ManifestID - Optional. The ID of a manifest (from List Manifests) to add the consignment to. If omitted, defaults to the manifest that would be returned from Get Open Manifest.
CostCenterID - Optional. The ID (from List Cost Centers) of a cost center to log this consignment against.
UserID - A UserID from the List Users method.

Receiver Details:
AccountNo - Optional. Your unique reference for this customer.
ContactName - Optional. The contact name of someone at the receivers company.
CompanyName - The name of the receiving company.
Address1 - Receiver address line 1.
Address2 - Optional. Receiver address line 2.
Suburb - Receiver suburb.
Postcode - Receiver postcode.

Note: - The Suburb/Postcode combination must match our Price Service Calculator. See List Delivery Suburbs for a list.

Contact Details:
ContactEmail - Optional. The Email Address of the contact.
ContactPhone - Optional. The Phone Number of the contact.
ContactMobile - Optional. The Mobile Number of the contact.

Special Instructions:
SpecialInstruction1 - Optional. The first Special Instruction line.
SpecialInstruction2 - Optional. The second Special Instruction line.
SpecialInstruction3 - Optional. The third Special Instruction line.

Extras:
ApplyRurals - Optional. Specify 'true' or 'false'. If omitted, defaults to 'false'.
ApplySaturdayDelivery - Optional. Specify 'true' or 'false'. If omitted, defaults to 'false'.

AutoImport - default false, if set to true items will still be added if to do not have stock or invalid addresses. No label number is generated.
Consignment Items:
Items - Mandatory to have at least one item. Items have 4 properties:

Reference - Optional. Your own item reference.
Quantity - Quantity of the same item.
Weight - Weight in kg. Items cannot have a weight > 25kg.
CubicWeight - Cubic weight in kg. Items cannot have a cubic weight > 40kg.

Items are specified using parameters named as follows:

Items[0].Reference
Items[0].Quantity
Items[0].Weight
Items[0].Packaging - for custom parcel types (see List Custom Parcel Types)
Items[0].CubicWeight
Items[1].Reference
Items[1].Quantity
Items[1].Weight
Items[1].Packaging
Items[1].CubicWeight
(...etc for as many items as you have).

Packaging codes are as follows: (please use the numeric code)

• Parcel = 1
• Satchel A2 = 4
• Satchel A3 = 5
• Satchel A4 (Not available in Australia) = 6
• Satchel A5 (Not available in South Africa) = 7

Returns:

A data structure like:

{

    'result': {
        'CostExGst': '5.45',
        'CostMarkupExGst': '5.45',
        'ConsignmentID': '2625673',
        'ManifestID': '222117',
        'Items': [
            {
                'itemID': '3437190',
                'parcelWeight': '1',
                'labels': [
                    {
                        'labelNumber': 'FW0000881936',
                        'colour': 'RED'
                    }
                ]
            },
            {
                'itemID': '3437191',
                'parcelWeight': '2',
                'labels': [
                    {
                        'labelNumber': 'FW0000881937',
                        'colour': 'RED'
                    }
                ]
            }
        ],
        'DestinationRFCode': 'NPE',
		'DestinationSubdepotCode': '',
        'Delivery_CFCode': ''
    },
    'generated_in': '418ms'

}

Example:

https://au.api.fastway.org/v6/fastlabel/addconsignment?UserID=96&CompanyName=Test Company&Address1=Test Address 1&Suburb=Ahuriri&Postcode=4110&Items[0].Weight=1&Items[0].reference=12154112&Items[0].Quantity=1&Items[0].Packaging=1&api_key=YOUR_API_KEY

Back to FastLabel