Shipping Zones
Was this helpful?
Was this helpful?
Manage shipping zones
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Shipping zone's unique identifier.
true, only active methods are included.false, only inactive methods are included.methods,feesThe Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. It can be a priority list working as a fallback mechanism. If the Accept-Language header is empty, all languages for localized fields are returned in a map format where the key is language code and the value is a translation.
fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7GET /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "zone1",
"name": "Zone 1",
"shipTo": [
{
"country": "DE",
"postalCode": "70190"
}
],
"default": true
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Shipping zone's unique identifier.
DELETE /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
true, only active methods are included.false, only inactive methods are included.methods,feesThe Accept-Language request HTTP header defines which languages the client is able to understand, and which locale variant is preferred. It can be a priority list working as a fallback mechanism. If the Accept-Language header is empty, all languages for localized fields are returned in a map format where the key is language code and the value is a translation.
fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7GET /shipping/{tenant}/{site}/zones HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "zone1",
"name": "Zone 1",
"shipTo": [
{
"country": "DE",
"postalCode": "70190"
}
],
"default": true
},
{
"id": "zone2",
"name": "Zone 2",
"shipTo": [
{
"country": "DE",
"postalCode": "70192"
}
],
"default": false
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.
frThe zone is an area where shipments can be delivered.
Delivery zone's unique identifier.
Flag indicating whether the zone is the default delivery zone for the site.
String value in the specified language.
FedEx 2DayPOST /shipping/{tenant}/{site}/zones HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"shipTo": [
{
"country": "DE",
"postalCode": "70190"
}
],
"name": "Zone 1",
"id": "zone1",
"default": true
}{
"id": "zone1"
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Shipping zone's unique identifier.
The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.
frThe zone is an area where shipments can be delivered.
Delivery zone's unique identifier.
Flag indicating whether the zone is the default delivery zone for the site.
String value in the specified language.
FedEx 2DayPUT /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"shipTo": [
{
"country": "DE",
"postalCode": "70190"
}
],
"name": "Zone 1",
"id": "zone1",
"default": true
}No content
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Shipping zone's unique identifier.
The Content-Language request HTTP header defines language of the payload. When the Content-Language header is empty, all localized fields in a payload should be in a map format, where the key is a language code and the value is a translation.
frThe zone is an area where shipments can be delivered.
Delivery zone's unique identifier.
Flag indicating whether the zone is the default delivery zone for the site.
String value in the specified language.
FedEx 2DayPATCH /shipping/{tenant}/{site}/zones/{zoneId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 94
{
"shipTo": [
{
"country": "DE",
"postalCode": "70190"
}
],
"name": "Zone 1",
"id": "zone1",
"default": true
}No content