Server to Server Management APIs
Quote

Quotes

B2B Edition sales quotes allow you to build tailored orders on behalf of your B2B buyers, B2C customers, and guest shoppers while also incorporating your business’s terms and conditions.

With sales quotes, you can make customizations that are not available for buyers on your storefront, such as:

  • Custom line item pricing and discounts, which can be optionally hidden from the recipient
  • Offering custom products, catalog-only items, or items that are currently out of stock for typical checkouts
  • Unique shipping methods for orders that require special considerations, such as LTL Freight
  • Expiration dates to ensure the quote is purchased in a given time period

The Quotes API provides a variety of endpoints for managing the different steps of the backend quoting process. You can create and update sales quotes, add shipping methods, generate cart and checkout URLs, and retrieve detailed information.

The Quotes API is also known as Request for Quote, and endpoint URLs are formatted as /rfq instead of /quotes.

Custom Shipping

B2B Edition supports the ability to supply custom shipping methods and rates on sales quotes. This is helpful for adding accurate shipping costs to quotes with shipping dimensions or destinations that may not be supported in your standard checkout.

Custom shipping can be enabled from Settings › Quotes in your B2B Edition control panel. This is required for the following endpoints:

See B2B Edition Settings (Help Center) (opens in a new tab) to learn more about enabling and configuring custom shipping methods.

Custom Items

Non-purchasable products are added to sales quotes as custom items.

A custom item is a one-time line item which uses the SKU and pricing of the selected product, but not the product’s ID. Note that the missing product ID can cause downstream issues if you have an external integration which uses the ID to sync information and events.

Custom items can be added to a quote via the Create a Quote and Update a Quote endpoints. In order to use custom items, your store must meet the following prerequisites:

  • Your store must use the Buyer Portal experience.
  • You must enable custom items from Settings › Quotes in your B2B Edition control panel.
  • Custom shipping must also be enabled in order to add shipping methods and rates to the quote.

To learn more about custom items and their considerations, see Order Management and Sales Representative Functions (Help Center) (opens in a new tab). For information on enabling custom items, see B2B Edition Settings (Help Center) (opens in a new tab).

Quote Statuses

Sales quotes have seven different statuses corresponding to the different parts of a quote’s life cycle.

Each status is assigned a numeric ID, which appears in the status field of the response body when using the Get All Quotes and Get Quote Details endpoints. You can also use a quote’s status as a parameter of the Get All Quotes endpoint in order to filter for quotes in a specific status.

See the table below for information on each quote status, as well as its corresponding status code.

Status NameDescriptionStatus ID
NewThe quote was created from the Buyer Portal and has not been processed yet.0
In ProcessThe quote was created by a member of your staff and submitted back to the buyer.2
Updated by customerThe buyer sent a message from the quote.3
OrderedThe quote was purchased from the storefront or manually converted into an order.4
ExpiredThe quote was not purchased before its expiration date.5
ArchivedThe quote is hidden from the Quotes area of the Buyer Portal and cannot be purchased.6
DraftThe quote was started by a member of your staff, but has not yet been submitted to the buyer.7
Did you find what you were looking for?