Quotes

Retrieves basic information for all sales quotes in your store. Use the parameters to narrow your results, such as filtering by a date range or quotes from a specific Company account.

More detailed information, such as line items and shipping details, can be retrieved with the Get Quote Details endpoint.

Creates a new sales quote and automatically submits it to the assigned buyer.

While the B2B Edition control panel allows you to save a new quote as a draft without sending it to the buyer, quotes created with this endpoint are automatically visible in a Company user's Buyer Portal. However, you can give the allowCheckout a value of false to prevent the buyer from purchasing it immediately upon submission.

Custom Products

While you can create custom products from within a quote while creating or editing it in your B2B Edition control panel, you cannot create a custom product with this endpoint.

Create a custom product while creating or editing a quote in the B2B Edition control panel, or by using the Create a Product endpoint in the Catalog API. Obtain your newly-created product’s ID and add it to the productId field of the Create a Quote request body to include it in the quote.

Minimum Required Fields

In order to create a sales quote, the request body must include the following fields. Fields marked with an asterisk are only required under specific conditions.

• grandTotal
• discount
• subtotal
• userEmail
• expiredAt
• contactInfo
  • name
  • email
• companyId*
• productList
  • sku
  • productId
  • basePrice
  • discount
  • offeredPrice
  • quantity
• extraFields fieldName fieldValue*
• channelId*

The companyId field is only required if you are linking a quote to a Company’s Buyer Portal. The companyName field and email fields will not link a quote to a particular Company or Company user without a corresponding companyId.

The extraFields array is only required if you have created Quote extra fields which are marked as required. To learn more about extra fields, see B2B Edition Settings (Help Center).

The channelId field is required if you have multiple storefront channels. If you only have a single storefront, then you do not need to include it.

Sends an email to the buyer with information on a specific quote based on the provided quoteId.

The email address in the email field must correspond with the buyer’s email address on the quote. However, you can use the ccTo field to include additional recipients.

Quote Email Templates

The request uses the emailTemplate field to format the quote contents with one of the pre-built quote email templates. You must enter the exact name of the template in the field.

The following email templates can be used:

• Simple
• Simple with Pictures
• Waves with Pictures
• Database with checkout button
• Modern with checkout link
• Modern without checkout link

The selected template applies to the quote PDF if withAttach is specified as true.

Returns a list of available extra fields configs for sales quotes.

We recommend caching the response results to avoid frequent API requests.

Retrieves the full details of a specific quote based on the provided quote_id.

This endpoint provides more detailed information about a specific quote than Get All Quotes. This includes line items, shipping address fields, and even a history of messages sent by the buyer and their sales representative.

Updates an existing quote based on the details provided in the request body.

Before using this endpoint to update a quote, review the following considerations:

• None of the fields in the body are required for a successful response. This means that you can use this endpoint to update a single field or a subset of fields.
• When adding or updating line items, you must include all existing line items that you want to keep in the quote. Omitting existing line items from a quote will remove them from the quote when you send the request.
• If you add products or change discounts, you must also update the grandTotal and subtotal fields to reflect the new totals.
• You cannot use this endpoint to change the sales rep or Company account assigned to an existing quote.
• To update a quote’s shipping rate, use the Select a Shipping Rate for a Quote endpoint.

See Create a Quote for experience- and setting-specific requirements related to adding custom shipping or non-purchasable products to a quote.

Permanently deletes a specific quote based on the provided quote_id.

If you want to hide a quote from a buyer without deleting it, you can archive the quote from the Quotes area of your B2B Edition control panel. See Managing Sales Quotes in B2B Edition (Help Center) for more information.

Generates a cart URL and a checkout URL for a specific quote based on the provided quote_id.

You can only generate cart and checkout URLs for quotes in one of the following statuses:

• New (0)
• In Process (2)
• Updated by Customer (3)

This endpoint will generate a checkout link for a quote even if it is configured to hide the checkout button on the Buyer Portal. You can use this to create an alternate checkout flow for your sales quotes.

Associates an existing BigCommerce order with a specific quote based on the provided quote_id.

In order to assign a quote to an order, it must be in one of the following statuses:

• New (0)
• In Process (2)
• Updated by Customer (3)

When specifying the order to be associated with the quote, use its BigCommerce Order ID, not the B2B Edition Order ID.

This endpoint does not convert an unpurchased quote into a new BigCommerce order. You can manually convert a quote while editing it in your B2B Edition control panel.

Creates a download link for a PDF with information on a specific quote based on the provided quoteId.

The PDF does not use one of the buyer-facing templates that can be selected for PDFs and emails. Instead, it uses a non-configurable template that also communicates backend information, like storefront channel and line item cost margins.

You can optionally update the currency information and also supply a custom exchange rate by using the currency array.

Adds a shipping method to a specific quote based on the provided quoteId.

Use the Get Available Shipping Rates for a Quote or Get All B2B Quote Custom Shipping Methods endpoints to retrieve shipping method information that you can add to the quote.

The request body must include either the shippingMethodId field to add a static or real-time shipping method, or the customShippingMethodName and the customShippingMethodCost fields to add a custom shipping method.

Note that the URL for this endpoint is https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rate, which is different from the URL for the Get Available Shipping Rates for a Quote endpoint (https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rates). Using the incorrect URL will result in a 405 - Method Not Allowed error.

Removes the current shipping method associated with a specific quote based on the provided quoteId.

Note that the URL for this endpoint is https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rate, which is different from the URL for the Get Available Shipping Rates for a Quote endpoint (https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rates). Using the incorrect URL will result in a 405 - Method Not Allowed error.

Retrieves all shipping rates available to a specific quote based on the provided quoteId.

This endpoint only returns the static and real-time shipping methods available to a quote based on its product specifications and shipping address. Use the Get All B2B Quote Custom Shipping Methods endpoint to retrieve information on custom shipping methods.

Note that the URL for this endpoint is https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rates, which is different from the URL for the Select a Shipping Rate for a Quote and Remove Selected Shipping Rate from a Quote endpoints (https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rate). Using the incorrect URL will result in a 405 - Method Not Allowed error.