RFQ

Get Quote Form List

GET /rfq

Request

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 - string
    Pagination offset
  • limit in query with default of 10 - string
    Pagination limit
  • sortBy in query with default of updatedAt - string
    Sort by desc or asc
  • orderBy in query with default of DESC - string
    Order by
  • q in query - string
    Query string
  • quoteNumber in query - string
    Quote number
  • company in query - string
    Company ID field
  • salesRep in query - string
    Super Admin ID
  • status in query - string
    Status of quote
  • quoteTitle in query - string
    Title of quote
  • createdBy in query - string
    Create user name
  • dateCreatedBeginAt in query - string
    Create date begin.example:10/01/2022
  • dateCreatedEndAt in query - string
    Create date end.example:10/01/2022
  • dateUpdatedBeginAt in query - string
    Update date begin.example:10/01/2022
  • dateUpdatedEndAt in query - string
    Update date end.example:10/01/2022
  • dateExpiredBeginAt in query - string
    Expired date begin.example:10/01/2022
  • dateExpiredEndAt in query - string
    Expired date end.example:10/01/2022

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/rfq \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    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": 1,
"currency": {
"token": "¥",
"location": "left",
"currencyCode": "USD",
"decimalToken": ".",
"decimalPlaces": 2,
"thousandsToken": ",",

Create a Quote Form

POST /rfq

Request

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

object | application/json
  • notes
    string
    required

    >= 1 characters
  • legalTerms
    string
    required

    Legal terms
    >= 1 characters
  • message
    string
    required

    Extra message
    >= 1 characters
  • grandTotal
    number
    required

    Total price after discount
  • discount
    number
    required

  • subtotal
    number
    required

    Total price
  • referenceNumber
    string
    required

  • userEmail
    string
    required

    >= 1 characters
  • expiredAt
    string
    required

    >= 1 characters
  • quoteTitle
    string
    required

  • shippingAddress
    object
    required

  • contactInfo
    object
    required

  • companyId
    number
    required

  • currency
    object
    required

    Currency info
  • storeHash
    string
    required

    >= 1 characters
  • productList
    array[object]
    required

  • isBackendUser
    number
    required

  • bcCustomerId
    integer

    Customer bc id
  • channelId
    integer

    B2B Edition channel id

example

{
"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"
},
"companyId": 0,
"currency": {
"token": "string",
"location": "string",
"decimalToken": "string",

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"quoteId": 195,
"quoteUrl": "url"
}
}

Get a Quote Detail

GET /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 - string
    required
    Unique quote ID
  • storeHash in query - string
    required
    Store Hash
  • date in query - string
    required
    Creation date of quote, timestamp

example

curl --request GET \
--url 'https://api-b2b.bigcommerce.com/api/v2/rfq/[quote_id]' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"quoteNumber": "QN000199",
"referenceNumber": "",
"createdAt": 1622618606,
"expiredAt": 1622717999,
"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 /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 - string
    required
    Unique quote ID
Request body params you could find when you get quote detail

Body

object | application/json
  • notes
    string
    required

    Quote extra message
    >= 1 characters
  • legalTerms
    string
    required

    >= 1 characters
  • message
    string
    required

    Text info from comments
    >= 1 characters
  • grandTotal
    number
    required

    Total price after discount
  • discount
    number
    required

  • subtotal
    number
    required

    Total price
  • referenceNumber
    string
    required

    Reference number of a quote
    >= 1 characters
  • userEmail
    string
    required

    >= 1 characters
  • expiredAt
    string
    required

    >= 1 characters
  • quoteTitle
    string
    required

    >= 1 characters
  • shippingAddress
    object
    required

  • contactInfo
    object
    required

  • currency
    object
    required

    Currency info, which can be seen when you get quote detail
  • storeHash
    string
    required

    >= 1 characters
  • productList
    array[object]
    required

  • isBackendUser
    number
    required

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
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"quoteId": 195,
"quoteUrl": "url"
}
}

Checkout Quote Form

POST /rfq/{quote_id}/checkout

Request

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 - string
    required
    Unique quote ID

Body

object | application/json
  • storeHash
    string
    required

    Store Hash

example

{
"storeHash": "string"
}

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"checkoutUrl": "url",
"cartId": "123",
"cartUrl": "url"
}
}

Ordered a Quote

POST /rfq/{quote_id}/ordered

Request

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 - string
    required
    Unique quote ID

Body

object | application/json
  • orderId
    string
    required

    Unique order ID
  • storeHash
    string
    required

    Store Hash
  • shippingTotal
    number
    required

    Shipping total price
  • taxTotal
    number
    required

    Tax total price
  • shippingMethod
    object
    required

example-1

{
"orderId": "",
"storeHash": "",
"shippingTotal": 0,
"taxTotal": 0,
"shippingMethod": {
"id": "kWf@Mjg",
"type": "flat",
"description": "Fixed (Fixed)",
"imageUrl": "telnet://axcsqlcngg.cc/sfsrtyimv",
"transitTime": "",
"cost": 10,
"additionalDescription": ""
}
}

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {}
}

Get Quote Config

GET /rfq/configs

Request

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 - string
    Store Hash

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/rfq/configs \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

    Example: 200
  • message
    string
    required

    >= 1 characters
    Example: SUCCESS
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"switchStatus": [
{
"key": "quote_reminder_notification",
"isEnabled": "1"
},
{
"key": "quote_customer",
"isEnabled": "1"
},
{
"key": "quote_default_pdf",
"isEnabled": "1"
}
],
"quoteOtherConfiqs": [
{
"key": "defaultExpirationDate",
"value": 5
},
{
"key": "defaultTermsAndConditions",
"value": ""
}
]
}
}

Get Quote Store Info

GET /rfq/store-info

Request

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 - string
    Store Hash
  • companyId in query - string
    Company ID
  • salesRepId in query - string
    Sales Rep ID

example

curl --request GET \
--url https://api-b2b.bigcommerce.com/api/v2/rfq/store-info \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"storeUserInfo": {
"storeInfo": {
"storeName": "Apptest Store",
"storeAddress": "47 Discovery\nAcmeville, AC 12345\nUnited States of America",
"storeCountry": "United States"
},
"companyInfo": {
"companyId": "5716",
"companyName": "company name",
"companyAddress": "address line 1 address line 2",
"companyCountry": "Aruba",
"companyState": "",
"companyCity": "Denver",
"companyZipCode": "80022",
"phoneNumber": "123456789"
},
"salesRepInfo": {
"salesRepName": "sales rep name",
"salesRepEmail": "email",

Send a Quote Email

POST /rfq/emails

Request

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

object | application/json
  • quoteId
    string
    required

    The quote ID you want to use
    >= 1 characters

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {}
}

Quote Export PDF

POST /rfq/{quote_id}/pdf-export

Request

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 - string
    required
    Unique quote ID

Body

object | application/json
  • storeHash
    string
    required

    Store Hash
  • currency
    object

example

{
"storeHash": "string",
"currency": {
"currencyExchangeRate": "string"
}
}

Response

OK

Body

object | application/json
  • code
    number
    required

  • message
    string
    required

    >= 1 characters
  • data
    object
    required

example-1

{
"code": 200,
"message": "SUCCESS",
"data": {
"url": "pdf url"
}
}
Did you find what you were looking for?