RFQ
Get Quote Form List
GET https://api-b2b.bigcommerce.com/api/v2/rfqRequest
Get quote form list.
Equivalent Storefront GraphQL API Query: quotes
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
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 ID field
- salesRep in query - stringSuper Admin ID
- status in query - stringStatus of quote
- quoteTitle in query - stringTitle of quote
- createdBy in query - stringCreate user name
- dateCreatedBeginAt in query - stringCreate date begin.example:10/01/2022
- dateCreatedEndAt in query - stringCreate date end.example:10/01/2022
- dateUpdatedBeginAt in query - stringUpdate date begin.example:10/01/2022
- dateUpdatedEndAt in query - stringUpdate date end.example:10/01/2022
- dateExpiredBeginAt in query - stringExpired date begin.example:10/01/2022
- dateExpiredEndAt in query - stringExpired date end.example:10/01/2022
example
Response
Body
codenumber
requireddataobject
required
example-1
Create a Quote Form
POST https://api-b2b.bigcommerce.com/api/v2/rfqRequest
Create a quote form.
Equivalent Storefront GraphQL API Mutation: quoteCreate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
notesstring
required>= 1 characterslegalTermsstring
requiredLegal terms>= 1 charactersgrandTotalnumber
requiredTotal price after discountdiscountnumber
requiredsubtotalnumber
requiredTotal pricereferenceNumberstring
requireduserEmailstring
required>= 1 charactersexpiredAtstring
required>= 1 charactersquoteTitlestring
requiredshippingAddressobject
requiredcontactInfoobject
requiredcompanyIdnumber
requiredcurrencyobject
requiredCurrency infostoreHashstring
required>= 1 charactersproductListarray[object]
requiredisBackendUsernumber
requiredbcCustomerIdinteger
Customer bc idchannelIdinteger
B2B Edition channel id
example
Response
Body
codenumber
requireddataobject
required
example-1
Get a Quote Detail
GET https://api-b2b.bigcommerce.com/api/v2/rfq/{quote_id}Request
Get a quote detail by quoteId.
Equivalent Storefront GraphQL API Query: quote
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- quote_id in path - stringrequiredUnique quote ID
- storeHash in query - stringrequiredStore Hash
- date in query - stringrequiredCreation date of quote, timestamp
example
Response
Body
codenumber
requireddataobject
required
example-1
Update a Quote
PUT https://api-b2b.bigcommerce.com/api/v2/rfq/{quote_id}Request
Update a quote.
Equivalent Storefront GraphQL API Mutation: quoteUpdate
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
notesstring
requiredQuote extra message>= 1 characterslegalTermsstring
required>= 1 charactersgrandTotalnumber
requiredTotal price after discountdiscountnumber
requiredsubtotalnumber
requiredTotal pricereferenceNumberstring
requiredReference number of a quote>= 1 charactersuserEmailstring
required>= 1 charactersexpiredAtstring
required>= 1 charactersquoteTitlestring
required>= 1 charactersshippingAddressobject
requiredcontactInfoobject
requiredcurrencyobject
requiredCurrency info, which can be seen when you get quote detailstoreHashstring
required>= 1 charactersproductListarray[object]
requiredisBackendUsernumber
required
example-1
Response
Body
codenumber
requireddataobject
required
example-1
Checkout Quote Form
POST https://api-b2b.bigcommerce.com/api/v2/rfq/{quote_id}/checkoutRequest
Checkout quote form by quoteId.
Equivalent Storefront GraphQL API Mutation: quoteCheckout
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
storeHashstring
requiredStore Hash
example
Response
Body
codenumber
requireddataobject
required
example-1
Ordered a Quote
POST https://api-b2b.bigcommerce.com/api/v2/rfq/{quote_id}/orderedRequest
Ordered a quote by quoteId.
Equivalent Storefront GraphQL API Mutation: quoteOrdered
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
orderIdstring
requiredUnique order IDstoreHashstring
requiredStore HashshippingTotalnumber
requiredShipping total pricetaxTotalnumber
requiredTax total priceshippingMethodobject
required
example-1
Response
Body
codenumber
requireddataobject
required
example-1
Get Quote Config
GET https://api-b2b.bigcommerce.com/api/v2/rfq/configsRequest
Get quote config.
Equivalent Storefront GraphQL API Query: quoteConfig
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- storeHash in query - stringStore Hash
example
Response
Body
codenumber
requiredExample: 200dataobject
required
example-1
Get Quote Store Info
GET https://api-b2b.bigcommerce.com/api/v2/rfq/store-infoRequest
Get store, company, and sales rep info. Mainly used for preview.
Equivalent Storefront GraphQL API Query: quoteUserStoreInfo
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- storeHash in query - stringStore Hash
- companyId in query - stringCompany ID
- salesRepId in query - stringSales Rep ID
example
Response
Body
codenumber
requireddataobject
required
example-1
Send a Quote Email
POST https://api-b2b.bigcommerce.com/api/v2/rfq/emailsRequest
Send a quote email.
Equivalent Storefront GraphQL API Mutation: quoteEmail
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Body
quoteIdstring
requiredThe quote ID you want to use>= 1 charactersemailstring
requiredWhich email you want to send>= 1 characters
Response
Body
codenumber
requireddataobject
required
example-1
Quote Export PDF
POST https://api-b2b.bigcommerce.com/api/v2/rfq/{quote_id}/pdf-exportRequest
Export quote pdf.
Equivalent Storefront GraphQL API Mutation: quoteFrontendPdf
. For more information, see the GraphQL Playground.
Authentication
- Authorization in header in the format of Bearer {{token}}
Parameters
- quote_id in path - stringrequiredUnique quote ID
Body
storeHashstring
requiredStore Hashcurrencyobject
example
Response
Body
codenumber
requireddataobject
required