Skip to navigation

quote

Get the details of a quote. Requires a B2B token for B2B and B2C users

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
quoteNumberStringOptional
Quote number
quoteTitleStringOptional
Title of the quote
referenceNumberStringOptional
Reference number of a quote
userEmailStringOptional
bcCustomerIdIntegerOptional
createdByStringOptional
Created by user of the quote
createdByEmailStringOptional
expiredAtIntegerOptional
companyIdCompanyTypeOptional
subtotalStringOptional
subtotal amount of the quote
discountStringOptional
discount amount of the quote
grandTotalStringOptional
Grand total amount of the quote
cartIdStringOptional
cartUrlStringOptional
checkoutUrlStringOptional
bcOrderIdStringOptional
BC order ID of the quote
currencyStringOptional
Currency information of the quote
contactInfoStringOptional
Contact info of the quote
trackingHistoryStringOptional
Tracking history of the quote
extraFieldslist of optional QuoteExtraFieldsValueTypeOptional
Extra fields of the quote
notesStringOptional
Notes of the quote
legalTermsStringOptional
Legal terms of the quote
shippingTotalStringOptional
Shipping total of the quote
taxTotalStringOptional
total tax amount of the quote
totalAmountStringOptional
total amount of the quote
shippingMethodStringOptional
Shipping method of the quote
billingAddressStringOptional
Billing address of the quote
oldSalesRepStatusIntegerOptional
oldCustomerStatusIntegerOptional
recipientsStringOptional
Recipients of the quote
discountTypeIntegerOptional
Discount type of the quote
discountValueStringOptional
Discount value of the quote
pdfTemplateStringOptional
pdfLangStringOptional
displayDiscountBooleanOptional
allowCheckoutBooleanOptional
totalIsTbdBooleanOptional

Is the total to be determined (TBD)

statusIntegerOptional
Status of the quote
companyStringOptional
Company name of the quote
salesRepStringOptional
Sales Rep name of the quote
salesRepEmailStringOptional
Sales Rep email of the quote
orderIdStringOptional
order ID of the quote
shippingAddressStringOptional
Shipping address of the quote
productsListlist of optional ProductTypeOptional
Products list of the quote
storefrontAttachFileslist of optional QuoteAttachFilesOptional
Storefront attach files of the quote
backendAttachFileslist of optional QuoteAttachFilesOptional
Backend attach files of the quote
storeInfoStoreInfoTypeOptional
Store information
companyInfoCompanyInfoTypeOptional
Company information
salesRepInfosalesRepInfoTypeOptional
Sales rep information
quoteUrlStringOptional
url of the quote
channelIdIntegerOptional
The channel id of the quote
channelNameStringOptional
The channel name of the quote
uuidStringOptional
UUID for secure quote access