For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

quote

Example Query
1query ExampleQuery($id: Int, $storeHash: String, $date: String, $uuid: String) {
2  quote(id: $id, storeHash: $storeHash, date: $date, uuid: $uuid) {
3    id
4    createdAt
5    updatedAt
6    quoteNumber
7    quoteTitle
8    referenceNumber
9    userEmail
10    bcCustomerId
11    createdBy
12    createdByEmail
13  }
14}
Variables
1{
2  "id": 0,
3  "storeHash": "example",
4  "date": "example",
5  "uuid": "example"
6}
Example response
1{
2  "data": {
3    "quote": {
4      "id": "example",
5      "createdAt": 0,
6      "updatedAt": 0,
7      "quoteNumber": "example",
8      "quoteTitle": "example",
9      "referenceNumber": "example",
10      "userEmail": "example",
11      "bcCustomerId": 0,
12      "createdBy": "example",
13      "createdByEmail": "example"
14    }
15  }
16}
Get the details of a quote. Requires a B2B token for B2B and B2C users
Was this page helpful?
Previous

customerQuotes

Next

quoteUserStoreInfo

Built with

Arguments

idIntegerRequired
Unique quote id. This field is required.
storeHashStringRequired
The store hash. This field is required.
dateStringRequired
Quote create date as a timestamp. This field is required.
uuidStringOptional
Quote UUID for secure access. This field is required if the quote has an associated UUID. Quote UUIDs can be retrieved when creating or listing quotes.

Returns

an optional QuoteType
idString
createdAtInteger
updatedAtInteger
salesRepStatusInteger
customerStatusInteger
quoteNumberString
Quote number
quoteTitleString
Title of the quote
referenceNumberString
Reference number of a quote
userEmailString
bcCustomerIdInteger
createdByString
Created by user of the quote
createdByEmailString
expiredAtInteger
companyIdCompanyType
subtotalString
subtotal amount of the quote
discountString
discount amount of the quote
grandTotalString
Grand total amount of the quote
cartIdString
cartUrlString
checkoutUrlString
bcOrderIdString
BC order ID of the quote
currencyGenericScalar
Currency information of the quote
contactInfoGenericScalar
Contact info of the quote
trackingHistoryGenericScalar
Tracking history of the quote
extraFieldslist of optional QuoteExtraFieldsValueType
Extra fields of the quote
notesString
Notes of the quote
legalTermsString
Legal terms of the quote
shippingTotalString
Shipping total of the quote
taxTotalString
total tax amount of the quote
totalAmountString
total amount of the quote
shippingMethodGenericScalar
Shipping method of the quote
billingAddressGenericScalar
Billing address of the quote
oldSalesRepStatusInteger
oldCustomerStatusInteger
recipientsGenericScalar
Recipients of the quote
discountTypeInteger
Discount type of the quote
discountValueString
Discount value of the quote
pdfTemplateString
pdfLangString
displayDiscountBoolean
allowCheckoutBoolean
statusInteger
Status of the quote
companyString
Company name of the quote
salesRepString
Sales Rep name of the quote
salesRepEmailString
Sales Rep email of the quote
orderIdString
order ID of the quote
shippingAddressGenericScalar
Shipping address of the quote
productsListlist of optional ProductType
Products list of the quote
storefrontAttachFileslist of optional QuoteAttachFiles
Storefront attach files of the quote
backendAttachFileslist of optional QuoteAttachFiles
Backend attach files of the quote
storeInfoStoreInfoType
Store information
companyInfoCompanyInfoType
Company information
salesRepInfosalesRepInfoType
Sales rep information
quoteLogoString
logo of the quote
quoteUrlString
url of the quote
channelIdInteger
The channel id of the quote
channelNameString
The channel name of the quote
uuidString
UUID for secure quote access