Sites

Find shipping related sites

Finding sites by postal code

post

Retrieves a list of sites with zones where the postal code matches the postalCode passed in the request body.

Authorizations

oAuth2

OAuth2clientCredentialsRequired

Token URL:

Available scopes:

• : Needed to manage shipping settings.
• : Needed to read shipping settings.

Path parameters

tenantstring · min: 3 · max: 16Required

Your Emporix tenant name.

Note: The tenant should always be written in lowercase.

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

Query parameters

windowsLimitnumberOptional

• The windowsLimit parameter is optional.
• The windowsLimit parameter determines the maximum amount of the nearest delivery windows that should be returned for each zone in retrieved sites.
• If you do not set the windowsLimit parameter, there will be no delivery window arrays in the response.
• If you set the windowsLimit parameter to 0, there will be empty delivery window arrays in the response.

Body

application/json

Payload with parameters for price finding.

postalCodestringRequired

Postal code containing numbers and/or letters.

countrystringOptional

ISO2 or ISO3 formatted country code.

Responses

200

Resource successfully retrieved.

application/json

400

Request syntactically incorrect. Details of the error are included in 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

/shipping/{tenant}/findSite

HTTPcURLJavaScriptPython

POST /shipping/{tenant}/findSite HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "postalCode": "70190",
  "country": "DE"
}

[
  {
    "id": "main",
    "zones": [
      {
        "id": "deliveryarea",
        "name": {
          "en": "Delivery area Mordor"
        },
        "shipTo": [
          {
            "country": "DE",
            "postalCode": "70190"
          }
        ],
        "methods": [
          {
            "id": "1-2_hours_timeframe",
            "name": {
              "en": "1-2_hours_timeframe",
              "de": "1-2 Stunden Lieferzeitfenster"
            },
            "maxOrderValue": {
              "amount": 1000,
              "currency": "EUR"
            },
            "active": true,
            "fees": [
              {
                "minOrderValue": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 40,
                  "currency": "EUR"
                }
              },
              {
                "minOrderValue": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "shippingGroupId": "group1"
              },
              {
                "minOrderValue": {
                  "amount": 50,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 12,
                  "currency": "EUR"
                },
                "shippingGroupId": "group2"
              }
            ],
            "shippingTaxCode": "HALF"
          },
          {
            "id": "3_hours_timeframe",
            "name": {
              "en": "3_hours_timeframe",
              "de": "3 Stunden Lieferzeitfenster"
            },
            "maxOrderValue": {
              "amount": 1000,
              "currency": "EUR"
            },
            "active": true,
            "fees": [
              {
                "minOrderValue": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 30,
                  "currency": "EUR"
                }
              },
              {
                "minOrderValue": {
                  "amount": 30,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 31,
                  "currency": "EUR"
                },
                "shippingGroupId": "group1"
              },
              {
                "minOrderValue": {
                  "amount": 50,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 32,
                  "currency": "EUR"
                },
                "shippingGroupId": "group2"
              }
            ],
            "shippingTaxCode": "HALF"
          },
          {
            "id": "4-more_hours_timeframe",
            "name": {
              "en": "4-more hours timeframe",
              "de": "4-mehr Stunden Lieferzeitfenster"
            },
            "maxOrderValue": {
              "amount": 2000,
              "currency": "EUR"
            },
            "active": true,
            "fees": [
              {
                "minOrderValue": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 20,
                  "currency": "EUR"
                }
              },
              {
                "minOrderValue": {
                  "amount": 30,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 41,
                  "currency": "EUR"
                },
                "shippingGroupId": "group1"
              },
              {
                "minOrderValue": {
                  "amount": 50,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 42,
                  "currency": "EUR"
                },
                "shippingGroupId": "group2"
              }
            ],
            "shippingTaxCode": "ZERO"
          },
          {
            "id": "pickup",
            "name": {
              "en": "pickup",
              "de": "pickup"
            },
            "maxOrderValue": {
              "amount": 1000,
              "currency": "EUR"
            },
            "active": true,
            "fees": [
              {
                "minOrderValue": {
                  "amount": 0,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 18,
                  "currency": "EUR"
                }
              },
              {
                "minOrderValue": {
                  "amount": 50,
                  "currency": "EUR"
                },
                "cost": {
                  "amount": 55,
                  "currency": "EUR"
                },
                "shippingGroupId": "group1"
              }
            ],
            "shippingTaxCode": "ZERO"
          }
        ],
        "actualDeliveryWindows": [
          {
            "id": "5b5572a71cf31a000f31eee6",
            "deliveryDate": "2020-12-08T12:00:00.000Z",
            "deliveryTimeRange": {
              "startTime": "15:00",
              "endTime": "22:00"
            },
            "zoneId": "deliveryarea",
            "deliveryMethod": "method1",
            "cutOffTime": "2020-12-08T11:00:00.000Z",
            "slotId": "1234567890abcdef123abgi",
            "deliveryCycle": "2020-12-08-11"
          },
          {
            "id": "5b5572a71cf31a000f31eee6",
            "deliveryDate": "2020-12-15T12:00:00.000Z",
            "deliveryTimeRange": {
              "startTime": "15:00",
              "endTime": "22:00"
            },
            "deliveryCycle": "2020-12-15-10",
            "zoneId": "deliveryarea",
            "deliveryMethod": "method1",
            "cutOffTime": "2020-12-15T10:00:00.000Z",
            "slotId": "1234567890abcdef123abgh"
          }
        ]
      }
    ],
    "metadata": {
      "createdAt": "2020-10-19T13:04:09.894Z",
      "modifiedAt": "2020-10-19T13:04:10.979Z",
      "version": 1
    }
  }
]