Shipping Cost

Manage shipping costs

Calculating the final shipping cost

post

The endpoint will return shipping methods, which contain the matching fee for all zones.

Required scopes

No specific scopes are required.

Authorizations

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Body

Example of payload for shipping cost calculation.

customerIdstringOptional

Customer's unique identifier.

Responses

200

Shipping costs calculated.

application/json

400

Request syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Unauthorized

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

post

HTTPcURLJavaScriptPython

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"
        }
      }
    ]
  }
]

Calculating the minimum shipping cost

post

Retrieves the minimum shipping cost.

---

Required scopes

No specific scopes are required.

Authorizations

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Body

Example of payload for shipping cost calculation.

customerIdstringOptional

Customer's unique identifier.

Responses

200

Shipping costs calculated.

application/json

400

Request syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Unauthorized

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

post

HTTPcURLJavaScriptPython

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"
  }
}

Calculating the shipping cost for a given slot

post

Retrieves the minimum slot shipping cost.

---

Required scopes

No specific scopes are required.

Authorizations

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant's name.

Note: The tenant should always be written in lowercase.

Pattern: ^[a-z][a-z0-9]+$

sitestringRequired

Site’s unique identifier. A site is a specific shop.

If the tenant owns only one shop, the value should be set to main.

Body

Example of payload for shipping cost calculation.

customerIdstringOptional

Customer's unique identifier.

slotIdstringRequired

The slotId for which the quote should be calculated

deliveryWindowIdstringRequired

The delivery window id for which the slot with selected shipping method exists

Responses

200

Shipping costs calculated.

application/json

400

Request syntactically incorrect. Any details will be provided within the response payload.

application/json

401

Unauthorized

application/json

404

The requested resource does not exist.

application/json

500

Some server side error occurred.

application/json

post

HTTPcURLJavaScriptPython

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"
  }
}