One Step Checkout API Overview

One Step Checkout API

Info
We have created public API collections for One Step Checkout module, as well its One Step Checkout Delivery Date and One Step Checkout Gift Wrap submodules, 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 collections can be found in the following FAQ post.

1. Amasty\Checkout\Api\AdditionalFieldsManagementInterface - class for managing additional fields for logged-in users:
  1. POST /V1/amasty_checkout/carts/:cartId/amcheckoutFields, method="save" - save a field for a specific cart by ID;
  2. POST /V1/amasty_checkout/carts/mine/amcheckoutFields, method="save" - save a field for the current cart.

2. Amasty\Checkout\Api\GuestAdditionalFieldsManagementInterface - class for managing additional fields for guests:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/amcheckoutFields, method="save" - save a field for a guest cart.

3. Amasty\Checkout\Api\GiftMessageInformationManagementInterface - class for managing gift messages for logged-in users:
  1. POST /V1/amasty_checkout/carts/:cartId/gift-message, method="update" - save a gift message for a specific cart by ID;
  2. POST /V1/amasty_checkout/carts/mine/gift-message, method="update" - save a gift message in the current cart.

4. Amasty\Checkout\Api\GuestGiftMessageInformationManagementInterface - class for managing gift messages for guest users:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/gift-message, method="update" - save a gift message in a guest cart. 

5. Amasty\Checkout\Api\GiftWrapInformationManagementInterface - class for managing gift wrap for registered users:
  1. POST /V1/amasty_checkout/carts/:cartId/gift-wrap, method="update" - save a gift wrap in a specific cart by ID;
  2. POST /V1/amasty_checkout/carts/mine/gift-wrap, method="update" - save a gift wrap in the current cart.

6. Amasty\Checkout\Api\GuestGiftWrapInformationManagementInterface - class for managing gift wraps for guests:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/gift-wrap, method="update" - save a gift wrap in a guest cart.

7. Amasty\Checkout\Api\DeliveryInformationManagementInterface - class responsible for delivery date for logged-in customers:
  1. POST /V1/amasty_checkout/carts/:cartId/delivery, method="update" - save delivery date in a specific cart by ID;
  2. POST /V1/amasty_checkout/carts/mine/delivery, method="update" - save delivery date in the current cart.

8. Amasty\Checkout\Api\GuestDeliveryInformationManagementInterface - managing delivery date for guest users:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/delivery, method="update" - save delivery date in a guest cart.

9. Amasty\Checkout\Api\ItemManagementInterface - class for managing products in carts of logged-in users:
  1. POST /V1/amasty_checkout/carts/:cartId/remove-item, method="remove" - remove a product from a specific cart by ID;
  2. POST /V1/amasty_checkout/carts/mine/remove-item, method="remove" - remove a product from the current cart;
  3. POST /V1/amasty_checkout/carts/:cartId/update-item, method="update" - edit a product in a specific cart by ID;
  4. POST /V1/amasty_checkout/carts/mine/update-item, method="update" - edit a product in the current cart.

10. Amasty\Checkout\Api\GuestItemManagementInterface - class for managing products in guest carts:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/remove-item, method="remove" - remove a product from a guest cart;
  2. POST /V1/amasty_checkout/guest-carts/:cartId/update-item, method="update" - edit a product in a guest cart.

11. Amasty\Checkout\Api\AccountManagementInterface - class for managing customer account information:
  1. POST /V1/amasty_checkout/guest-carts/:cartId/save-password, method="savePassword" - create a guest account on checkount and save a password.

12. Amasty\Checkout\Api\GuestQuoteManagementInterface - class for managing guest quotes:
  1. POST /V1/checkout/:cartId/saveInsertedInfo, method="saveInsertedInfo" - save a quote for a guest by its ID.

13. Amasty\Checkout\Api\QuoteManagementInterface - class for managing quotes of logged-in users:
  1. POST /V1/checkout/saveInsertedInfo, method="saveInsertedInfo" - save the current quote of a registered customer.

14. Amasty\Checkout\Api\MergeJsInterface - class for managing JS bunling:
  1. POST /V1/amasty_checkout/js/create-bundle, method="createBundle" - create JS bundling for specific files.

      • Related Articles

      • What features are included in each tariff plan of One Step Checkout?

        LITE One Step Checkout extension - all checkout sections on one page; - customizable design (layout, color scheme, address formatting, default values); - customer Geo IP location detect; - easy checkout fields management; - Stripe Card Element ...

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

      • What payment methods are compatible with One Step Checkout?

        The One Step Checkout module is compatible with some payment methods by default: PayPal Amazon Pay Braintree Klarna Stripe Some payment methods require additional compatibility modules to be installed. To access this functionality, you need to have ...

      • One Step Checkout | GraphQL methods

        Queries getAdditionalFields (cartId: String!) description: get information about additional fields getDefaultIpData description: get information about default IP address getAvailableShippingMethods (cartId: String!) description: get the information ...