Delivery Windows

Manage delivery windows

Deprecated

Retrieving delivery windows by delivery area

get

Retrieves delivery windows for the specified delivery area and cart.

Note: You can filter out delivery windows before the store's cutoff time using the afterCutOffTime query parameter.

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]+$

deliveryAreaIdstringRequired

Delivery area’s unique identifier.

cartIdstringRequired

Customer cart’s unique identifier generated when a cart is created through the Cart Service.

Query parameters

siteCodestringOptional

Store’s site code. The default site code is main.

afterCutOffTimebooleanOptional

If set to true, only the delivery windows available after taking the store’s cutoff time into account are retrieved.

Default: false

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

get

/shipping/{tenant}/areaDeliveryTimes/{deliveryAreaId}/{cartId}

HTTPcURLJavaScriptPython

GET /shipping/{tenant}/areaDeliveryTimes/{deliveryAreaId}/{cartId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "1234567890abcdef123abc0",
    "deliveryDate": "2015-06-20T12:00:00.000Z",
    "deliveryTimeRange": {
      "startTime": "15:00",
      "endTime": "23:00"
    },
    "deliveryMethod": "method1",
    "cutOffTime": "10:00",
    "slotId": "1234567890abcdef123abgi"
  },
  {
    "id": "1234567890abcdef123abc1",
    "deliveryDate": "2015-06-24T12:00:00.000Z",
    "deliveryTimeRange": {
      "startTime": "12:00",
      "endTime": "16:00"
    },
    "deliveryMethod": "method1",
    "cutOffTime": "11:00",
    "slotId": "1234567890abcdef123abgh"
  }
]

Retrieving delivery windows by cart

get

Retrieves actual delivery windows for the specified cart.

NOTE: In order to properly retrieve delivery windows, the cart must have countryCode and zipCode specified.

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]+$

cartIdstringRequired

Customer cart’s unique identifier generated when a cart is created through the Cart Service.

Query parameters

postalCodestringOptional

If provided, the endpoint searches for delivery windows using this postal code (zip code) instead of the one from the cart.

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

get

/shipping/{tenant}/actualDeliveryWindows/{cartId}

HTTPcURLJavaScriptPython

GET /shipping/{tenant}/actualDeliveryWindows/{cartId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "id": "1234567890abcdef123abc0",
    "deliveryDate": "2015-06-20T12:00:00.000Z",
    "deliveryTimeRange": {
      "startTime": "15:00",
      "endTime": "23:00"
    },
    "deliveryMethod": "method1",
    "cutOffTime": "2015-06-20T11:00:00.000Z",
    "slotId": "1234567890abcdef123abgh",
    "deliveryCycle": "2015-06-20-11"
  },
  {
    "id": "1234567890abcdef123abc1",
    "deliveryDate": "2015-06-24T12:00:00.000Z",
    "deliveryTimeRange": {
      "startTime": "12:00",
      "endTime": "16:00"
    },
    "deliveryMethod": "method1",
    "cutOffTime": "2015-06-20T10:00:00.000Z",
    "slotId": "1234567890abcdef123abgi",
    "deliveryCycle": "2015-06-24-10"
  }
]

Increasing the delivery window counter

post

Increases the number of orders in the delivery window counter if there is any capacity available.

NOTE

The delivery window counter increases automatically when the Emporix Checkout Service is utilized. This particular endpoint should only be utilized if there is a Custom Checkout Service implementation.

In case of any validation problem, the below errorCodes can be returned:

• VALIDATION-DELIVERY-WINDOW-400001: Lack of required slotId property in the request

• VALIDATION-DELIVERY-WINDOW-400002: Date is not in correct format

• VALIDATION-DELIVERY-WINDOW-400003: Delivery window is fully booked or does not exist for given date

• VALIDATION-DELIVERY-WINDOW-400004: Lack of required zoneId property in the request

• VALIDATION-DELIVERY-WINDOW-500001: Internal problem with the service

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]+$

Body

application/jsonapplication/xml

deliveryWindowIdstringRequired

The selected delivery window

deliveryDatestringRequired

The selected delivery date

slotIdstringOptional

The slot that was selected for the delivery.

Responses

200

OK

application/json

400

DeliveryDate is not valid!.

application/json

401

Unauthorized

application/json

500

Some server side error occurred.

application/json

post

/shipping/{tenant}/actualDeliveryWindows/incrementCounter

HTTPcURLJavaScriptPython

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

{
  "deliveryWindowId": "text",
  "deliveryDate": "text",
  "slotId": "text"
}

application/jsonapplication/xml

true

Validating a delivery window

post

Validates the specified delivery window.

---

NOTE

The delivery window is validated automatically when the Emporix Checkout Service is utilized. This particular endpoint should only be utilized if there is a Custom Checkout Service implementation.

In case of any validation problem, the below errorCodes can be returned:

• VALIDATION-DELIVERY-WINDOW-400001: Lack of required slotId property in the request

• VALIDATION-DELIVERY-WINDOW-400002: Date is not in correct format

• VALIDATION-DELIVERY-WINDOW-400003: Delivery window is fully booked or does not exist for given date

• VALIDATION-DELIVERY-WINDOW-400004: Lack of required zoneId property in the request

• VALIDATION-DELIVERY-WINDOW-500001: Internal problem with the service

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]+$

Body

application/json

deliveryWindowIdstringRequired

The selected delivery window

deliveryDatestringRequired

The selected delivery date

slotIdstringOptional

The slot that was selected for the delivery.

Responses

200

Resource successfully validated.

application/json

400

DeliveryDate is not valid!.

application/json

401

Unauthorized

application/json

500

Some server side error occurred.

application/json

post

/shipping/{tenant}/deliveryWindowValidation

HTTPcURLJavaScriptPython

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

{
  "deliveryWindowId": "25",
  "deliveryDate": "2021-01-15T12:00:00.000Z",
  "slotId": "slot1"
}

true