Quote
BigCommerce B2B Edition Quote
Get Quote Form List
GET https://api-b2b.bigcommerce.com/api/v3/io/rfqRequest
Get quote form list
Authentication
- authToken in header
Parameters
- offset in query with default of 0 - stringPagination offset
- limit in query with default of 10 - stringPagination limit
- sortBy in query with default of updatedAt - stringSort by desc or asc
- orderBy in query with default of DESC - stringOrder by
- q in query - stringQuery string
- quoteNumber in query - stringQuote number
- company in query - stringCompany name
- salesRep in query - stringSuper Admin ID
- status in query - integerStatus of quote. 0:NEW; 2:IN PROCESS; 3:UPDATED BY CUSTOMER; 4:ORDERED; 5:EXPIRED; 6:ARCHIVED; 7:DRAFT
Allowed: 0 | 2 | 3 | 4 | 5 | 6 | 7
- quoteTitle in query - stringTitle of quote
- createdBy in query - stringCreate user name
- maxCreated in query - numberMaximum created timestamp
- minCreated in query - numberMinimum created timestamp
- maxModified in query - numberMaximum modified timestamp
- minModified in query - numberMinimum modified timestamp
- maxExpired in query - numberMaximum expired timestamp
- minExpired in query - numberMinimum expired timestamp
- channelIds in query - arrayBigCommerce channel IDs.Type: array[number]
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/rfq \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {
"list": [
{
"quoteId": 195,
"quoteNumber": "QN000195",
"referenceNumber": "",
"quoteTitle": "",
"createdBy": "Jo Sweet",
"company": "company name",
"salesRep": "Jo Sweet",
"createdAt": 1622618606,
"updatedAt": 1622618606,
"expiredAt": 1622717999,
"subtotal": 45.95,
"status": 0,
"currency": {
"token": "¥",
"location": "left",
"currencyCode": "USD",
"decimalToken": ".",
"decimalPlaces": 2,
"thousandsToken": ",",
Create a Quote Form
POST https://api-b2b.bigcommerce.com/api/v3/io/rfqRequest
Create a quote form
Authentication
- authToken in header
Body
object | application/json
notesstring
>= 1 characterslegalTermsstring
Legal terms>= 1 charactersgrandTotalnumber
requiredTotal price after discountdiscountnumber
requiredtotalAmountinteger
requiredTotal price after discountsubtotalnumber
requiredTotal pricereferenceNumberstring
userEmailstring
user email belong to a sales rep.>= 1 charactersquoteTitlestring
title for quoteexpiredAtstring
requiredformat time with %m/%d/%Y %H:%M:%S>= 1 charactersshippingAddressobject
shipping address information for quotecontactInfoobject
companyIdnumber
company ID field for quotecurrencyobject
Currency infoproductListarray[object]
requiredextraFieldsarray[object]
Extra fields of the quotechannelIdinteger
BigCommerce channel IDdisplayDiscountboolean
Whether the quote email and PDF show a discount.Default: true
allowCheckoutboolean
Whether the quote email and PDF show the checkout button.Default: true
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example
{
"code": 200,
"message": "SUCCESS",
"data": {
"quoteId": 195,
"quoteUrl": "https://sylvia-apptest-store.mybigcommerce.com/quote/?id=195&date=1622618606"
}
}
Get a Quote Detail
GET https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}Request
Get a quote form detail by quoteId
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
- date in query - stringrequiredquote create at
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/rfq/[quote_id]' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"data": {
"quoteNumber": "QN000199",
"referenceNumber": "",
"createdAt": 1622619778,
"expiredAt": 1722619778,
"status": 0,
"contactInfo": {
"name": "Hannah Admin330",
"email": "charles.admin@charlesco.com",
"companyName": "CharlesCo",
"phoneNumber": "0000000000"
},
"shippingAddress": {
"city": "",
"state": "",
"address": "",
"country": "",
"zipCode": "",
"apartment": ""
},
"subtotal": 45.95,
"discount": 0,
"grandTotal": 45.95,
"currency": {
"token": "¥",
"location": "left",
"currencyCode": "USD",
"decimalToken": ".",
Update a Quote
PUT https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}Request
Update a quote
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
Request body parameters you can find when you get a quote detail.
Body
object | application/json
notesstring
Quote extra message>= 1 characterslegalTermsstring
>= 1 charactersgrandTotalnumber
Total price after discountdiscountnumber
subtotalnumber
Total pricereferenceNumberstring
Reference number of a quote>= 1 charactersuserEmailstring
>= 1 charactersexpiredAtstring
>= 1 charactersquoteTitlestring
>= 1 charactersshippingAddressobject
contactInfoobject
currencyobject
Currency info, which can be seen when you get quote detail.productListarray[object]
extraFieldsarray[object]
displayDiscountboolean
Whether the quote email and PDF show a discount.allowCheckoutboolean
Whether the quote email and PDF show the checkout button.
example-1
{
"notes": "string",
"legalTerms": "string",
"message": "string",
"grandTotal": 0,
"discount": 0,
"subtotal": 0,
"referenceNumber": "string",
"userEmail": "string",
"expiredAt": "string",
"quoteTitle": "string",
"shippingAddress": {
"country": "string",
"state": "string",
"city": "string",
"zipCode": "string",
"address": "string",
"apartment": "string"
},
"contactInfo": {
"name": "string",
"email": "string",
"companyName": "string",
"phoneNumber": "string"
},
"currency": {
"token": "string",
"location": "string",
"decimalToken": "string",
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {
"quoteId": 195,
"quoteUrl": "url"
}
}
Delete a Quote
DELETE https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}Request
Delete a quote by quoteId
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
example
curl --request DELETE \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/rfq/[quote_id]' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {}
}
Checkout Quote Form
POST https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/checkoutRequest
Checkout quote form by quoteId
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
object | application/json
example-1
{}
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {
"checkoutUrl": "url",
"cartId": "123",
"cartUrl": "url"
}
}
Ordered a Quote
POST https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/orderedRequest
Ordered a quote by quoteId
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
object | application/json
orderIdstring
requiredUnique order ID
example-1
{
"orderId": ""
}
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {}
}
Send a Quote Email
POST https://api-b2b.bigcommerce.com/api/v3/io/rfq/emailsRequest
Send a quote email
Authentication
- authToken in header
Body
object | application/json
quoteIdstring
requiredThe quote ID you want to use.>= 1 charactersemailstring
requiredThe email you want to send.>= 1 characterswithAttachboolean
requiredWhether to send the quote pdf as an attachment.Default: true
emailTemplatestring
requiredTemplate for sending emailsAllowed: Simple | Simple with Pictures | Waves with Pictures | Sky | Dots
ccToarray[string]
Cc who sent the messageemailLangstring
The language in which the message is sent. nl: DutchAllowed: en | nl
example
{
"quoteId": "string",
"email": "string",
"withAttach": true,
"emailTemplate": "Simple",
"ccTo": [
"string"
],
"emailLang": "en"
}
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example
{
"code": 200,
"message": "SUCCESS",
"data": {}
}
Quote Export PDF
POST https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/pdf-exportRequest
Export quote pdf
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
object | application/json
currencyobject
example
{
"currency": {
"currencyExchangeRate": "string"
}
}
Response
OK
Body
object | application/json
codenumber
requireddataobject
required
example-1
{
"code": 200,
"message": "SUCCESS",
"data": {
"url": "pdf url"
}
}
Get Quote Extra Fields Configs
GET https://api-b2b.bigcommerce.com/api/v3/io/rfq/extra-fieldsRequest
Get quote extra fields configs. It is better to cache the response results to avoid frequent API requests.
Authentication
- authToken in header
Parameters
- offset in query0 - integerPagination offset.
- limit in query with default of 10 - integerPagination limit.
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/rfq/extra-fields \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
dataarray[object]
example-1
{
"code": 200,
"data": [
{
"id": 1,
"uuid": "b4be8a36-98c7-48e1-9495-cb8ec302378c",
"filedName": "test1",
"fieldType": 0,
"isRequired": false,
"isUnique": false,
"visibleToEnduser": true,
"configType": 1,
"defaultValue": "",
"maximumLength": "10"
},
{
"id": 2,
"uuid": "602c4b76-426e-46ff-a098-b37a15335936",
"filedName": "test2",
"fieldType": 1,
"isRequired": false,
"isUnique": false,
"visibleToEnduser": true,
"configType": 1,
"defaultValue": "",
"maximumValue": "20"
Get available shipping rates for quote
GET https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-ratesRequest
Get available shipping rates for quote.
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
example
curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/rfq/[quote_id]/shipping-rates' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
dataarray[object]
Success
{
"code": 200,
"data": [
{
"shippingMethodId": "07a4b3bc067385847b04d80d430486d9",
"type": "shipping_flatrate",
"description": "Flat Rate",
"cost": 10
}
],
"meta": {
"message": "SUCCESS"
}
}
Get all B2B quote custom shipping methods
GET https://api-b2b.bigcommerce.com/api/v3/io/rfq/custom/shipping-methodsRequest
Get all B2B quote custom shipping methods.
Authentication
- authToken in header
example
curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v3/io/rfq/custom/shipping-methods \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
Body
object | application/json
codenumber
dataarray[object]
Success
{
"code": 200,
"data": [
{
"customShippingMethodName": "custom1"
},
{
"customShippingMethodName": "custom2"
}
],
"meta": {
"message": "SUCCESS"
}
}
Select a shipping rate for quote
PUT https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rateRequest
Select a shipping rate for quote.
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
object | application/json
shippingMethodIdstring
Shipping method ID. Cannot be used withcustomShippingMethodName
at the same time.customShippingMethodNamestring
Custom shipping method name. Cannot be used withshippingMethodId
at the same time.customShippingMethodCostnumber
Custom shipping method cost. Required when using custom shipping method.Min: 0
example
{
"shippingMethodId": "string",
"customShippingMethodName": "string",
"customShippingMethodCost": 0
}
Response
OK
Body
object | application/json
codenumber
Success
{
"code": 200,
"meta": {
"message": "SUCCESS"
}
}
Remove selected shipping rate for quote
DELETE https://api-b2b.bigcommerce.com/api/v3/io/rfq/{quote_id}/shipping-rateRequest
Remove selected shipping rate for quote.
Authentication
- authToken in header
Parameters
- quote_id in path - stringrequiredUnique quote ID
example
curl --request DELETE \
--url 'https://api-b2b.bigcommerce.com/api/v3/io/rfq/[quote_id]/shipping-rate' \
--header 'Content-Type: application/json' \
--header 'authToken: {{token}}'
Response
OK
See something you can improve? Edit this file on GitHub
Did you find what you were looking for?