Skip to main content

Schedule Delivery

Users can schedule deliveries for their products, choosing preferred dates and times for delivery.


Add Schedule Date

This API functionality enables users to facilitate delivery scheduling, they can add a schedule feature for product delivery within their applications.


Headers

JSON, which contains checkout order data, sends raw data in the request body. The server accepts JSON-formatted responses.



Parameters


No parameter required.



Attributes


disable_dates array of objects

date string

The date for the order schedule.


date_raw string

The date format.


max_pieces number

The amount of ordered products.


selected_pieces number

The amount of the selected ordered products.


description string

The description of the schedule date feature result.


alert null

It is optional.


available_dates empty string

It is optional.


max_date string

The maximal date for order when choosing the date.

POST /api/v2/delivery/get-schedule-date
curl --location 'https://appliance-api.com/api/v2/delivery/get-schedule-date' \
--header 'Accept: application/json' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data '{
"order_no": "bHFSMnFtTVlvckk5dC9XaEFJdlZ6cnBXdm5tbFB3L2JJL25zNGxyLzNFbz0=",
"zip_code": "63011",
"products": [
{
"detail_order_id": 92,
"id": 92,
"session_id": "bHFSMnFtTVlvckk5dC9XaEFJdlZ6cnBXdm5tbFB3L2JJL25zNGxyLzNFbz0=",
"order_no": "bHFSMnFtTVlvckk5dC9XaEFJdlZ6cnBXdm5tbFB3L2JJL25zNGxyLzNFbz0=",
"product_id": "583",
"product_name": "30-inch Top-Freezer Refrigerator with Glass Shelves",
"product_model": "ART318FFDW",
"sku": "ART318FFDW",
"brand_id": 2,
"brand_name": "Amana",
"quantity": 1,
"price": "666.00",
"saving": "0.00",
"original_price": "500.00",
"subtotal_price": "666.00",
"has_install": 0,
"has_warranty": 0,
"fulfillment_type": 3,
"delivery_option_id": 4,
"delivery_charge": null,
"is_schedule_later": 0,
"category_name": "Refrigeration",
"subcategory_name": "Refrigerators",
"detail_category_name": "Top Freezer Refrigerators",
"category_slug": "refrigeration",
"subcategory_slug": "refrigerators",
"detail_category_slug": "top-freezer-refrigerators",
"created_at": "2023-10-30 03:58:32",
"updated_at": "2023-10-30 03:58:32",
"installs": [],
"install": [],
"warranty": [],
"fulfillment_type_name": "Local Delivery & Install",
"delivery_option_name": null,
"image": "https://kitchenaid-h.assetsadobe.com/is/image/content/dam/global/amana/refrigeration/refrigerator/images/hero-ART318FFDW.tif?wid=900&hei=900",
"brand_image": "https://d5cl03pt63mvv.cloudfront.net/assets/brands/logo-amana-2.png",
"color": "White",
"is_in_stock": 1,
"in_stock": true,
"in_active_status": false,
"estimate_availability": "Thu, Nov 02",
"estimate_availability_desc": "As soon as",
"installation_availability": null,
"pickup_time": "today",
"delivery_date": null
}
]
}'
{
"disable_dates": [
{
"date": "Tue Nov 21 2023",
"date_raw": "2023-11-21",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Nov 22 2023",
"date_raw": "2023-11-22",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Nov 23 2023",
"date_raw": "2023-11-23",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Nov 24 2023",
"date_raw": "2023-11-24",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Nov 25 2023",
"date_raw": "2023-11-25",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Nov 26 2023",
"date_raw": "2023-11-26",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Nov 27 2023",
"date_raw": "2023-11-27",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Nov 28 2023",
"date_raw": "2023-11-28",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Nov 29 2023",
"date_raw": "2023-11-29",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Nov 30 2023",
"date_raw": "2023-11-30",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Dec 01 2023",
"date_raw": "2023-12-01",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Dec 02 2023",
"date_raw": "2023-12-02",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Dec 03 2023",
"date_raw": "2023-12-03",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Dec 04 2023",
"date_raw": "2023-12-04",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Dec 05 2023",
"date_raw": "2023-12-05",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Dec 06 2023",
"date_raw": "2023-12-06",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Dec 07 2023",
"date_raw": "2023-12-07",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Dec 08 2023",
"date_raw": "2023-12-08",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Dec 09 2023",
"date_raw": "2023-12-09",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Dec 10 2023",
"date_raw": "2023-12-10",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Dec 11 2023",
"date_raw": "2023-12-11",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Dec 12 2023",
"date_raw": "2023-12-12",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Dec 13 2023",
"date_raw": "2023-12-13",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Dec 14 2023",
"date_raw": "2023-12-14",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Dec 15 2023",
"date_raw": "2023-12-15",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Dec 16 2023",
"date_raw": "2023-12-16",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Dec 17 2023",
"date_raw": "2023-12-17",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Dec 18 2023",
"date_raw": "2023-12-18",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Dec 19 2023",
"date_raw": "2023-12-19",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Dec 20 2023",
"date_raw": "2023-12-20",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Dec 21 2023",
"date_raw": "2023-12-21",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Dec 22 2023",
"date_raw": "2023-12-22",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Dec 23 2023",
"date_raw": "2023-12-23",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Dec 24 2023",
"date_raw": "2023-12-24",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Dec 25 2023",
"date_raw": "2023-12-25",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Dec 26 2023",
"date_raw": "2023-12-26",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Dec 27 2023",
"date_raw": "2023-12-27",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Dec 28 2023",
"date_raw": "2023-12-28",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Dec 29 2023",
"date_raw": "2023-12-29",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Dec 30 2023",
"date_raw": "2023-12-30",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Dec 31 2023",
"date_raw": "2023-12-31",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Jan 01 2024",
"date_raw": "2024-01-01",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Jan 02 2024",
"date_raw": "2024-01-02",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Jan 03 2024",
"date_raw": "2024-01-03",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Jan 04 2024",
"date_raw": "2024-01-04",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Jan 05 2024",
"date_raw": "2024-01-05",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Jan 06 2024",
"date_raw": "2024-01-06",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Jan 07 2024",
"date_raw": "2024-01-07",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Jan 08 2024",
"date_raw": "2024-01-08",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Jan 09 2024",
"date_raw": "2024-01-09",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Jan 10 2024",
"date_raw": "2024-01-10",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Jan 11 2024",
"date_raw": "2024-01-11",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Jan 12 2024",
"date_raw": "2024-01-12",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Jan 13 2024",
"date_raw": "2024-01-13",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Jan 14 2024",
"date_raw": "2024-01-14",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Jan 15 2024",
"date_raw": "2024-01-15",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Jan 16 2024",
"date_raw": "2024-01-16",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Jan 17 2024",
"date_raw": "2024-01-17",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Jan 18 2024",
"date_raw": "2024-01-18",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Jan 19 2024",
"date_raw": "2024-01-19",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Jan 20 2024",
"date_raw": "2024-01-20",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Jan 21 2024",
"date_raw": "2024-01-21",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Jan 22 2024",
"date_raw": "2024-01-22",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Jan 23 2024",
"date_raw": "2024-01-23",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Jan 24 2024",
"date_raw": "2024-01-24",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Jan 25 2024",
"date_raw": "2024-01-25",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Jan 26 2024",
"date_raw": "2024-01-26",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Jan 27 2024",
"date_raw": "2024-01-27",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Jan 28 2024",
"date_raw": "2024-01-28",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Jan 29 2024",
"date_raw": "2024-01-29",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Jan 30 2024",
"date_raw": "2024-01-30",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Jan 31 2024",
"date_raw": "2024-01-31",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Feb 01 2024",
"date_raw": "2024-02-01",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Feb 02 2024",
"date_raw": "2024-02-02",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Feb 03 2024",
"date_raw": "2024-02-03",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Feb 04 2024",
"date_raw": "2024-02-04",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Feb 05 2024",
"date_raw": "2024-02-05",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Feb 06 2024",
"date_raw": "2024-02-06",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Feb 07 2024",
"date_raw": "2024-02-07",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Feb 08 2024",
"date_raw": "2024-02-08",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Feb 09 2024",
"date_raw": "2024-02-09",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Feb 10 2024",
"date_raw": "2024-02-10",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Feb 11 2024",
"date_raw": "2024-02-11",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Mon Feb 12 2024",
"date_raw": "2024-02-12",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Tue Feb 13 2024",
"date_raw": "2024-02-13",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Wed Feb 14 2024",
"date_raw": "2024-02-14",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Thu Feb 15 2024",
"date_raw": "2024-02-15",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Fri Feb 16 2024",
"date_raw": "2024-02-16",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sat Feb 17 2024",
"date_raw": "2024-02-17",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
},
{
"date": "Sun Feb 18 2024",
"date_raw": "2024-02-18",
"max_pieces": 0,
"selected_pieces": 1,
"description": "unavailable_method",
"alert": null
}
],
"available_dates": [],
"max_date": "2023-11-21"
}