Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

customerAccountId
integer<int32>
required
quoteName
string
required

Query Parameters

draft
boolean
responseFields
string

limits which fields are returned in the response body

Response

OK

adjustment
object
auditHistory
object[] | null

User modified Audit History

auditInfo
object
channelCode
string | null

Unique identifier of the channel for this item.

comments
object[] | null

Comments on a quote

couponCodes
string[] | null

Coupon codes associated with this Quote.

currencyCode
string | null

ISO Currency Code.

customerAccountId
integer<int32> | null

Unique identifier of the customer account.

customerInteractionType
string | null

Determines the interaction type that a customer will use to create this object. Valid values are: Website, Store, Call, Unknown

customerTaxId
string | null
read-only

The customers tax ID. If Customer Account ID exists in the system, will set this.

data
object | null

Custom data for a given vendor set within the commerce process.

dutyAmount
number<double> | null
dutyTotal
number<double>
email
string | null

Email address for checkout

expirationDate
string<date-time> | null

When the quote will no longer be active. That is, the quote is considered abandoned. Date in UTC Date/Time.

feeTotal
number<double>
fulfillmentInfo
object

Shipment information, which includes the shipping address, price, estimated delivery date, tracking information, method (for example, Ground, Overnight, or Pick-up), carrier (for example, USPS, UPS, FedEx), and current status (for example, Not Shipped, In Transit, Delayed, or Returned To Sender).

handlingAdjustment
object
handlingAmount
number<double> | null
handlingDiscounts
object[] | null
handlingSubTotal
number<double>
handlingTax
number<double> | null
handlingTaxTotal
number<double>
handlingTotal
number<double>
hasDraft
boolean

Does this quote have a draft

id
string | null

Unique identifier.

invalidCoupons
object[] | null

A list of invalid coupons that were attempted on the quote

ipAddress
string | null

IP address of the user placing the order. (User or customer?)

isDraft
boolean

Is this quote a draft

isTaxExempt
boolean | null
read-only

Unique identifier of the customer account.

itemLevelHandlingDiscountTotal
number<double>
itemLevelProductDiscountTotal
number<double>

The total value of item-level product discounts.

itemLevelShippingDiscountTotal
number<double>
itemTaxTotal
number<double>

Total tax on products.

itemTotal
number<double>

The total product cost, accounting for discounts and tax.

items
object[] | null

List of items in the Quote.

locationCode
string | null

Identifies the location at which the order was placed if the order was placed externally.

name
string | null

Name of the quote

number
integer<int32> | null

Auto generated number that is assigned to the quote when creation.

orderDiscounts
object[] | null
orderLevelHandlingDiscountTotal
number<double>
orderLevelProductDiscountTotal
number<double>

The total value of order-level (group-level) product discounts.

orderLevelShippingDiscountTotal
number<double>
priceListCode
string | null

Pricelist code for the checkout

shippingAdjustment
object
shippingAmount
number<double>
shippingDiscounts
object[] | null
shippingSubTotal
number<double>
shippingTax
number<double> | null
shippingTaxTotal
number<double>
shippingTotal
number<double>
siteId
integer<int32>

Unique identifier of the Site.

sourceDevice
string | null

Source device of the user placing the order. (User or customer?)

status
string | null
subTotal
number<double>

Subtotal before any coupon codes, taxes, fees, etc.

submittedDate
string<date-time> | null

When the customer placed (submitted) the Quote.

taxData
object | null

Storage for any additional/custom tax data.

tenantId
integer<int32>

Unique identifier of the Tenant.

total
number<double>

Final total

userId
string | null
visitId
string | null

Identifies the Visit ID that was current when the order was placed or when the cart was last updated.

webSessionId
string | null

Identifies the web session used to place the order or last update the cart.