Skip to navigation
GraphQLStorefrontTypesObjects

Quote

OBJECT
A quote requested by a shopper and managed by the merchant.

Fields

entityIdIntegerRequired
The unique ID of the quote.
createdAtDatetimeRequired
When the quote was created.
totalIsTbdBooleanRequired
Whether the total of the quote is still to be determined by the merchant.
productslist of QuoteProductsRequired
The line items of the quote.
extraFieldslist of QuoteExtraFieldValuesRequired
The values of the quote extra fields defined by the merchant.
attachmentslist of QuoteAttachmentsRequired
The files attached to the quote.
messageslist of QuoteMessagesRequired
The messages exchanged on the quote.
quoteNumberStringOptional

The human-readable quote number, or null if not assigned.

referenceNumberStringOptional
The reference number supplied for the quote, or null if none.
uuidStringOptional
The public identifier of the quote, used by guest shoppers to access it.
titleStringOptional
The title of the quote.
statusQuoteStatusOptional
The lifecycle status of the quote.
Allowed values:
notesStringOptional
The notes attached to the quote.
legalTermsStringOptional
The legal terms attached to the quote.
createdByStringOptional
The name of the person who created the quote.
updatedAtDatetimeOptional
When the quote was last updated.
expiresAtDatetimeOptional
When the quote expires.
orderIdStringOptional
The ID of the order the quote was converted into, or null if it has not been ordered.
contactQuoteContactOptional
The contact details of the person the quote is for.
shippingAddressQuoteAddressOptional
The shipping address of the quote.
billingAddressQuoteAddressOptional
The billing address of the quote.
salesRepQuoteSalesRepOptional
The sales representative assigned to the quote.
pricesQuotePricesOptional
The calculated prices of the quote, or null if they are not available.