Create Quote

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.

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](https://support.bigcommerce.com/s/article/B2B-Edition-Quotes) a quote in the B2B Edition control panel, or by using the [Create a Product](/developer/api-reference/rest/admin/catalog/products#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.

Authentication

X-Auth-Tokenstring

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Authentication header

Header	Argument	Description
`X-Store-Hash`	`store_hash`	The unique store hash associated with a BigCommerce store that has B2B Edition enabled.

### Authentication header | Header | Argument | Description | |:-------|:---------|:------------| | `X-Store-Hash` | `store_hash` | The unique store hash associated with a BigCommerce store that has B2B Edition enabled. |

Request

This endpoint expects an object.

productListlist of objectsRequired

totalAmountdoubleRequired

The total price of the quote after any discounts.

allowCheckoutbooleanOptional

Determines whether or not the buyer can take the quote to the checkout page. If left blank, the quote uses the checkout selection in your Quote settings.

channelIdintegerOptionalDefaults to 1

The storefront channel ID associated with the quote. This is required if your store has multiple storefront channels. Use 1 for your store’s default storefront channel.

companyIdintegerOptional

The unique identifier for the Company account associated with the quote. This field is required when creating a quote for a Company account.

contactInfoobjectOptional

currencyobjectOptional

discountdoubleOptional

The total value of discounts applied to the quote.

displayDiscountbooleanOptional

Determines if buyers can see quoted discount values in the Buyer Portal, or if they only see the quoted prices. If left blank, the quote uses the discount display selection in your Quote settings.

expiredAtstringOptional

The date when the buyer can no longer purchase the quote. Use ‘%m/%d/%Y’ format when entering the expiration date.

extraFieldsobjectOptional

grandTotaldoubleOptional

The quoted total after discounts, shipping, and tax are applied. If you are updating the line items or discounts on a quote, you must also update the grand total to reflect the new pricing.

legalTermsstringOptional

The quote’s terms and conditions. Use the newline character to separate each line of text. Omitting this field or leaving it blank does not add your store’s default terms and conditions to the quote. Instead, the quote will not display any terms.

messagestringOptional

A message sent to the buyer via the in-quote messaging system.

notesstringOptional

The quote’s buyer-facing notes. Use the newline character to separate each line of text.

quoteTitlestringOptional

The external title given to the quote.

referenceNumberstringOptional

An identifier for the quote that can be supplied by the sales rep or the buyer, such as a Purchase Order number.

shippingAddressobjectOptional

subtotaldoubleOptional

The quoted total after discounts and before shipping and tax. If you are updating the line items or discounts on a quote, you must also update the subtotal to reflect the new pricing.

userEmailstringOptionalformat: "email"

The email address of the quote’s sales rep. Any user email found within the B2B Edition System Users menu is considered a valid value for this field.

This field is optional. If left blank, it will default to the store owner’s email address as shown in the B2B Edition System Users menu.

Response

codedoubleDefaults to 200

HTTP Response Code

dataobject

messagestringDefaults to SUCCESS

metaobject

Errors

422

Unprocessable Entity Error

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

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.

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

1	import requests
2
3	url = "https://api-b2b.bigcommerce.com/api/v3/io/rfq"
4
5	payload = {
6	"productList": [
7	{
8	"options": [],
9	"sku": "SAN-PL",
10	"basePrice": 25,
11	"discount": 20,
12	"offeredPrice": 20,
13	"quantity": 50,
14	"productId": 54321,
15	"variantId": 12345,
16	"imageUrl": "https://mybcstore.com/sansiveria.jpg",
17	"orderQuantityMaximum": 0,
18	"orderQuantityMinimum": 0,
19	"productName": "Sansiveria Plant"
20	},
21	{
22	"options": [
23	{
24	"optionId": 1234,
25	"optionName": "Color",
26	"optionLabel": "Ocean",
27	"optionValue": 98765
28	}
29	],
30	"sku": "CER-POT-2-GR",
31	"basePrice": 55,
32	"discount": 10,
33	"offeredPrice": 49.5,
34	"quantity": 10,
35	"imageUrl": "https://mybcstore.com/ocean-planter.jpg",
36	"productId": 63261,
37	"variantId": 54321,
38	"productName": "The Planter by Rustic Roots"
39	}
40	],
41	"totalAmount": 1495,
42	"allowCheckout": True,
43	"channelId": 1,
44	"companyId": 11111111,
45	"contactInfo": {
46	"name": "Marie Curie",
47	"email": "mcurie@greatbuysinc.com",
48	"companyName": "Great Buys Incorporated",
49	"phoneNumber": "512-200-1234"
50	},
51	"currency": {
52	"currencyCode": "USD",
53	"decimalPlaces": 2,
54	"decimalToken": ".",
55	"location": "left",
56	"thousandsToken": ",",
57	"token": "$"
58	},
59	"discount": 0,
60	"displayDiscount": False,
61	"expiredAt": "05/07/2025",
62	"extraFields": {
63	"fieldName": "I want a sales representative to call me at the provided phone number.",
64	"fieldValue": "Yes"
65	},
66	"grandTotal": 1495,
67	"legalTerms": "Thank you for the opportunity to provide this quote! Please note the following:
68	- Quotes are valid for 30 days unless otherwise stated.
69	- Pricing is subject to change at any time.
70	- Please note, the shipping and tax quoted are estimates only. Final shipping and tax will be calculated during checkout and may be billed post sale.
71	- Due to fluctuating shipping rates, LTL shipping calculations are only estimates. Final LTL rates will be determined by quote upon shipment and may be billed post sale. Also, if a lift gate is required an additional fee will apply if not included in this quote.
72	- Please contact your Technical Sales Representative, call 877-567-3598, or email sales.rep@mybcstore.com for assistance.",
73	"message": "Hello Marie! I have submitted the quote you requested. Please review the notes and terms, and don't hesitate to reach out with any questions.",
74	"notes": "Use the in-quote messaging system to contact us about products, pricing, or other quote information.",
75	"quoteTitle": "Plant and Planter Bulk Order",
76	"referenceNumber": "03302025-0001",
77	"shippingAddress": {
78	"address": "512 Bluebonnet Lane",
79	"apartment": "Building 100",
80	"city": "Austin",
81	"state": "Texas",
82	"zipCode": "78704",
83	"country": "United States"
84	},
85	"subtotal": 1495,
86	"userEmail": "hero@mybcstore.com"
87	}
88	headers = {
89	"X-Auth-Token": "<apiKey>",
90	"Content-Type": "application/json"
91	}
92
93	response = requests.post(url, json=payload, headers=headers)
94
95	print(response.json())

1	{
2	"data": {
3	"quoteId": 123456,
4	"quoteUrl": "https://mybcstore.com/quote/?id=195&date=1622618606"
5	},
6	"message": "SUCCESS"
7	}

Custom Products

Minimum Required Fields

Authentication

Authentication header

Further reading

Authentication header

Request

Response

Errors

Custom Products

Minimum Required Fields

Authentication header

Further reading

Authentication header