Shipping Cost
Manage shipping costs
The endpoint returns shipping methods, which contain the matching fee for all zones.
- : Needed to manage shipping settings.
- : Needed to read shipping settings.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Example of payload for shipping cost calculation.
Customer unique identifier.
Shipping costs calculated.
Request syntactically incorrect. Details of the error are included in the response payload.
Unauthorized
The requested resource does not exist.
Some server side error occurred.
POST /shipping/{tenant}/{site}/quote HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419
{
"customerId": "C001",
"cartTotal": {
"amount": 100.34,
"currency": "USD"
},
"shipFromAddress": {
"street": "Patterson Fork Road",
"streetNumber": "2095",
"zipCode": "60606",
"city": "Chicago",
"country": "US",
"state": "IL"
},
"shipToAddress": {
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN"
}
}[
{
"zone": {
"id": "europe",
"name": {
"en": "Europe",
"de": "Europa"
}
},
"methods": [
{
"id": "fedex-2dayground",
"name": {
"en": "FedEx 2Day",
"de": "FedEx 2 Tage"
},
"fee": {
"amount": 4.99,
"currency": "EUR"
}
},
{
"id": "dhl",
"name": "DHL",
"fee": {
"amount": 2.99,
"currency": "EUR"
}
}
]
},
{
"zone": {
"id": "northamerica",
"name": {
"en": "North America",
"de": "Nord Amerika"
}
},
"methods": [
{
"id": "dhl-air",
"name": {
"en": "DHL Air",
"de": "DHL Flug"
},
"fee": {
"amount": 9.99,
"currency": "EUR"
}
},
{
"id": "dhl-normal",
"name": "DHL Normal",
"fee": {
"amount": 5.99,
"currency": "EUR"
}
}
]
}
]Retrieves the minimum shipping cost.
- : Needed to manage shipping settings.
- : Needed to read shipping settings.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Example of payload for shipping cost calculation.
Customer unique identifier.
Shipping costs calculated.
Request syntactically incorrect. Details of the error are included in the response payload.
Unauthorized
The requested resource does not exist.
Some server side error occurred.
POST /shipping/{tenant}/{site}/quote/minimum HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 419
{
"customerId": "C001",
"cartTotal": {
"amount": 100.34,
"currency": "USD"
},
"shipFromAddress": {
"street": "Patterson Fork Road",
"streetNumber": "2095",
"zipCode": "60606",
"city": "Chicago",
"country": "US",
"state": "IL"
},
"shipToAddress": {
"street": "Cheng Xiang Zhen Guan Tang Lu",
"streetNumber": "1031",
"extraLine1": "No. 2058",
"extraLine2": "Suzhou City",
"zipCode": "201202",
"city": "Taicang City",
"state": "Jiangsu Province",
"country": "CN"
}
}{
"fee": {
"amount": 4.99,
"currency": "EUR"
}
}Retrieves the minimum shipping cost related to a particular slot.
- : Needed to manage shipping settings.
- : Needed to read shipping settings.
Your Emporix tenant name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Example of payload for shipping cost calculation.
Customer unique identifier.
The `slotId`` which the quote should be calculated for.
The delivery window id which the slot with selected shipping method exists for.
Shipping costs calculated.
Request syntactically incorrect. Details of the error are included in the response payload.
Unauthorized
The requested resource does not exist.
Some server side error occurred.
POST /shipping/{tenant}/{site}/quote/slot HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109
{
"customerId": "C0012",
"cartTotal": {
"amount": 100.34,
"currency": "USD"
},
"deliveryWindowId": "123",
"slotId": "456"
}{
"fee": {
"amount": 4.99,
"currency": "EUR"
}
}Last updated
Was this helpful?