Attributes
JSON key/value pairs in the request body
POST | https://api.zonos.com/v1/shipment_rating
HEADER zonos-version: 2020-03-04
The header above is a required input for this rating request to complete successfully.
| Field | Notes |
|---|---|
currency REQUIRED | The base currency string, represented by a three-letter ISO code. |
items_amount REQUIRED | A decimal with an item amount. |
packages REQUIRED | A list of the number and dimensions for the packages being shipped. hash |
packages.id REQUIRED | The unique package identifier for the merchant or exporter. |
packages.dimensions REQUIRED | The dimensions for the package. hash |
packages.dimensions.height REQUIRED | A decimal for the height of the shipping box. |
packages.dimensions.length REQUIRED | A decimal for the length of the shipping box. |
packages.dimensions.unit REQUIRED | The unit of measurement for the shipping box dimensions. Possible values are inch centimeter millimeter null.When null, inch will be used. |
packages.dimensions.width REQUIRED | A decimal containing the width of the shipping box. |
packages.insured_amount OPTIONAL | A decimal with the insurance amount. |
packages.type OPTIONAL | A string to specify a specific carrier box type to be used for the shipping calculation. Possible values include FEDEX_BOX |
packages.weight REQUIRED | A decimal containing the weight of the package. |
packages.weight_unit REQUIRED | A string with the unit of measurement for the weight.Possible values are pound ounce kilogram null.When null, pound will be used. |
pickup_date REQUIRED | The requested pickup date for the package, in the ISO 8601 format YYYY-MM-DDTHH:mm:ss.sss+0000. UTC is assumed when no time zone information is passed. |
service_level OPTIONAL | The service_level with the carrier, e.g., standard. hash Common examples include: ups_express, ups_express_saver, ups_expedited, ups_economy, ups_standard, ups_mail_innovations_economy, ups_mail_innovations_priority, dhl_express, dhl_ecommerce_parcel_direct, fedex_priority, fedex_economy, usps_first_class_mail_international, usps_priority_mail_international, landmark_parcel, apc_parcel, point2point_standard, point2point_direct, point2point_packet, and fedex_international_groundSee the carrier docs for the full list of available service levels by carrier. |
ship_from REQUIRED | The origin address. hash |
ship_from.city | A string for the address city, town, district, suburb, or village of the origin address. |
ship_from.country REQUIRED | The origin country string, represented by a two-letter ISO code. |
ship_from.postal_code REQUIRED | A string for the origin address postal code. |
ship_from.state_code REQUIRED | A string for the origin address when available. Only required in Canada and Brazil. |
ship_to REQUIRED | The destination address. hash |
ship_to.city REQUIRED | A string for the address city, town, district, suburb, or village of the customer. |
ship_to.country REQUIRED | A string for the destination country, represented by a two-letter ISO code. |
ship_to.postal_code REQUIRED | A string for the destination postal code. Optional depending on the country of import. |
ship_to.state_code REQUIRED | A string for the destination state code when available. Only required in Canada and Brazil. |
ship_to.type REQUIRED | The type of the destination address. Possible values include residential commercial. |
Example request
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
{
"currency": "USD",
"items_amount": 168.99,
"packages": [
{
"id": "1",
"dimensions": {
"height": 19.0,
"length": 15.0,
"unit": "inch",
"width": 15.0
},
"insured_amount": 33.22,
"type": null,
"weight": 32.0,
"weight_unit": "pound"
}
],
"pickup_date": "2020-07-06T18:47:04.629+0000",
"service_level": null,
"ship_from": {
"city": "St George",
"country": "US",
"postal_code": "84770",
"state_code": "UT"
},
"ship_to": {
"city": "Campinas",
"country": "BR",
"postal_code": "75828-000",
"state_code": "SP",
"type": "residential"
}
}
Example response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
{
"id": "ship_5p67angIDnS91CyfpW55YZ",
"currency": {
"id": "curr_1Rp9lhXSRXvEWVs97k2PHE",
"base": "USD",
"date": "2020-02-04T18:47:04.629+0000",
"rates": []
},
"errors": [
{
"details": {
"id": "rtqt_7cz80Ny8dToSqoWlHTJJnP",
"service_level": "FEDEX_EXPRESS_SAVER",
"display_name": "FedEx Express Saver"
},
"message": "[868] Service is not allowed. ",
"type": "fedex_api"
}
],
"quotes": [
{
"id": "rtqt_4BUyxLEUeoU6zDdprCRoUV",
"amount_subtotal": 943.18,
"mode": {
"delivery_date_estimate": null,
"display_name": "UPS Expedited ",
"rates": [
{
"amount": 848.31,
"note": "UPS api: standard rate",
"type": "retail_shipping"
},
{
"amount": 64.4,
"note": "UPS api: fuel surcharge",
"type": "fuel_surcharge"
},
{
"amount": 40.0,
"note": "UPS api: extended area",
"type": "carrier_fee"
},
{
"amount": -9.53,
"note": "UPS negotiated discount",
"type": "negotiated_discount"
}
],
"service_level": "UPS_WORLDWIDE_EXPEDITED",
"transit_business_days": null,
"transit_days": null
},
"packages": [
{
"id": "1",
"weight": {
"billable": 32.0,
"dimensional": 30.7554,
"factor": 139,
"weight_unit": "pound"
}
}
],
"weight": {
"billable": 32.0,
"unit": "pound"
}
},
{
"id": "rtqt_1jyuPdiE5uIBcYzhO54DAb",
"amount_subtotal": 1058.86,
"weight": {
"billable": 32.0,
"unit": "pound"
},
"mode": {
"delivery_date_estimate": null,
"display_name": "UPS Saver ",
"rates": [
{
"amount": 957.26,
"note": "UPS api: standard rate",
"type": "retail_shipping"
},
{
"amount": 72.3,
"note": "UPS api: fuel surcharge",
"type": "fuel_surcharge"
},
{
"amount": 40.0,
"note": "UPS api: extended area",
"type": "carrier_fee"
},
{
"amount": -10.7,
"note": "UPS negotiated discount",
"type": "negotiated_discount"
}
],
"service_level": "UPS_SAVER",
"transit_business_days": null,
"transit_days": null
},
"packages": [
{
"id": "1",
"weight": {
"billable": 32.0,
"dimensional": 30.7554,
"factor": 139,
"weight_unit": "pound"
}
}
]
}
]
}
Request a shipment rating
Explore the key/value pairs in a shipment rating request.Request international shipping rates for various shipping providers that are configured in your store’s settings within Zonos.