...
Parameter | Mandatory | Type | Description |
|---|---|---|---|
Origin | Optional | Specify the unique order number from your source system, that was used as the packing slip no when the order was published | |
Destination | Y | JSON object of destination address | |
Packages | Y | JSON object array of package objects | |
Commodities | Y | Refer to Commodity Information | |
Shiptype | Y | String | the value must always be INBOUND |
Commodities Parameters
Parameter | Mandatory | Type | Description | Example |
|---|---|---|---|---|
Description | Y | String | Product name or description of the item | Leave With Me Dress In Navy Fl |
Units | N | Numerical | Count of specific item | 1 |
UnitValue | Y | Decimal | Value of the item per unit | 25 |
UnitKg | Y | Decimal | Weight of the item per unit | 0.25 |
Country | N | String | Country of items origin | New Zealand |
Currency | Y | String | Currency of UnitValue | NZD |
ItemNo | N | String | Item Number | 12312 |
SKU | Y | String | SKU Number | ST1306B-white |
...
| Code Block |
|---|
access_key: [access_key_for_site_account] Content-Type: application/json; charset=utf-8 |
Body
| Code Block |
|---|
{ "DeliveryReference": "orderNumber", "Reference2": "RMA", "Reference3": "", "Origin": { "Id": 0, "Name": "OriginName", "Address": { "BuildingName": "", "StreetAddress": "285 Main Street", "Suburb": "Torrance", "City": "CALIFORNIA", "PostCode": "90501", "CountryCode": "US" }, "ContactPerson": "Origin person name", "PhoneNumber": "02 9111 01101", "DeliveryReferenceEmail": "ORDER123"originemail@test.com" }, "Destination": { "Id": 0, "Name": "DestinationName", "Address": { "BuildingName": "VIC", "StreetAddress": "DestinationStreetAddress285 Coward Street", "Suburb": "AvonsideCARSON", "City": "ChristchurchCALIFORNIA", "PostCode": "806190810", "CountryCode": "NZUS" }, "ContactPerson": "DestinationContactJOHN SMITH", "PhoneNumber": "12345678902 9111 1111", "Email": "destinationemail@emaildestinationemail@test.com", "DeliveryInstructions": "", "SendTrackingEmail": "false" }, "Commodities": [ { "Description": "Food Bar", "Units": "1", "UnitValue": 50, "UnitKg": 0.6, "Currency": "USD", "Country": "DesinationdeliveryinstructionsAU" }, { "Description": "Food Bar", "Units": "1", "UnitValue": 50, "UnitKg": 0.6, "IsSaturdayDeliveryCurrency":false, "USD", "IsSignatureRequiredCountry":true "AU" } ], "Packages": [ { "Height": 1, "Length": 1, "IdWidth":0 1, "WidthKg":10 2, "KgName":0.1, "PARCEL", "NameType": "SATCHEL",Box", "OverLabelBarcode": "" } ], "PackageCodeissignaturerequired":"DLE"false, "PrintToPrinter":false, "IncludeLineDetails":true, "TypeShipType":"BoxINBOUND", "SendTrackingEmail":false } ], } } |
Response
| Code Block |
|---|
{
"Available":[
{
"QuoteId":"e7fdf36c-8f6a-4d3f-8d96-c8b5893a0e7f",
"CarrierId":604,
"CarrierName":"Omni Parcel",
"DeliveryType":"AIR TRACKED",
"Cost":5.82,
"ServiceStandard":"",
"Comments":"",
"Route":"OFFSHORE->AKL- SI",
"IsRuralDelivery":false,
"IsSaturdayDelivery":false,
"IsFreightForward":false,
"CarrierServiceType":"InternationalCourier"
}
],
"Rejected":[
],
"ValidationErrors":{
}
} |
...