Delivery Windows
Was this helpful?
Was this helpful?
Manage delivery windows
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Delivery area’s unique identifier.
Customer cart’s unique identifier generated when a cart is created through the Cart Service.
Store’s site code. The default site code is main.
If set to true, only the delivery windows available after taking the store’s cutoff time into account are retrieved.
falseGET /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"
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Customer cart’s unique identifier generated when a cart is created through the Cart Service.
If provided, the endpoint searches for delivery windows using this postal code (zip code) instead of the one from the cart.
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"
}
]Increases the number of orders in the delivery window counter if there is any capacity available.
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
No specific scopes are required.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$The selected delivery window
The selected delivery date
The slot that was selected for the delivery
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"
}trueValidates the specified delivery window.
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
No specific scopes are required.
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$The selected delivery window
The selected delivery date
The slot that was selected for the delivery
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