Queries and mutations for managing Quotes in the platform.
Queries
Query Quotes
Get Quote
| Arguments | |
|---|---|
idString | Queries with specified ID |
keyString | Queries with specified key |
Mutations
Create Quote
| Arguments | |
|---|---|
draft | |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
Update Quote
| Arguments | |
|---|---|
versionLong | |
actionsArray of QuoteUpdateAction | |
asAssociate | Create/modify entity as an associate in business-unit. |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Quote
Output types
Quote
customerRef | The Buyer who owns the Quote. |
customer | The Buyer who owns the Quote. |
customerGroupRef | Set automatically when customer is set and the Customer is a member of a Customer Group.
Not updated if Customer is changed after Quote creation.
Used for Product Variant price selection. |
customerGroup | Set automatically when customer is set and the Customer is a member of a Customer Group.
Not updated if Customer is changed after Quote creation.
Used for Product Variant price selection. |
lineItemsArray of LineItem | The Line Items for which the Quote is requested. |
customLineItemsArray of CustomLineItem | The Custom Line Items for which the Quote is requested. |
totalPrice | Sum of all totalPrice fields of the lineItems and customLineItems, as well as the price field of shippingInfo (if it exists).
totalPrice may or may not include the taxes: it depends on the taxRate.includedInPrice property of each price. |
taxedPrice | Not set until the shipping address is set.
Will be set automatically in the Platform TaxMode.
For the External tax mode it will be set as soon as the external tax rates for all line items, custom line items, and shipping in the cart are set. |
shippingAddress | Used to determine the eligible ShippingMethods
and rates as well as the tax rate of the Line Items. |
billingAddress | Address used for invoicing. |
itemShippingAddressesArray of Address | Contains addresses for carts with multiple shipping addresses.
Line items reference these addresses under their shippingDetails.
The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate.
Only the cart's shippingAddress is used for this. |
inventoryMode | Inventory mode of the Cart referenced in the QuoteRequestDraft. Can be None, TrackOnly, ReserveOnOrder, or ReserveOnCart |
taxMode | Tax mode of the Cart referenced in the QuoteRequestDraft. Can be Disabled, External, ExternalAmount, or Platform |
priceRoundingMode | When calculating total prices on LineItems and CustomLineItems, the selected mode is used for rounding. Can be HalfDown, HalfEven, or HalfUp |
taxRoundingMode | When calculating taxes for Can be taxedPrice, the selected mode is used for rounding.HalfDown, HalfEven, or HalfUp |
taxCalculationMode | When calculating taxes for Can be taxedPrice, the selected mode is used for calculating the price with LineItemLevel (horizontally) or UnitPriceLevel (vertically) calculation mode.LineItemLevel, or UnitPriceLevel |
country | Used for Product Variant price selection. |
shippingInfo | Set automatically once the ShippingMethod is set. |
paymentInfo | Log of payment transactions related to the Quote. |
directDiscountsArray of DirectDiscount | BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta |
directDiscountsIgnoreCartDiscountsBoolean | BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta |
shippingRateInput | Used to select a ShippingRatePriceTier. |
storeRef | The Store to which the Buyer belongs. |
store | The Store to which the Buyer belongs. |
businessUnit | The BusinessUnit for the Quote. Only available for B2B-enabled Projects. |
businessUnitRef | The BusinessUnit for the Quote. Only available for B2B-enabled Projects. |
keyString | User-defined unique identifier of the Quote. |
quoteState | Predefined states tracking the status of the Quote. Can beAccepted, Declined, DeclinedForRenegotiation, Pending, RenegotiationAddressed, or Withdrawn |
stagedQuoteRef | Staged Quote related to the Quote. |
stagedQuote | Staged Quote related to the Quote. |
quoteRequestRef | Quote Request related to the Quote. |
quoteRequest | Quote Request related to the Quote. |
validTo | Expiration date for the Quote. Once a Quote expires, it cannot be ordered. |
sellerCommentString | Message from the Seller included in the offer. |
buyerCommentString | Message from the Buyer included in the renegotiation request. |
custom | Custom Fields on the Quote. |
stateRef | State of the Quote.
This reference can point to a State in a custom workflow. |
state | State of the Quote.
This reference can point to a State in a custom workflow. |
purchaseOrderNumberString | The purchase order number is typically set by the Buyer on a QuoteRequest to
track the purchase order during the quote and order flow. |
idString | Unique identifier of the Quote. |
versionLong | Current version of the Quote. |
createdAt | Date and time (UTC) the Quote was initially created. |
lastModifiedAt | Date and time (UTC) the Quote was last updated. |
createdBy | IDs and references that created the Quote. |
lastModifiedBy | IDs and references that last modified the Quote. |
LineItem
A line item is a snapshot of a product variant at the time it was added to the cart.
Since a product variant may change at any time, the ProductVariant data is copied into the field variant. The relation to the Product is kept but the line item will not automatically update if the product variant changes. On the cart, the line item can be updated manually. The productSlug refers to the current version of the product. It can be used to link to the product. If the product has been deleted, the line item remains but refers to a non-existent product and the productSlug is left empty.
Please also note that creating an order is impossible if the product or product variant a line item relates to has been deleted.
idString | Unique identifier of the LineItem. |
keyString | User-defined identifier of the LineItem. Unique among LineItems in the Cart or Order. |
productIdString | id of the Product the Line Item is based on. |
productKeyString | key of the Product.This field is only present on:
Present on resources created or updated after 3 December 2021. |
nameString | Name of the Product. |
nameAllLocalesArray of LocalizedString | Name of the Product. |
productSlugString | slug of the current version of the Product. Updated automatically if the slug changes. Empty if the Product has been deleted.
The productSlug field of LineItem is not expanded when using Reference Expansion. |
productSlugAllLocalesArray of LocalizedString | slug of the current version of the Product. Updated automatically if the slug changes. Empty if the Product has been deleted.
The productSlug field of LineItem is not expanded when using Reference Expansion. |
productType | Product Type of the Product. |
productTypeRef | Reference to the product type of the line item, carrying the snapshot version captured when the line item was added. |
variant | Holds the data of the Product Variant added to the Cart. The data is saved at the time the Product Variant is added to the Cart and is not updated automatically when Product Variant data changes.
Must be updated using the Recalculate update action. |
price | Price of a Line Item selected from the Product Variant according to the Product priceMode. If the priceMode is Embedded ProductPriceMode and the variant field hasn't been updated, the price may not correspond to a price in variant.prices. |
taxedPrice | Automatically set after taxRate is set. |
totalPrice | Total price of this Line Item equalling
price multiplied by quantity. If the Line Item is discounted, the total price is the discountedPricePerQuantity multiplied by quantity.
Includes taxes if the TaxRate includedInPrice is true.If ExternalPrice LineItemPriceMode is used with high-precision money, then the total price is rounded by using the HalfEven rounding mode. |
quantityLong | |
addedAt | Date and time (UTC) the Line Item was added to the Cart. |
lastModifiedAt | Date and time (UTC) the Line Item was last updated. |
stateArray of ItemState | Tracks specific quantities of the Line Item within a given State. When a Line Item is added to a Cart, its full quantity is set to the built-in "Initial" state. State transitions for Line Items are managed on the Order. |
taxRate |
|
supplyChannel | Identifies Inventory entries that are reserved. The referenced Channel has the InventorySupply ChannelRoleEnum. |
supplyChannelRef | Identifies Inventory entries that are reserved. The referenced Channel has the InventorySupply ChannelRoleEnum. |
distributionChannel | |
distributionChannelRef | |
discountedPricePerQuantityArray of DiscountedLineItemPriceForQuantity | Discounted price of a single quantity of the Line Item. |
lineItemMode | Indicates how the Line Item is added to the Cart. Can beGiftLineItem, or Standard |
priceMode | Indicates how the Price for the Line Item is set. Can beExternalPrice, ExternalTotal, or Platform |
custom | Custom Fields of the Line Item. |
inventoryMode | Inventory mode specific to this Line Item only, and valid for the entire Can be quantity of the Line Item.
Only present if the inventory mode is different from the inventoryMode specified on the Cart.None, TrackOnly, ReserveOnOrder, or ReserveOnCart |
reservation | Reference to the successful Reservation associated with this Line Item. This field is only populated when using the ReserveOnCart mode. |
reservationRef | Reference to the successful Reservation associated with this Line Item. This field is only populated when using the ReserveOnCart mode. |
shippingDetails | Container for Line Item-specific addresses. |
perMethodTaxRateArray of MethodTaxRate | Tax Rate per Shipping Method for a Cart with Multiple ShippingMode. For a Cart with Platform TaxMode it is automatically set after the Shipping Method is added.
For a Cart with External TaxMode, the Tax Rate must be set with ExternalTaxRateDraft. |
taxedPricePortionsArray of MethodTaxedPrice | Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode.
Automatically set after perMethodTaxRate is set. |
recurrenceInfo | Recurring Order and frequency data. |
VersionedReference
typeIdString | |
idString | |
versionLong |
ProductVariant
Classic.
When the Project has the Modular catalog model, use the Variants API instead.idInt | A unique, sequential identifier of the Product Variant within the Product. |
keyString | User-defined identifier of the ProductVariant. Unique among ProductVariants in the same Product. This is different from Product key. |
skuString | User-defined SKU of the Product Variant. Unique across all ProductVariants in a Project. |
pricesArray of ProductPrice | If the Product is projected by Store, this field only contains Embedded Prices that are valid for that Store.
Cannot contain two Embedded Prices with the same scopes (currency, country, Customer Group, Channel, validFrom and validUntil). |
price | Returns a single price based on the price selection rules. |
allRecurrencePricesArray of ProductPrice | Returns all recurrence prices based on the price selection rules. |
imagesArray of Image | Images of the Product Variant. |
assetsArray of Asset | Media assets of the Product Variant. |
availability | Set if the Product Variant is tracked by Inventory.
Can be used as an optimization to reduce calls to the Inventory service.
May not contain the latest Inventory State (it is eventually consistent). |
attributesRawArray of RawProductAttribute | This field contains raw attributes data |
ProductPrice
idString | |
value | |
keyString | |
country | |
customerGroup | |
customerGroupRef | |
channel | |
channelRef | |
validFrom | |
validUntil | |
discounted | |
tiersArray of ProductPriceTier | |
custom | |
recurrencePolicy | |
recurrencePolicyRef |
DiscountedProductPriceValue
value | |
discountRef | |
discount |
ProductPriceTier
minimumQuantityInt | |
value |
ProductVariantAvailabilityWithChannels
noChannel | |
channels |
ProductVariantAvailability
Product variant availability
isOnStockBoolean | Whether the Product Variant is in stock, based on an InventoryEntry that has no assigned supply Channel.
This value reflects global or default availability; it does not aggregate the channel-specific availabilities found in the channels field. |
restockableInDaysInt | Number of days to restock a Product Variant once it is out of stock. |
availableQuantityLong | Number of items of the Product Variant that are in stock. |
versionLong | Current version of the InventoryEntry. |
idString | Unique identifier of the InventoryEntry. |
ProductVariantAvailabilitiesResult
Product variant availabilities
limitInt | |
offsetInt | |
totalInt | |
resultsArray of ProductVariantAvailabilityWithChannel |
ProductVariantAvailabilityWithChannel
channelRef | |
channel | |
availability |
RawProductAttribute
attributeDefinition | |
nameString | |
valueJson | |
attributesRawArray of RawProductAttribute | BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta |
referencedResource | |
referencedResourceSetArray of ReferenceExpandable |
AttributeDefinition
type | Describes the Type of the Attribute. |
nameString | User-defined name of the Attribute that is unique within the Project. |
labelString | Human-readable label for the Attribute. |
isRequiredBoolean | Whether the Attribute must have a value on a ProductVariant. |
attributeConstraint | Specifies how Attributes are validated across all variants of a Product. Can beNone, Unique, CombinationUnique, or SameForAll |
level | Specifies whether the Attribute is defined at the Product or Variant level. Can beVariant, or Product |
inputTipString | Provides additional Attribute information to aid content managers configure Product details. |
inputHint | Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType). Can be SingleLine, or MultiLine |
isSearchableBoolean | Whether the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets.
However, if an Attribute's
level is set as Product, then Product Projection Search does not support the Attribute.
To use the Attribute in search, filters, or facets, set isSearchable to true for all AttributeDefinitions with the same name across different ProductTypes.
If the isSearchable values are different, the Attribute isn't available for search, filters, or facets.The exact features that are available with this flag depend on the specific AttributeType.
The maximum size of a searchable field is restricted by the Field content size limit.
This constraint is enforced at both Product creation and Product update.
If the length of the input exceeds the maximum size, an InvalidField error is returned. |
savedToLineItemBoolean | Whether the Attribute value is copied onto the LineItem when the Product is added to a Cart.
When
false, the Attribute value is excluded from the Line Item variant. Line Items already in a Cart are not immediately affected by a change to this value. Existing Line Items are updated the next time their Product data is refreshed, such as when a Recalculate update action is performed with updateProductData set to true, or on a Cart update that triggers an API Extension. Replicating a Cart creates a new Cart that contains the current Product data; it does not update the original Cart.When savedToLineItem is false, LineItem predicates that reference this Attribute, such as those in Cart Discounts and Shipping Methods, evaluate as if the Attribute is not set. |
labelAllLocalesArray of LocalizedString | Human-readable label for the Attribute. |
inputTipAllLocalesArray of LocalizedString | Provides additional Attribute information to aid content managers configure Product details. |
AttributeDefinitionType
AttributeConstraint
None- No constraints are applied to the attribute
Unique- Attribute value should be different in each variant
CombinationUnique- A set of attributes, that have this constraint, should have different combinations in each variant
SameForAll- Attribute value should be the same in all variants
Level
Variant- The attribute can be used on the variant level
Product- The attribute can be used on the product level
TaxedItemPrice
totalNet | Total net amount of the Line Item or Custom Line Item. |
totalGross | Total gross amount of the Line Item or Custom Line Item. |
taxPortionsArray of TaxPortion | Taxable portions added to the total net price. Calculated from the TaxRates. |
totalTax | Total tax applicable for the Line Item or Custom Line Item.
Automatically calculated as the difference between the totalGross and totalNet values. |
TaxPortion
Represents the portions that sum up to the totalGross field of a TaxedPrice. The portions are calculated from the TaxRates. If a tax rate has SubRates, they are used and can be identified by name. Tax portions from line items that have the same rate and name will be accumulated to the same tax portion.
rateFloat | A number in the range 0-1. |
amount | Money value of the tax portion. |
nameString | Name of the tax portion. |
ItemState
TaxRate
nameString | Name of the TaxRate. |
amountFloat | Tax rate. If subrates are used, the amount is the sum of all rates in subRates. |
includedInPriceBoolean | Whether tax is included in Embedded Prices or Standalone Prices, and the taxedPrice is present on LineItems. In this case, the totalNet price on TaxedPrice includes the TaxRate. |
country | Country in which the tax rate is applied in ISO 3166-1 alpha-2 format. |
stateString | State within the country, such as Texas in the United States.
The value is case-sensitive and must use the same casing as the
state value in the Cart shippingAddress.A TaxRate whose state is omitted does not act as a wildcard: it only matches a Cart whose shippingAddress also has no state value. To apply the same rate across states, either define an individual TaxRate for each state, or use the region field or a Custom Field on the shipping address as described in Address matching. |
idString | Present if the TaxRate is part of a TaxCategory.
Absent for external TaxRates in LineItem, CustomLineItem, and ShippingInfo. |
keyString | User-defined identifier of the TaxRate. Unique within the TaxCategory containing it.
Present when set using TaxRateDraft. Not available for external TaxRates created using ExternalTaxRateDraft. |
subRatesArray of SubRate | Used when the total tax is a combination of multiple taxes (for example, local, state/provincial, and/or federal taxes). The total of all subrates must equal the TaxRate amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos. |
taxRoundingTarget | Determines which of the net price and the tax amount the
taxRoundingMode of the Cart or Order is applied to, when this TaxRate is included in the price. Ignored if includedInPrice is false.Always returned by the API. Can be omitted when a TaxRate is supplied as input, such as in OrderImportDraft, and then defaults to Can be Net.Net, or Tax |
SubRate
nameString | Name of the SubRate. |
amountFloat |
TaxRoundingTarget
Net- Default. `taxRoundingMode` is applied to the net price and the tax amount is the exact remainder. E.g. at 20% on `1.23`, the net rounds to `1.02` and the tax is `0.21`.
Tax- `taxRoundingMode` is applied to the tax amount and the net price is the exact remainder. E.g. at 20% on `1.23`, the tax rounds to `0.20` and the net is `1.03`. Has no effect when the rate is not included in the price.
DiscountedLineItemPriceForQuantity
quantityLong | Quantity of Line Items or Custom Line Items in the Cart. |
discountedPrice | Discounted price of the Line Item or Custom Line Item. When multiple Cart Discounts apply to the same Line Item, the discounts are applied sequentially in the order determined by their sortOrder values (higher values are applied first). The price rounding mode specified by the Cart's priceRoundingMode field is applied after each individual discount is calculated, not after all discounts have been applied cumulatively. This means that rounding occurs at each step of the discount calculation process. |
DiscountedLineItemPrice
value | Money value of the discounted Line Item or Custom Line Item. When multiple discounts from includedDiscounts apply, they are applied sequentially based on the sortOrder of their associated Cart Discounts (discounts with higher sortOrder values are applied first). The Cart's priceRoundingMode field (RoundingMode) is applied after each discount calculation, so rounding occurs after each discount step rather than only once on the final cumulative amount. |
includedDiscountsArray of DiscountedLineItemPortion | Discount applicable on the Line Item or Custom Line Item. |
DiscountedLineItemPortion
discount | A CartDiscountReference or DirectDiscountReference of the applicable discount on the Line Item. |
discountRef | A CartDiscountReference or DirectDiscountReference of the applicable discount on the Line Item. |
discountedAmount | Money value of the applicable discount. When a Cart Discount with CartDiscountPatternTarget is used:
|
LineItemMode
GiftLineItem- The line item was added automatically, because a discount has added a free gift to the cart. The quantity can not be increased, and it won’t be merged when the same product variant is added. If the gift is removed, an entry is added to the "refusedGifts" array and the discount won’t be applied again to the cart. The price can not be changed externally. All other updates, such as the ones related to custom fields, can be used.
Standard- The line item was added during cart creation or with the update action addLineItem. Its quantity can be changed without restrictions.
LineItemPriceMode
ExternalPrice- The line item price was set externally. Cart discounts can apply to line items with this price mode. All update actions that change the quantity of a line item with this price mode require the externalPrice field to be given.
ExternalTotal- The line item price with the total was set externally.
Platform- The price is selected form the product variant. This is the default mode.
InventoryMode
None- No inventory checks or modifications when adding items or ordering. Default for a new cart.
TrackOnly- Orders decrement the available quantity on the matching inventory entry; ordering fails only when no inventory entry exists for a line item.
ReserveOnOrder- Line items are reserved only for the duration of the ordering transaction; creating an order fails when an unavailable line item exists.
ReserveOnCart- Items are reserved when added to the cart. Not supported by this service.
ItemShippingDetails
targetsArray of ItemShippingTarget | Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped. |
validBoolean | Whether the quantity of Line Items or Custom Line Items is equal to the sum of sub-quantities defined in targets.
Ordering a Cart when the value is false returns an InvalidItemShippingDetails error. |
ItemShippingTarget
itemShippingAddresses) and the quantity shipped to the address.If multiple shipping addresses are present for a Line Item or Custom Line Item, sub-quantities must be specified. An array of addresses and sub-quantities is stored per Line Item or Custom Line Item.
addressKeyString | Key of the address in the Cart itemShippingAddresses.
Duplicate address keys are not allowed. |
quantityLong | Quantity of Line Items or Custom Line Items shipped to the address with the specified
addressKey.If a quantity is updated to 0 when defining ItemShippingDetailsDraft, the targets are removed from a Line Item or Custom Line Item in the resulting ItemShippingDetails. |
shippingMethodKeyString | User-defined unique identifier of the Shipping Method in a Cart with
Multiple ShippingMode.It connects Line Item or Custom Line Item quantities with individual Shipping Methods. Required when the Cart has Multiple ShippingMode. Omitting this field in that case returns an InvalidOperation error. |
MethodTaxRate
shippingMethodKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
taxRate | Tax Rate for the Shipping Method. |
MethodTaxedPrice
shippingMethodKeyString | |
taxedPrice | Total taxed price based on the quantity of the Line Item or Custom Line Item assigned to the Shipping Method identified by shippingMethodKey. |
LineItemRecurrenceInfo
The RecurrenceInfo returned in a LineItem
recurrencePolicy | |
recurrencePolicyRef | |
expiresAt | |
priceSelectionMode | Can be Dynamic, or Fixed |
RecurrencePolicyRef
typeIdString | |
idString |
CustomLineItem
A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.
idString | Unique identifier of the Custom Line Item. |
keyString | User-defined identifier of the Custom Line Item. Unique among Custom Line Items in the Cart or Order. |
nameString | Name of the Custom Line Item. |
nameAllLocalesArray of LocalizedString | Name of the Custom Line Item. |
money | Money value of the Custom Line Item. |
totalPrice | Total price of the Custom Line Item (
money multiplied by quantity).
If the Custom Line Item is discounted, the total price is discountedPricePerQuantity multiplied by quantity. |
slugString | User-defined identifier used in a deep-link URL for the Custom Line Item.
It matches the pattern [a-zA-Z0-9_-]{2,256}. |
quantityLong | |
stateArray of ItemState | Tracks specific quantities of the Custom Line Item within a given State. When a Custom Line Item is added to a Cart, its full quantity is set to the built-in "Initial" state. State transitions for Custom Line Items are managed on the Order. |
taxCategory | Used to select a Tax Rate when a Cart has the Platform TaxMode. |
taxCategoryRef | Used to select a Tax Rate when a Cart has the Platform TaxMode. |
taxRate |
|
taxedPrice | Automatically set after the taxRate is set. |
taxedPricePortionsArray of MethodTaxedPrice | Total taxed prices based on the quantity of the Custom Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode.
Automatically set after perMethodTaxRate is set. |
perMethodTaxRateArray of MethodTaxRate | Tax Rate per Shipping Method for a Cart with Multiple ShippingMode. For a Cart with Platform TaxMode it is automatically set after the Shipping Method is added.
For a Cart with External TaxMode, the Tax Rate must be set with ExternalTaxRateDraft. |
discountedPricePerQuantityArray of DiscountedLineItemPriceForQuantity | Discounted price of a single quantity of the Custom Line Item. |
custom | Custom Fields of the Custom Line Item. |
shippingDetails | Container for Custom Line Item-specific addresses. |
priceMode | Indicates whether Cart Discounts with a matching CartDiscountCustomLineItemsTarget, MultiBuyCustomLineItemsTarget, or CartDiscountPatternTarget are applied to the Custom Line Item. Can be External, or Standard |
recurrenceInfo | Recurring Order and frequency data. |
CustomLineItemPriceMode
External- Cart discounts are deactivated for the custom line items with this price mode.
Standard- This is the default mode.
CustomLineItemRecurrenceInfo
The RecurrenceInfo returned in a CustomLineItem
recurrencePolicy | |
recurrencePolicyRef | |
expiresAt |
TaxedPrice
totalNet | Total net price of the Cart or Order. |
totalGross | Total gross price of the Cart or Order. |
taxPortionsArray of TaxPortion | Taxable portions added to the total net price. Calculated from the TaxRates. |
totalTax | Total tax applicable for the Cart or Order. Automatically calculated as the difference between the totalGross and totalNet values. |
TaxMode
Disabled- No taxes are added to the cart.
External- The tax rates are set externally per ExternalTaxRateDraft. A cart with this tax mode can only be ordered if all line items, all custom line items and the shipping method have an external tax rate set. The totalNet and totalGross as well as the taxPortions fields are calculated according to the taxRoundingMode.
ExternalAmount- The tax amounts and the tax rates as well as the tax portions are set externally per ExternalTaxAmountDraft. A cart with this tax mode can only be ordered if the cart itself and all line items, all custom line items and the shipping method have an external tax amount and rate set
Platform- The tax rates are selected from the TaxCategories based on the cart shipping address. The totalNet and totalGross as well as the taxPortions fields are calculated according to the taxRoundingMode.
RoundingMode
HalfDown- [Round half down](https://en.wikipedia.org/wiki/Rounding#Round_half_down)
HalfEven- [Round half to even](https://en.wikipedia.org/wiki/Rounding#Round_half_to_even). Default rounding mode as used in IEEE 754 computing functions and operators.
HalfUp- [Round half up](https://en.wikipedia.org/wiki/Rounding#Round_half_up)
TaxCalculationMode
LineItemLevel- Default. This calculation mode calculates the taxes after the unit price is multiplied with the quantity. E.g. `($1.08 * 3 = $3.24) * 1.19 = $3.8556 -> $3.86 rounded`
UnitPriceLevel- This calculation mode calculates the taxes on the unit price before multiplying with the quantity. E.g. `($1.08 * 1.19 = $1.2852 -> $1.29 rounded) * 3 = $3.87`
ShippingInfo
shippingMethodNameString | Name of the Shipping Method. |
price | Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the shippingRateInput field. |
shippingRate | Used to determine the price. |
taxRate | |
deliveriesArray of Delivery | Information on how items are delivered to customers. |
discountedPrice | Discounted price of the Shipping Method. |
shippingMethodState | Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the Cart. Can be DoesNotMatchCart, or MatchesCart |
estimatedDelivery | Estimated time window during which the shipment is expected to be delivered.
This value is removed if the Cart's shippingAddress changes. |
messageString | |
shippingMethod | Not set if a custom Shipping Method is used. |
shippingMethodRef | Not set if a custom Shipping Method is used. |
taxCategory | Used to select a Tax Rate when a Cart has the Platform TaxMode. |
taxCategoryRef | Used to select a Tax Rate when a Cart has the Platform TaxMode. |
taxedPrice | Automatically set after the taxRate is set. |
Delivery
Contains information on how items are shipped to Customers, for example, a delivery note.
idString | Unique identifier of the Delivery. |
keyString | User-defined identifier of the Delivery. Unique among Deliveries in the Order. |
createdAt | Date and time (UTC) the Delivery was created. |
itemsArray of DeliveryItem | Line Items or Custom Line Items that are delivered. |
parcelsArray of Parcel | Information regarding the appearance, content, and shipment of a Parcel. |
address | Address to which Parcels are delivered. |
custom | Custom Fields of the Delivery. |
DeliveryItem
idString | |
quantityLong | Quantity of Line Items or Custom Line Items delivered. |
Parcel
Information regarding the appearance, content, and shipment of a Parcel.
idString | Unique identifier of the Parcel. |
keyString | User-defined unique identifier of the Parcel. |
createdAt | Date and time (UTC) the Parcel was created. |
measurements | Information about the dimensions of the Parcel. |
trackingData | Shipment tracking information of the Parcel. |
itemsArray of DeliveryItem | Line Items or Custom Line Items delivered in this Parcel. |
custom | Custom Fields of the Parcel. |
ParcelMeasurements
heightInMillimeterInt | Height of the Parcel. |
lengthInMillimeterInt | Length of the Parcel. |
widthInMillimeterInt | Width of the Parcel. |
weightInGramInt | Weight of the Parcel. |
TrackingData
Information that helps track a Parcel.
trackingIdString | Identifier to track the Parcel. |
carrierString | Name of the carrier that delivers the Parcel. |
providerString | Name of the provider that serves as facade to several carriers. |
providerTransactionString | Transaction identifier with the provider. |
isReturnBoolean | Whether the Parcel is being returned. If false, the Parcel is being delivered to the customer. |
ShippingMethodState
DoesNotMatchCart- The ShippingMethod predicate does not match the cart. Ordering this cart will fail with error ShippingMethodDoesNotMatchCart
MatchesCart- Either there is no predicate defined for the ShippingMethod or the given predicate matches the cart
EstimatedDelivery
Estimated time window during which a shipment is expected to be delivered. The window is anchored to the selected Shipping Method and the shipping destination.
DirectDiscount
idString | Unique identifier of the Direct Discount. |
value | Effect of the Discount on the Cart. |
target | Segment of the Cart that is discounted. Absent if the value is giftLineItem. |
participateInBestDealSelectionBoolean |
|
CartDiscountValue
typeString |
CartDiscountTarget
typeString |
ShippingRateInput
typeString |
QuoteState
AcceptedDeclinedDeclinedForRenegotiationPendingRenegotiationAddressedWithdrawn
QuoteQueryResult
Input types
QuoteDraft
keyString | User-defined unique identifier for the Quote. |
stagedQuote | StagedQuote from which the Quote is created. |
stagedQuoteVersionLong | Current version of the StagedQuote. |
stagedQuoteStateToSentBoolean | Default: false |
custom | Custom Fields to be added to the Quote.
|
state | State of the Quote.
This reference can point to a State in a custom workflow. |
QuoteUpdateAction
changeCustomer | |
changeQuoteState | |
requestQuoteRenegotiation | |
setCustomField | |
setCustomType | |
transitionState |
Update actions
General
Change Customer
customer | New Customer to own the Quote. |
Request Quote Renegotiation
buyerCommentString |
State
Change Quote State
quoteState | Can be Accepted, Declined, DeclinedForRenegotiation, Pending, RenegotiationAddressed, or Withdrawn |
QuoteState
AcceptedDeclinedDeclinedForRenegotiationPendingRenegotiationAddressedWithdrawn
Transition State
transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed. This update action produces the Quote State Transition Message.state | Value to set. If there is no State yet, this must be an initial State. |
forceBoolean | Switch validations on or off. Default:false |
Custom Fields
Set Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Custom Field
nameString | Name of the Custom Field. |
valueString | If value is absent or null, this field will be removed if it exists.
Removing a field that does not exist returns an InvalidOperation error.
If value is provided, it is set for the field defined by name. |