Store Pickup API Overview

Store Pickup API

1. Amasty\StorePickup\Api\GuestShippingMethodManagementInterface - class for managing shipping methods on guest checkout:
  1. POST /V1/guest-carts/:cartId/estimate-shipping-methods, method="estimateByExtendedAddress" - displays available shipping methods to guest users.

2. Amasty\StorePickup\Api\ShippingMethodManagementInterface - class for managing shipping methods on checkout for registered users:
  1. POST /V1/carts/mine/estimate-shipping-methods-by-address-id, method="estimateByAddressId" - display available shipping methods to logged-in users based on their shipping address (from the address book).

3. Amasty\StorePickup\Api\ShipmentEstimationInterface - class for displaying shipping methods for registered users:
  1. POST /V1/carts/mine/estimate-shipping-methods, method="estimateByExtendedAddress" - display available shipping methods to logged-in users based on their shipping address (just entered on checkout).

      • Related Articles

      • Store Pickup with Locator API

        We have created a public API collection for Store Pickup with Locator module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using ...

      • 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 ...

      • Store Credit & Refund API

        We have created a public API collection for Store Credit & Refund module with all available queries and sample data that you can both test via our demo endpoints and copy to run local tests in your Magento environment. More details about using public ...

      • Shipping address is not replaced by the store one when using the Store Pickup module. Is it expected?

        The Store Pickup extension enables you to add multiple pickup points (points of sale) to your store. On the storefront, the extension automatically detects the closest available store based on the customer's entered address and offers the option to ...