Delivery Date Manager API Guide

Delivery Date Manager API

Info
We have created a public API collection for Delivery Date Manager module with all available queries and sample data, you can copy it to run local tests in your Magento environment. More details about using public collections can be found in the following FAQ post.

1. Amasty\DeliveryDateManager\Api\DeliveryGuestQuoteServiceInterface - class for managing delivery data from guest carts.
  1. GET /V1/guest-carts/:cartId/quote-address-id/:quoteAddressId/get-delivery-date, method="getFromQuoteAddressId" - get delivery date for a guest cart;
  2. POST /V1/guest-carts/:cartId/set-delivery-date, method="saveForQuoteAddress" - set delivery date for a guest cart; 
  3. POST /V1/guest-carts/:cartId/validate-delivery-date, method="validate" - validate delivery date for a guest cart.

2. Amasty\DeliveryDateManager\Api\DeliveryQuoteServiceInterface - class for managing delivery data from registered customers' carts.
  1. GET /V1/carts/mine/get-delivery-date, method="getFromQuoteAddressId" - get delivery date by cart ID;
  2. POST /V1/carts/mine/set-delivery-date, method="saveForQuoteAddress" - set delivery date for a cart by its ID;
  3. POST /V1/carts/mine/validate-delivery-date, method="validate" - validate delivery date for a cart.

      • Related Articles

      • How to change the format of the delivery date?

        Starting from version 2.11.0, the delivery date format on the frontend is displayed according to the selected store locale in Magento configurations: Stores → Configuration → General → General → Locale Options → Locale. For lower versions, the format ...

      • Cash on Delivery API

        Amasty\CashOnDelivery\Api\PaymentManagementInterface: POST /V1/cash_on_delivery/checkAvailable/:postalCode, method="checkAvailable" - check whether the Cash On Delivery payment method is available for a specific postcode.

      • What Amasty extensions support API?

        Each Amasty extension that has API support, includes the etc/webapi.xml file. The webapi.xml file contains API configurations with the list of available API requests. For example, a request from the Custom Form module interface: 1 - endpoint URL; 2 - ...

      • Can I test how your modules work with API?

        Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be ...

      • How to restrict Monday for orders placed on Friday after specific time period if delivery is available on business days only?

        With the Delivery Date Manager module, you can effectively manage delivery schedules by restricting selection for delivery dates. This might be crucial when your store requires at least one day to prepare orders placed before holidays. To prevent ...