2.0 API Parameters

Name

Y

String (50 characters)

Consignee name/Business name

Email

Y

String (200 characters)

Email address

ContactPerson

Y

String (50 characters)

Contact person at delivery

PhoneNumber

Y

String (50 characters)

Phone contact number at delivery

ID

N

Integer

Address book ID. Only applicable if you have saved addresses in OmniParcel

RecipientTaxId

N

String (100 characters)

To be used in receiver information only. Not a mandatory field in the system, but some carriers require this information

BuildingName

N

String (50 characters)

Address identifier, e.g. Unit 1, Level 2

StreetAddress

Y

String(50 characters)

Street address e.g. 32 Sommer Place

Suburb

Y

String(50 characters)

Suburb Name / City name. See Suburb / State mapping below

City

Y

String(50 characters)

City/State Name. See Suburb / State mapping below

PostCode

Y

String(10 characters)

Postal code

CountryCode

Y

String(2 characters)

2 letter country code, eg, US, NZ, AU, CN, CA, etc

Street number

BuildingName or StreetAddress*

Street name

BuildingName or StreetAddress*

Suburb

Suburb

State (or province)

City

Postcode

PostCode

Country

CountryCode

Building name

BuildingName or StreetAddress*

Street number

BuildingName or StreetAddress*

Unit number

BuildingName or StreetAddress*

Street name

BuildingName or StreetAddress*

City

Suburb

State (or province)

City

Postcode

PostCode

Country

CountryCode

Street number and street name

BuildingName or StreetAddress*

Suburb

Suburb

City

City

Postcode

PostCode

Country

CountryCode

Street number and street name

BuildingName or StreetAddress*

City

Suburb (Same value mapped to Suburb + City)

City

City (Same value mapped to Suburb + City)

Postcode

PostCode

Country

CountryCode

Name

C (Required by some carriers)

String (50 characters)

Name of the package

Length

Y

Decimal ( 4dp)

Length of package in centimetres

Width

Y

Decimal ( 4dp)

Width of package in centimetres

Height

Y

Decimal ( 4dp)

Height of package in centimetres

Kg

Y

Decimal ( 4dp)

Weight of package in Kilos

Type

Y

String(30 characters)

Package type, Valid values are: Bag, Box, Carton, Container, Crate, Envelope, Pail, Pallet, Satchel, Tube, Custom

OverLabelBarcode

N

String(50 characters)

This barcode is mandatory if overlabel process is required. This functionality will work for one package per consignment only if we are using customer’s own label as final mile label.

Description

Y

String(200 characters)

A brief description of the goods. Please ensure you are always providing accurate item descriptions.

HarmonizedCode

C

String(50 characters)

The internationally standardised system of names and numbers to classify traded products. HS codes are mandatory for all international shipments.

Units

Y

Integer

Number of inner pieces.

UnitValue

Y

Decimal ( 4dp)

Individual value of the unit.

UnitKg

Y

Decimal ( 4dp)

Total weight (KG) of all units.

Currency

Y

String(3 characters)

Currency code, NZD, AUD, USD, etc

Country

Y

String(2 Characters)

Country of Manufacture 2 Alpha code, NZ, AU, US, GB, etc

itemSKU

N

String(30 characters)

SKU details of the consignment

IsDG

C

Boolean

Is this a Dangerous Goods item; true (1) or false (0).

For any consignments where you are shipping dangerous goods, this field must be “1”.

DangerousGoodsItem

C

See DangerousGoodsItem

LABEL_PDF

C

String(200 characters)

Label is presented on an A4 page

LABEL_PNG_100X175

C

String(200 characters)

Label is presented as a PNG image with dimension 100mm x 175mm (4x7)

LABEL_PNG_100X150

C

String(200 characters)

Label is presented as a PNG image with dimension 100mm x 150mm (4x6)

LABEL_PDF_100X175

C

String(200 characters)

Label is presented as a PDF with dimension 100mm x 175mm (4x7)

LABEL_PDF_100X150

C

String(200 characters)

Label is presented as a PDF with dimension 100mm x 150mm (4x6)

LABEL_ZPL_100X175

C

String(200 characters)

Label is presented in ZPL format with dimension 100mm x 175mm (4x7)

LABEL_ZPL_100X150

C

String(200 characters)

Label is presented in ZPL format with dimension 100mm x 150mm (4x6)

IdType

Conditional*

Depending on the import/export rules of your origin and destination countries

String(200 characters)

User can pass the IdType in this field. eg: XIEORINumber

IOSSNUMBER

GBEORINumber

See full list below

IdNumber

Conditional

String(200 characters)

This conditional field is required if there is a value in IdType

AdditionalHandingInfo

Mandatory for DG shipments to New Zealand

String (100 characters)

Additional handing information

HazchemCode

Mandatory for DG shipments to New Zealand

String

Hazchem code

IsRadioActive

Mandatory for DG shipments to New Zealand

Boolean

Is goods radio active

CcargoAircraftOnly

Mandatory for DG shipments to New Zealand

Boolean

Is Cargo Aircraft Only

IsDGLQ

Mandatory for DG shipments to New Zealand

Boolean

Is dangerous goods limited quantities

TotalQuantity

Mandatory for DG shipments to New Zealand

String (200 characters)

Total quantity of dangerous goods

TotalKg

Mandatory for DG shipments to New Zealand

Decimal

Total weight KG of dangerous goods, required

SignoffName

Mandatory for DG shipments to New Zealand

String (50 characters)

Signoff name

SignoffRole

Mandatory for DG shipments to New Zealand

String (50 characters)

Signoff role

lineitems

Mandatory for DG shipments to New Zealand

Object list

A list of dangerous goods item

Description

Mandatory if DangerousGoods is populated

String (100 characters)

ClassRrDivision

Mandatory if DangerousGoods is populated

String (50 characters)

UnorIDNno

Mandatory if DangerousGoods is populated

String (50 characters)

PackingGroup

Mandatory if DangerousGoods is populated

String (50 characters)

SubsidaryRisk

Mandatory if DangerousGoods is populated

String (50 characters)

Packing

Mandatory if DangerousGoods is populated

String (50 characters)

PackingInstr

Mandatory if DangerousGoods is populated

String (50 characters)

Authorization

Mandatory if DangerousGoods is populated

String (50 characters)