...
Field | Data Type | Required | Description | |
|---|---|---|---|---|
channel | String | No | Request channel | |
source | Object | Yes | Source Address | |
officeId | String | No | Office identifier | |
addressLine1 | String | Yes | Source address line 1 | |
addressLine2 | String | No | Source address line 2 | |
country | String | Yes | Source country code | |
city | String | Yes | Source city name | |
postcode | String | Yes | Source postal code | |
destination | Object | Yes | Destination Address | |
addressLine1 | String | Yes | Destination address line 1 | |
addressLine2 | String | No | Destination address line 2 | |
country | String | Yes | Destination country code | |
city | String | Yes | Destination city name | |
postcode | String | Yes | Destination postal code | |
items | Object[] | Yes for international shipment | Items | |
hsCode | String | No | Item Harmonized System (HS) Code | |
quantity | Integer | Yes | Item quantity | |
value | Decimal | No | Item price | |
categories | String[] | No | Item categories | |
sku | String | No | Item SKU | |
weight | Decimal | Yes | Item weight | |
length | Decimal | Yes | Item length | |
width | Decimal | Yes | Item width | |
height | Decimal | Yes | Item height | |
name | String | No | Item name | |
measureUnit | String | No | Item measure unit. Available values are CM, IN, M, FT, MM. Default value will be used if the value is null. | |
weightUnit | String | No | Item weight unit. Available values are Grams, Kilograms, Ounces, Pounds. Default value will be used if the value is null. | |
currency | String | No | Item currency. Default value will be used if the value is null | |
packages | Object[] | yes | Packages | |
length | Decimal | Yes | Package length | |
width | Decimal | Yes | Package width | |
height | Decimal | Yes | Package height | |
weight | Decimal | Yes | Package weight | |
contentWeight | Decimal | Yes | Package content weight | |
measureUnit | String | No | Item measure unit. Available values are CM, IN, M, FT, MM. Default value will be used if the value is null. | |
weightUnit | String | No | Item weight unit. Available values are Grams, Kilograms, Ounces, Pounds. Default value will be used if the value is null. | |
quantity | Integer | Yes | Package quantity | |
pickupDetails | Object | Yes | Quote pickup details | |
asap | Boolean | Yes | Pickup ASAP | |
pickupDate | Date | Yes if asap is true | Pickup date. The format is “yyyy-MM-dd“. ex: “2022-09-27“ | |
pickupTimezone | String | Yes if asap is true | Pickup timezone. ex: “+10:00“ | |
pickupEarliestTime | String | yes if asap is true | Pickup earliest time. The format is “hh:mm“. ex: “10:00“ | |
poBox | Boolean | No | PO box. Default value is false | |
dangerousGoods | Boolean | No | Dangerous goods. Default value is false | |
giftWrapping | Boolean | No | Gift wrapping. Default value is false | |
unattendedDelivery | Boolean | No | Unattended delivery. Default value is false | |
tailGate | Boolean | No | Tail gate | |
residentialDelivery | Boolean | No | Residential delivery | |
residentialPickup | Boolean | No | Residential pickup | |
trolleyRequired | Boolean | No | Trolley required | |
clientPresent | Boolean | No | Client present | |
accompaniedDelivery | Boolean | No | Accompanied delivery | |
fragile | Boolean | No | Fragile | |
reasonForShipping | String | No | Reason for shipping. Available values are | |
taxStatus | String | No | Tax status. Available values are | |
Request
...
Payload Sample
| Code Block | ||
|---|---|---|
| ||
{
"source": {
"addressLine1": "Highway Street",
"addressLine2": null,
"country": "AU",
"city": "South Melbourne",
"postcode": "3205"
},
"destination": {
"addressLine1": "58 Springfield Road",
"addressLine2": null,
"country": "GB",
"city": "Saint Albans",
"postcode": "AL1 1AG"
},
"packages": [
{
"measureUnit": "CM",
"weightUnit": "Kilograms",
"weight": 1,
"contentWeight": 1,
"quantity": "1",
"length": "1",
"width": "1",
"height": "1"
}
],
"pickupDetails": {
"asap": false,
"pickupDate": "2022-09-27",
"pickupTimezone": "+10:00",
"pickupEarliestTime": "10:00"
}
} |
...
Response statuses
HTTP Code | Description |
|---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
...