Request a Quote API Guide

Request a Quote API

InfoWe have created a public API collection for Request a Quote with sample queries and 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\RequestQuote\Api\RemarkServiceInterface:
  1. PUT /V1/amasty_quote/updateRemark, method="save" - add information to the Remark field.

2. Amasty\RequestQuote\Api\QuoteRepositoryInterface - class for managing quotes:
  1. PUT /V1/amasty_quote/approve/:quoteId, method="approve" - approve a quote;
  2. PUT /V1/amasty_quote/expire/:quoteId, method="expire" - mark a quote as expired;
  3. GET /V1/amasty_quote/search, method="getRequestsList" - get a list of all requests;
  4. PUT /V1/amasty_quote/quote/note/customer:quoteId, method="addCustomerNote" - add customer comment to the quote;
  5. PUT /V1/amasty_quote/quote/note/admin:quoteId, method="addAdminNote" - add admin comment to the quote.

3. Amasty\RequestQuote\Api\QuoteItemRepositoryInterface - class for managing quote items:
  1. PUT /V1/amasty_quote/quote_item/note/customer:quoteId, method="addCustomerNote" - add customer comment to a quote item;
  2. PUT /V1/amasty_quote/quote_item/note/admin:quoteId, method="addAdminNote" - add admin comment to a quote item;
  3. GET /V1/quote-carts/:quoteId/items, method="getList" - get list of quote items;
  4. POST /V1/quote-carts/:quoteId/items, method="save" - save quote items;
  5. DELETE /V1/quote-carts/:quoteId/items/:itemId, method="deleteById" - delete items from the quote cart;
  6. GET /V1/quote-carts/mine/items, method="getList" - get list of my quote cart items.

4. Amasty\RequestQuote\Api\QuoteManagementInterface - class for managing quote carts:
  1. POST /V1/quote-carts, method="createEmptyQuoteCart" - create an empty quote cart;
  2. POST /V1/customers/:customerId/quote-carts, method="createEmptyQuoteCartForCustomer" - create an empty quote cart by customer ID;
  3. PUT /V1/quote-carts/:quoteId, method="assignCustomer" - assign a customer to a quote;
  4. POST /V1/quote-carts/mine, method="createEmptyQuoteCartForCustomer" - create an empty quote cart;
  5. GET /V1/quote-carts/mine, method="getQuoteCartForCustomer" - get info about a quote cart;
  6. POST /V1/quote-carts/:quoteId/in-cart, method="moveInCart" - move items to cart;
  7. POST /V1/quote-carts/mine/in-quote, method="moveInQuote" - move items to quote cart;
  8. PUT /V1/quote-carts/mine/update-customer-note, method="updateCustomerNote" - edit customer quote cart note;
  9. DELETE /V1/quote-carts/mine/clear, method="clear" - clear quote cart.

5. Amasty\RequestQuote\Api\QuoteItemManagementInterface
  1. POST /V1/quote-carts/mine/items, method="save" - save items in my quote cart;
  2. PUT /V1/quote-carts/mine/items/:itemId, method="save" - save an item in my quote cart.

6. Amasty\RequestQuote\Api\QuoteServiceInterface:
  1. PUT V1/quote-carts/:quoteId/cancel, method="cancelQuote" - cancel a quote request;
  2. PUT /V1/quote-carts/mine/submit, method="submit" - submit my quote request.

7. Amasty\RequestQuote\Api\CartManagementInterface
  1. DELETE /V1/quote-carts/mine/remove-from-cart, method="removeQuoteFromCart" - remove quote from my cart.

8. Amasty\RequestQuote\Api\GuestQuoteManagementInterface
  1. POST /V1/guest-quote-carts, method="createEmptyQuoteCart" - create an empty quote cart for a guest customer;
  2. GET /V1/guest-quote-carts/:quoteMaskId, method="get" - get info about a guest quote cart;
  3. POST /V1/guest-quote-carts/:cartMaskId/in-quote/:quoteMaskId, method="moveInQuote" - move quest cart to quote;
  4. PUT /V1/guest-quote-carts/:quoteMaskId, method="assignCustomer" - assign a customer to a quest cart;
  5. PUT /V1/guest-quote-carts/:quoteMaskId/update-customer-info, method="updateCustomerNote" - update quest customer info in quote;
  6. DELETE /V1/guest-quote-carts/:quoteMaskId/clear, method="clear" - clear guest quote;
  7. PUT /V1/guest-quote-carts/:quoteMaskId/submit, method="submit" - submit guest quote cart.

9. Amasty\RequestQuote\Api\GuestQuoteItemRepositoryInterface
  1. GET /V1/guest-quote-carts/:quoteMaskId/items, method="getList" - get list of items in a quest quote cart;
  2. POST /V1/guest-quote-carts/:quoteMaskId/items, method="save" - save guest quote cart items;
  3. DELETE /V1/guest-quote-carts/:quoteMaskId/items/:itemId, method="deleteById" - delete an item from guest quote cart.

10. Amasty\RequestQuote\Api\GuestQuoteItemManagementInterface
  1. PUT /V1/guest-quote-carts/:quoteMaskId/items/:itemId, method="save" - save an item in guest quote cart.

11. Amasty\RequestQuote\Api\AccountManagementInterface
  1. GET /V1/amasty_quote/isEmailAvailable/:customerEmail, method="isEmailAvailable" - get info about customer email notification.
​
12. Amasty\RequestQuote\Api\ShippingInformationManagementInterface
  1. - POST /V1/quote-carts/:quoteId/shipping-information, method = "saveAddressInformation" - add shipping information to quote.
Info
In the API request to add shipping information to the quote, it is now possible specify Custom shipping method and Custom Fee.

      • Related Articles

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

      • Order Attributes API

        We have created a public API collection for Order Attributes 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 ...

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

      • Request a Quote | GraphQL methods

        Queries isQuoteCartEnabled description: check if request a quote is enabled. Includes check for customer group quoteCart (cartId: String!) description: return information about the specified shopping cart customerQuoteCart description: return ...

      • Payments with Stripe API

        1. Amasty\Stripe\Api\Quote\ApplePayGuestShippingMethodManagementInterface - class for managing shipping methods for guest users: POST /V1/guest-carts/:cartId/estimate-shipping-methods-apple-pay, method="estimateByExtendedAddress" - display the list ...