3.0 Consignment Creation API

Origin

N

Multiple fields

Refer to Sender / Receiver Information

Refer to Address Information

Destination

Y

Multiple fields

Refer to Sender / Receiver Information

Refer to Address Information

DeliveryInstructions

N

String(120 Characters)

For special instructions for delivery to appear on label

SendTrackingEmail

N

Boolean (true/false)

Should a track and trace email be required to be sent

Packages

Y

Multiple fields

Refer to Package Information

Commodities

Y

Multiple fields

Refer to Commodity Information

DangerousGoods

C

Multiple fields

Refer to Commodity Information, DangerousGoods, and DangerousGoodsItem

issignaturerequired

N

Boolean (true/false)

If “true”, Signature on Delivery is required. If “false”, no signature on delivery is required

DeliveryReference

Y

String (1000 characters)

Shipment reference number (commonly used for the online order number/customer reference)

Reference2

N

String (500 characters)

Additional Shipment Reference

Reference3

N

String (500 characters)

Additional Shipment Reference

PrintToPrinter

N

Boolean (true/false)

If “true” system will send job to installed Print Agent.

Outputs

Y

Requested label size and format. Response will be provided in JSON string array. Refer to Output Information

Carrier

N

String(50 Characters)

Where multiple carrier options are available, a carrier can be pre-nominated. E.g “Omni Parcel”.

Service

C

String (max length defined by available services)

Where multiple service options are available, a service must be pre-nominated. Eg.

“eCommerce Standard Tracked“

“eCommerce Express Tracked“

“Domestic Express“

“Domestic Standard“

“Domestic Large Parcel”

ShipType

N

String (10 characters)

Use “INBOUND” for returns, Not required for normal outbound shipments (Used by OmniReturns only)

DutiesAndTaxesByReceiver

Y*

Boolean (true/false)

True = DDU (Duties and Taxes will need to be paid by recipient)

False = DDP (Duties and Taxes will need to be paid by the sender)

ProductCategory

N

String (50 characters)

Parent category, e.g. stationary, fashion, beauty products, shoes etc

SendLabel

N

String (1 Character)

“Y” Or “N” – if “Y” then email with the label attached will be sent to end customer (used by OmniReturns only)

LabelBranding

N

Object (see “description)

public class CustomBranding
        {
            public string ReturnAddress { get; set; }
            public Guid? LogoKey { get; set; }
            public byte[] Logo { get; set; }

            public string LogoFilename { get; set; }
        }

IncludeLineDetails

N

Boolean (true/false)

If “True” OmniParcel will return all relevant tracking numbers in the “Items” tag under “Consignments”

If “False” OmniParcel will return the consignment number only

See sample request below for more information

InvoiceData

N

String (no max limit)

For passing the commercial invoice to OmniParcel

CODValue

N

Decimal (18,4)

COD Value (Cash on delivery amount). Only used for some carriers

CostCentreId

N

String

Cost Centre id # if known

CostCentreName

N

String

Name of Cost Centre or code if known

TaxCollected

C

Boolean (true/false)

Required by some carriers and when shipping to some countries

AmountCollected

C

Decimal (18,2)

The tax amount that has been collected. Required by some carriers and when shipping to some countries. Please note that this is on consignment level, not commodity level

TaxIDs

C

Multiple fields

Refer to Tax IDs

CarrierId

Internal OmniParcel identification number for the carrier

CarrierName

Carrier Name

Message

Notification message for shipment create request

Errors

Validation errors if fields are incomplete or incorrect

SiteId

Your account site Id

Consignments

The create shipment, output shipments

IsFreightForward

If pickup is originating from an address other than the site address

IsOvernight

If delivery has been flagged for Saturday delivery

DestinationPort

IsRural

If delivery has been identified as a rural area delivery

HasTrackPaks

CommodityChanges

Property

String

Message

String

Connote

String

Unique consignment number

TrackingUrl

String

Tracking url

Cost

Decimal ( 2dp)

Cost of Shipment

CarrierType

Integer

Internal Carrier Type

IsSaturdayDelivery

Boolean

If delivery has been flagged for Saturday delivery

IsRural

Boolean

If delivery has been identified as a rural area delivery

IsOvernight

Boolean

HasTrackPaks

Boolean

Items