Queries and mutations for managing Carts in the platform.
Queries
Query Carts
Get Cart
Get active Cart
Mutations
Create Cart
| Arguments | |
|---|---|
draft | |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
asAssociate | Create/modify entity as an associate in business-unit. |
Update Cart
| Arguments | |
|---|---|
versionLong | |
actionsArray of CartUpdateAction | |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
asAssociate | Create/modify entity as an associate in business-unit. |
idString | Queries with specified ID |
keyString | Queries with specified key |
Delete Cart
| Arguments | |
|---|---|
versionLong | |
personalDataErasureBoolean | Default: false |
storeKey | The mutation is only performed if the resource is part of the store. Can be used with store-specific OAuth permissions. |
asAssociate | Create/modify entity as an associate in business-unit. |
idString | Queries with specified ID |
keyString | Queries with specified key |
Output types
Cart
A shopping cart holds product variants and can be ordered. Each cart either belongs to a registered customer or is an anonymous cart.
customerIdString | id of the Customer that the Cart belongs to. |
customer | |
customerEmailString | Email address of the Customer that the Cart belongs to. |
anonymousIdString | Anonymous session associated with the Cart. |
lineItemsArray of LineItem | Line Items added to the Cart. |
customLineItemsArray of CustomLineItem | Custom Line Items added to the Cart. |
totalPrice | Sum of the
totalPrice field of all LineItems and CustomLineItems, and if available, the price field of ShippingInfo.
If a discount applies on totalPrice, this field holds the discounted value. |
taxedPrice |
If a discount applies on totalPrice, this field holds the proportionally discounted value. |
discountOnTotalPrice | Discounts that apply on the Cart totalPrice. |
shippingAddress | Shipping address for a Cart with Single ShippingMode. Determines eligible ShippingMethod rates. For a Cart with Platform TaxMode, it also determines Tax Rates of Line Items. |
billingAddress | Billing address associated with the Cart. |
inventoryMode | Indicates how stock quantities are tracked for Line Items in the Cart. Can beNone, TrackOnly, ReserveOnOrder, or ReserveOnCart |
taxMode | Indicates how Tax Rates are set. Can beDisabled, External, ExternalAmount, or Platform |
priceRoundingMode | Indicates how the total prices on LineItems and CustomLineItems are rounded when calculated. Configured in Project settings. Can be HalfDown, HalfEven, or HalfUp |
taxRoundingMode | Indicates how monetary values are rounded when calculating taxes for Can be taxedPrice. Configured in Project settings.HalfDown, HalfEven, or HalfUp |
taxCalculationMode | Indicates how taxes are calculated when calculating taxes for Can be taxedPrice.LineItemLevel, or UnitPriceLevel |
customerGroup | Reference to the Customer Group of the Customer that the Cart belongs to. Used for Line Item price selection. |
customerGroupRef | Reference to the Customer Group of the Customer that the Cart belongs to. Used for Line Item price selection. |
country | Used for Line Item price selection. |
shippingKeyString | User-defined unique identifier of the Shipping Method in a Cart with Single ShippingMode. |
shippingInfo | Shipping-related information of a Cart with Single ShippingMode. Automatically set when a Shipping Method is set. |
discountCodesArray of DiscountCodeInfo | Discount Codes applied to the Cart. If directDiscountsIgnoreCartDiscounts is true, a Cart that has directDiscounts cannot have discountCodes. |
directDiscountsArray of DirectDiscount | Direct Discounts added to the Cart. If directDiscountsIgnoreCartDiscounts is true, a Cart that has discountCodes cannot have directDiscounts. |
refusedGiftsArray of CartDiscount | |
refusedGiftsRefsArray of Reference | |
paymentInfo | Payment information related to the Cart. |
locale | Language of the Cart. Must be one of the languages supported by the Project. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
origin | Indicates how the Cart was created. Can beCustomer, Merchant, Quote, or RecurringOrder |
storeRef | Reference to a Store the Cart belongs to. |
store | Reference to a Store the Cart belongs to. |
itemShippingAddressesArray of Address | Additional shipping addresses of the Cart as specified by LineItems using the
shippingDetails field.For Carts with Single ShippingMode: eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses. |
businessUnit | |
businessUnitRef | |
shippingArray of Shipping | Shipping-related information of a Cart with Multiple ShippingMode. Updated automatically each time a new Shipping Method is added. |
taxedShippingPrice | Sum of the
taxedPrice field of ShippingInfo across all Shipping Methods.If a discount applies on totalPrice, this field holds the proportionally discounted value. |
shippingMode | Indicates whether the Cart has one or multiple Shipping Methods. Can beMultiple, or Single |
shippingCustomFields | Custom Fields of the Shipping Method in a Cart with Single ShippingMode. |
placement | Can be InStore, or Online |
discountTypeCombination | Indicates if a combination of discount types can apply on a Cart. |
cartState | Current status of the Cart. Can beActive, Frozen, Merged, or Ordered |
keyString | User-defined unique identifier of the Cart. |
purchaseOrderNumberString | User-defined identifier of a purchase order. It is typically set by the Buyer or Merchant to track the purchase order during the quote and order flow. |
directDiscountsIgnoreCartDiscountsBoolean |
|
lock | Indicates whether the Cart has been locked, preventing edits. |
custom | Custom Fields of the Cart. |
deleteDaysAfterLastModificationInt | Number of days after the last modification before a Cart is deleted. Configured in Project settings. |
totalLineItemQuantityLong | Sum of all LineItem quantities, excluding CustomLineItems. Only present when the Cart has at least one LineItem. |
recurringPaymentConfiguration | Determines how the Orders generated by a RecurringOrder based on this Cart are paid for. Only evaluated on Carts with the RecurringOrder CartOrigin. |
freezeStrategy | Determines freezing behavior when Can be cartState is Frozen.HardFreeze, or SoftFreeze |
warningsArray of TypedWarning | Warnings from the latest cart mutation. Not persisted and only available in mutation responses. |
idString | Unique identifier of the Cart. |
versionLong | Current version of the Cart. |
createdAt | Date and time (UTC) the Cart was initially created. |
lastModifiedAt | Date and time (UTC) the Cart was last updated. |
createdBy | IDs and references that created the Cart. |
lastModifiedBy | IDs and references that last modified the Cart. |
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. |
DiscountOnTotalPrice
discountedAmount | Money value of the discount on the total price of the Cart or Order. |
includedDiscountsArray of DiscountedTotalPricePortion | Discounts that impact the total price of the Cart or Order. |
discountedNetAmount | Money value of the discount on the total net price of the Cart or Order. The same percentage of discount applies as on the discountedAmount.
Present only when taxedPrice of the Cart or Order exists. |
discountedGrossAmount | Money value of the discount on the total gross price of the Cart or Order. The same percentage of discount applies as on the discountedAmount.
Present only when taxedPrice of the Cart or Order exists. |
DiscountedTotalPricePortion
discount | |
discountRef | |
discountedAmount | Money value of the discount. |
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.
DiscountCodeInfo
discountCodeRef | Discount Code associated with the Cart or Order. |
state | Indicates the state of the Discount Code applied to the Cart or Order. Can beApplicationStoppedByGroupBestDeal, ApplicationStoppedByPreviousDiscount, DoesNotMatchCart, MatchesCart, MaxApplicationReached, NotActive, or NotValid |
discountCode | Discount Code associated with the Cart or Order. |
DiscountCodeState
ApplicationStoppedByGroupBestDealApplicationStoppedByPreviousDiscount- The discount code is active and none of the discounts were applied because the discount application was stopped by one discount that has the StackingMode of StopAfterThisDiscount defined
DoesNotMatchCart- The discount code is active and it contains at least one active and valid CartDiscount. But its cart predicate does not match the cart or none of the contained active discount’s cart predicates match the cart
MatchesCart- The discount code is active and it contains at least one active and valid CartDiscount. The discount code cartPredicate matches the cart and at least one of the contained active discount’s cart predicates matches the cart.
MaxApplicationReached- maxApplications or maxApplicationsPerCustomer for discountCode has been reached.
NotActive- The discount code is not active or it does not contain any active cart discounts.
NotValid- The discount code is not valid or it does not contain any valid cart discounts. Validity is determined based on the validFrom and validUntil dates
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 |
CartOrigin
Customer- The cart was created by the customer. This is the default value
Merchant- The cart was created by the merchant on behalf of the customer
Quote- The cart was created by our platform and belongs to a Quote.
RecurringOrder- The cart was created by the merchant as a recurring order.
Shipping
shippingKeyString | User-defined unique identifier of the Shipping in a Cart with Multiple ShippingMode. |
shippingInfo | Automatically set when the Shipping Method is added. |
shippingAddress | Determines the shipping rates and Tax Rates of associated Line Items. |
shippingRateInput | Used as an input to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
shippingCustomFields | Custom Fields of Shipping with Multiple ShippingMode. |
ShippingMode
Multiple- Allows multiple shipping methods for the cart with their respective shipping addresses
Single- Allows only one shipping method and shipping address for the cart
Placement
InStore- The Order or Cart is placed in-store.
Online- The Order or Cart is placed online.
DiscountTypeCombination
typeString |
CartState
Active- The cart can be updated and ordered. It is the default state.
Frozen- The cart is frozen. The cart is ready for checkout and a few update actions are not allowed.
Merged- Anonymous cart whose content was merged into a customers cart on signin. No further operations on the cart are allowed.
Ordered- The cart was ordered. No further operations on the cart are allowed.
CartLock
manage_locked_carts OAuth scope.createdAt | Date and time (UTC) the Cart was locked. |
clientIdString | id of the API Client that locked the Cart. |
RecurringPaymentConfiguration
RecurringOrder CartOrigin.paymentStrategy | Checkout |
paymentAllocationsArray of RecurringPaymentAllocation | Payment Methods charged for the Orders generated by the RecurringOrder, and the share of the Order total charged to each of them. |
PaymentStrategy
Checkout
RecurringPaymentAllocation
idString | Unique identifier of the RecurringPaymentAllocation within the RecurringPaymentConfiguration. Use it to remove the allocation with the Remove RecurringPaymentAllocation update action. |
paymentMethodRef | Payment Method charged for this share of the Order total. |
paymentMethod | Payment Method charged for this share of the Order total. |
allocation | Share of the Order total charged to the paymentMethod. |
AllocationInterface
typeString |
FreezeStrategy
HardFreeze- Stricter version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
SoftFreeze- More lenient version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
TypedWarning
A non-fatal warning that occurred during a mutation.
code | Can be CannotChangeReservationExpiry, CannotCreateReservation, CannotUpdateReservation, DefaultVariantDeleted, General, ImageProcessingOngoing, or StoreSettingOngoing |
messageString |
TypedWarningCode
CannotChangeReservationExpiryCannotCreateReservationCannotUpdateReservationDefaultVariantDeletedGeneralImageProcessingOngoingStoreSettingOngoing
Cart Query Result
Input types
CartDraft
currency | Currency the Cart uses. |
country | Used for Line Item price selection.
If used for Create Cart in Store, the provided country must be one of the Store's countries. |
inventoryMode | Determines how stock quantities are tracked for Line Items in the Cart. Can beNone, TrackOnly, ReserveOnOrder, or ReserveOnCartDefault: None |
custom | Custom Fields for the Cart. |
customerEmailString | Email address of the Customer that the Cart belongs to. |
shippingAddress | Shipping address for a Cart with Single ShippingMode. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
Must be one of the itemShippingAddresses when that field is also provided. |
billingAddress | Billing address associated with the Cart. |
shippingMethod | Shipping Method for a Cart with Single ShippingMode. If the referenced ShippingMethod has a predicate that does not match the Cart, an InvalidOperation error is returned when creating a Cart. |
taxMode | Determines how Tax Rates are set. Can beDisabled, External, ExternalAmount, or PlatformDefault: Platform |
locale | Language of the Cart. Must be one of the languages supported by the Project. |
deleteDaysAfterLastModificationInt | Number of days after the last modification before a Cart is deleted.
If not provided, the default value for this field configured in Project settings is assigned.
Create a ChangeSubscription for Carts to receive a ResourceDeletedDeliveryPayload upon deletion of the Cart. |
itemShippingAddressesArray of AddressInput | Multiple shipping addresses of the Cart. Each address must contain a
key that is unique in this Cart.
The keys are used by LineItems to reference these addresses under their shippingDetails.For Carts with Default: Single ShippingMode: eligible Shipping Methods or applicable Tax Rates are determined by the address shippingAddress, and not itemShippingAddresses.[] |
discountCodesArray of String | code of the existing DiscountCodes to add to the Cart.[] |
store | ResourceIdentifier to the Store the Cart should belong to. Once set, it cannot be updated. |
businessUnit | ResourceIdentifier to the Business Unit the Cart should belong to. When the customerId of the Cart is also set, the Customer must be an Associate of the Business Unit. Only available for B2B-enabled Projects. |
purchaseOrderNumberString | User-defined identifier of a purchase order. It is typically set by the Buyer or Merchant to track the purchase order during the quote and order flow. |
shippingMode |
Multiple, or SingleDefault: Single |
customShippingArray of CustomShippingDraft | Custom Shipping Methods for a Cart with Default: Multiple ShippingMode.[] |
shippingArray of ShippingDraft | Shipping Methods for a Cart with Default: Multiple ShippingMode.[] |
keyString | User-defined unique identifier for the Cart. |
lineItemsArray of LineItemDraft | Line Items to add to the Cart. Default: [] |
customLineItemsArray of CustomLineItemDraft | Custom Line Items to add to the Cart. Default: [] |
customerIdString | id of the Customer that the Cart belongs to. |
externalTaxRateForShippingMethod | |
anonymousIdString | Anonymous session associated with the Cart. |
priceRoundingMode | Determines how the total prices on LineItems and CustomLineItems are rounded when calculated. If not set, the default value configured in the Project is used. Can be HalfDown, HalfEven, or HalfUpDefault: HalfEven |
taxRoundingMode | Determines how monetary values are rounded when calculating taxes for Can be taxedPrice. If not set, the default value configured in the Project is used.HalfDown, HalfEven, or HalfUpDefault: HalfEven |
taxCalculationMode | Determines how taxes are calculated for Can be taxedPrice.LineItemLevel, or UnitPriceLevelDefault: LineItemLevel |
customerGroup | ResourceIdentifier to the Customer Group of the Customer that the Cart belongs to. Used for Line Item price selection.
You can set either a customerId or a customerGroup.
If the Customer referenced in customerId belongs to a Customer Group then customerGroup is set automatically. |
shippingRateInput | Used as an input to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
origin | Indicates how the Cart was created. Can beCustomer, Merchant, Quote, or RecurringOrderDefault: Customer |
directDiscountsIgnoreCartDiscountsBoolean |
|
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.
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.
ShippingMode
Multiple- Allows multiple shipping methods for the cart with their respective shipping addresses
Single- Allows only one shipping method and shipping address for the cart
CustomShippingDraft
keyString | User-defined unique identifier of the custom Shipping Method in the Cart with Multiple ShippingMode. |
shippingMethodNameString | Name of the custom Shipping Method. |
shippingAddress | Determines the shipping rate and Tax Rate of the associated Line Items. |
shippingRate | Determines the shipping price. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
taxCategory | Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode. |
externalTaxRate | Tax Rate used to tax a shipping expense if the Cart has the External TaxMode. |
deliveriesArray of DeliveryDraft | Deliveries to be shipped with the custom Shipping Method. |
custom | Custom Fields for the custom Shipping Method. |
ShippingRateInputDraft
Classification | |
Score |
ClassificationShippingRateInputDraft
keyString | Key of the value used as a programmatic identifier. |
ScoreShippingRateInputDraft
scoreInt | Abstract value for categorizing a Cart. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
DeliveryDraft
keyString | User-defined identifier of the Delivery. Must be unique among Deliveries in the Order. |
itemsArray of DeliveryItemDraftType | Line Items or Custom Line Items to deliver.
It can also be specified individually for each Parcel. |
parcelsArray of ParcelDraft | Information regarding the appearance, content, and shipment of a parcel. |
address | Address to which the Parcels are delivered. |
custom | Custom Fields for the Delivery. |
DeliveryItemDraftType
idString | |
quantityLong |
ParcelDraft
idString | |
keyString | |
createdAt | |
measurements | |
trackingData | |
itemsArray of DeliveryItemDraftType | Default: [] |
custom |
ParcelMeasurementsDraftType
heightInMillimeterInt | |
lengthInMillimeterInt | |
widthInMillimeterInt | |
weightInGramInt |
TrackingDataDraftType
trackingIdString | |
carrierString | |
providerString | |
providerTransactionString | |
isReturnBoolean | Default: false |
ShippingDraft
Wraps all shipping-related information (such as address, rate, deliveries) per Shipping Method for Carts with multiple Shipping Methods.
keyString | User-defined unique identifier for the Shipping in a Cart with Multiple ShippingMode. |
shippingMethod | Shipping Methods added to the Cart with Multiple ShippingMode. |
shippingAddress | Determines the shipping rate and Tax Rate of the associated Line Items. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
externalTaxRate | Tax Rate used for taxing a shipping expense if the Cart has the External TaxMode. |
deliveriesArray of DeliveryDraft | Deliveries to be shipped with the Shipping Method. |
custom | Custom Fields for Shipping. |
LineItemDraft
productId and variantId, or sku must be provided.
Product Attributes are merged with Variant Attributes to ensure the full Attribute context of the Product Variant.keyString | User-defined identifier of the LineItem. Must be unique among LineItems in the Cart. |
productIdString | id of a published Product. |
skuString | sku of the ProductVariant. |
quantityLong | Quantity of the Product Variant to add to the Cart. |
variantIdInt | id of the ProductVariant in the Product.
If not provided, the Master Variant is used. |
supplyChannel | Used to identify Inventory entries that must be reserved.
The referenced Channel must have the InventorySupply ChannelRoleEnum. |
distributionChannel | Used to select a Product Price.
The referenced Channel must have the
ProductDistribution ChannelRoleEnum.If the Cart is bound to a Store with distributionChannels set,
the Channel must match one of the Store's distribution channels. |
custom | Custom Fields for the Line Item. |
shippingDetails | Container for Line Item-specific addresses. |
addedAt | Date and time (UTC) the Line Item was added to the Cart. If not set, it defaults to the current date and time. Optional for backwards compatibility reasons. |
recurrenceInfo | Recurring Order and frequency data. |
externalTaxRate | Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored. |
externalPrice | To set the money value in high precision, use HighPrecisionMoneyDraft. |
externalTotalPrice | Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode. |
perMethodExternalTaxRateArray of MethodExternalTaxRateDraft | Sets the external Tax Rates for individual Shipping Methods, if the Cart has the Default: External TaxMode and Multiple ShippingMode.[] |
inventoryMode | Inventory mode specific to the Line Item only, and valid for the entire Can be quantity of the Line Item.
Set only if the inventory mode should be different from the inventoryMode specified on the Cart.None, TrackOnly, ReserveOnOrder, or ReserveOnCart |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
LineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt | |
priceSelectionMode | Can be Dynamic, or Fixed |
BaseMoneyInput
centPrecision | |
highPrecision |
ExternalLineItemTotalPriceDraft
price | |
totalPrice |
MethodExternalTaxRateDraft
shippingMethodKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
taxRate | External Tax Rate for the Shipping Method, if the Cart has External TaxMode. |
CustomLineItemDraft
nameArray of LocalizedStringItemInputType | Name of the Custom Line Item. |
keyString | User-defined identifier of the Custom Line Item. Must be unique among Custom Line Items in the Cart. |
money | Money value of the Custom Line Item. The value can be negative. To set the money value in high precision, use HighPrecisionMoneyDraft. |
slugString | User-defined identifier used in a deep-link URL for the Custom Line Item.
It must match the pattern [a-zA-Z0-9_-]{2,256}. |
taxCategory | |
externalTaxRate | External Tax Rate for the Custom Line Item if the Cart has the External TaxMode. |
quantityLong | Number of Custom Line Items to add to the Cart. |
custom | Custom Fields for the Custom Line Item. |
shippingDetails | Container for Custom Line Item-specific addresses. |
priceMode |
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.
CustomLineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt |
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`
CartOrigin
Customer- The cart was created by the customer. This is the default value
Merchant- The cart was created by the merchant on behalf of the customer
Quote- The cart was created by our platform and belongs to a Quote.
RecurringOrder- The cart was created by the merchant as a recurring order.
CartUpdateAction
addCustomShippingMethod | |
addDiscountCode | |
addItemShippingAddress | |
addPayment | |
addShippingMethod | |
addShoppingList | |
changeCustomLineItemMoney | |
changeCustomLineItemPriceMode | |
changeCustomLineItemQuantity | |
changeLineItemsOrder | |
changePriceRoundingMode | |
changeTaxCalculationMode | |
changeTaxMode | |
changeTaxRoundingMode | |
recalculate | |
removeCustomLineItem | |
removeDiscountCode | |
removeItemShippingAddress | |
removeLineItem | |
removePayment | |
removeShippingMethod | |
setAnonymousId | |
setBillingAddress | |
setBillingAddressCustomField | |
setBillingAddressCustomType | |
setBusinessUnit | |
setKey | |
setCartTotalTax | |
setCountry | |
setCustomField | |
setCustomLineItemCustomField | |
setCustomLineItemCustomType | |
setCustomLineItemShippingDetails | |
setCustomLineItemTaxAmount | |
setCustomLineItemTaxRate | |
setCustomShippingMethod | |
setCustomType | |
setCustomerEmail | |
setCustomerGroup | |
setCustomerId | |
setDeleteDaysAfterLastModification | |
setDirectDiscounts | |
setDirectDiscountsIgnoreCartDiscounts | |
setEstimatedDelivery | |
setItemShippingAddressCustomField | |
setItemShippingAddressCustomType | |
setLineItemCustomField | |
setLineItemCustomType | |
setLineItemDistributionChannel | |
setLineItemInventoryMode | |
setLineItemPrice | |
setLineItemShippingDetails | |
setLineItemSupplyChannel | |
setLineItemTaxAmount | |
setLineItemTaxRate | |
setLineItemTotalPrice | |
setLocale | |
setPurchaseOrderNumber | |
setShippingAddress | |
setShippingAddressCustomField | |
setShippingAddressCustomType | |
setShippingCustomField | |
setShippingCustomType | |
setShippingMethod | |
setShippingMethodTaxAmount | |
setShippingMethodTaxRate | |
setShippingRateInput | |
updateItemShippingAddress | |
freezeCart | |
unfreezeCart | |
lockCart | |
unlockCart | |
applyDeltaToLineItemShippingDetailsTargets | |
applyDeltaToCustomLineItemShippingDetailsTargets | |
addLineItem | |
addCustomLineItem | |
setLineItemRecurrenceInfo | |
setCustomLineItemRecurrenceInfo | |
setReservationExpirationInMinutes | BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta |
changeLineItemQuantity | |
setRecurringPaymentConfiguration | |
setRecurringPaymentStrategy | |
addRecurringPaymentAllocation | |
removeRecurringPaymentAllocation |
Update actions
on Cart
Set Key
keyString | Value to set. If omitted, any existing key is removed. |
Set Customer ID
id cannot be found, this update action returns a
ReferencedResourceNotFound error.customerIdString | id of an existing Customer.
If the Customer is assigned to a CustomerGroup, this update action also sets the value for the customerGroup field.
If omitted, the update action removes the value for both customerId and customerGroup. |
Set Customer Email
emailString | Value to set. If omitted, any existing value is removed. |
Set Customer Group
This update action can only be used if a Customer is not assigned to the Cart. If a Customer is already assigned, the Cart uses the Customer Group of the assigned Customer.
customerGroup | Value to set. If omitted, any existing value is removed. |
Set Anonymous ID
anonymousIdString | Value to set. If omitted, any existing value is removed. |
Set Purchase Order Number
purchaseOrderNumber field and produces the CartPurchaseOrderNumberSet Message.purchaseOrderNumberString | Value to set. If omitted, any existing value is removed. |
Set Business Unit B2B B2X
Updates the Business Unit on the Cart. The Cart must have an existing Business Unit assigned already.
businessUnit | New Business Unit to assign to the Cart, which must have access to the Store that is set on the Cart. |
Add LineItem
shippingDetails is set, it is merged. All addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up.
A new Line Item is added when the externalPrice or externalTotalPrice is set in this update action.
The LineItem price is set as described in Line Item price selection.priceMode value for a selected currency and/or country, Customer Group, or Channel, a MatchingPriceNotFound error is returned.keyString | User-defined identifier of the LineItem. Must be unique among LineItems in the Cart. |
productIdString | id of the published Product.Either the productId and variantId, or sku must be provided. |
skuString | SKU of the ProductVariant.
Either the productId and variantId, or sku must be provided. |
quantityLong | Quantity of the Product Variant to add to the Cart. |
variantIdInt | id of the ProductVariant in the Product.
If omitted, the Master Variant is used.Either the productId and variantId, or sku must be provided. |
supplyChannel | Used to identify Inventory entries that must be reserved.
The Channel must have the InventorySupply ChannelRoleEnum. |
distributionChannel | Used to select a Product Price.
The Channel must have the ProductDistribution ChannelRoleEnum.
If the Cart is bound to a Store with distributionChannels set, the Channel must match one of the Store's distribution channels. |
custom | Custom Fields for the Line Item. |
shippingDetails | Container for Line Item-specific addresses. |
addedAt | Date and time (UTC) the Line Item was added to the Cart. If not set, it defaults to the current date and time. Optional for backwards compatibility reasons. |
recurrenceInfo | Recurring Order and frequency data. |
externalTaxRate | Sets the external Tax Rate for the Line Item, if the Cart has the External TaxMode and Single ShippingMode. If the Cart has Multiple ShippingMode, the Tax Rate is accepted but ignored. |
externalPrice | To set the money value in high precision, use HighPrecisionMoneyDraft. |
externalTotalPrice | Sets the LineItem price and totalPrice values, and the priceMode to ExternalTotal LineItemPriceMode. |
perMethodExternalTaxRateArray of MethodExternalTaxRateDraft | Sets the external Tax Rates for individual Shipping Methods, if the Cart has the Default: External TaxMode and Multiple ShippingMode.[] |
inventoryMode | Inventory mode specific to the Line Item only, and valid for the entire Can be quantity of the Line Item.
Set only if the inventory mode should be different from the inventoryMode specified on the Cart.None, TrackOnly, ReserveOnOrder, or ReserveOnCart |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
LineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt | |
priceSelectionMode | Can be Dynamic, or Fixed |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
BaseMoneyInput
centPrecision | |
highPrecision |
ExternalLineItemTotalPriceDraft
price | |
totalPrice |
MethodExternalTaxRateDraft
shippingMethodKeyString | User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode. |
taxRate | External Tax Rate for the Shipping Method, if the Cart has External TaxMode. |
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.
Remove LineItem
lineItemIdString | |
quantityLong | Amount to subtract from the LineItem quantity. If omitted, the LineItem is removed from the Cart. |
lineItemKeyString | |
externalPrice | Sets the LineItem
price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.To set the money value in high precision, use HighPrecisionMoneyDraft. |
externalTotalPrice | Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode. |
shippingDetailsToRemove | Container for Line Item-specific addresses to remove. |
BaseMoneyInput
centPrecision | |
highPrecision |
ExternalLineItemTotalPriceDraft
price | |
totalPrice |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
Change LineItems Order
lineItemOrderArray of String | All existing LineItem ids in the desired new order. |
Add CustomLineItem
slug, name, money, taxCategory, state,
and Custom Fields, then only the quantity of the existing Custom Line Item is increased.
If CustomLineItem shippingDetails are set, they are merged with the targets that already exist on the
ItemShippingDetails of the Custom Line Item.
In case of overlapping address keys the ItemShippingTarget quantity is summed up.nameArray of LocalizedStringItemInputType | Name of the Custom Line Item. |
keyString | User-defined identifier of the Custom Line Item. Must be unique among Custom Line Items in the Cart. |
money | Money value of the Custom Line Item. The value can be negative. To set the money value in high precision, use HighPrecisionMoneyDraft. |
slugString | User-defined identifier used in a deep-link URL for the Custom Line Item.
It must match the pattern [a-zA-Z0-9_-]{2,256}. |
taxCategory | |
externalTaxRate | An external Tax Rate can be set if the Cart has External TaxMode. |
quantityLong | Number of Custom Line Items to add to the Cart. |
custom | Custom Fields for the Custom Line Item. |
shippingDetails | Container for Custom Line Item-specific addresses. |
priceMode |
External, or Standard |
recurrenceInfo | Recurring Order and frequency data. |
BaseMoneyInput
centPrecision | |
highPrecision |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
CustomLineItemPriceMode
External- Cart discounts are deactivated for the custom line items with this price mode.
Standard- This is the default mode.
CustomLineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt |
Remove CustomLineItem
shippingDetails must be partially removed, use the Change CustomLineItem Quantity update action.customLineItemIdString | |
customLineItemKeyString |
Add Shopping List
shoppingList | Shopping List that contains the Line Items to be added. |
supplyChannel | supplyChannel to set for all LineItems that are added to the Cart.
The Channel must have the InventorySupply ChannelRoleEnum. |
distributionChannel | distributionChannel to set for all LineItems that are added to the Cart.
The Channel must have the ProductDistribution ChannelRoleEnum. |
Set Cart Total Tax
externalTotalGross | |
externalTaxPortionsArray of TaxPortionDraft | Default: [] |
TaxPortionDraft
totalGross field of a TaxedPrice.nameString | Name of the tax portion. |
rateFloat | A number in the range 0-1. |
amount | Money value for the tax portion. |
Change TaxMode
- When
ExternalTaxMode is changed toPlatformorDisabled, all previously set external Tax Rates are removed. - When set to
Platform, Line Items, Custom Line Items, and Shipping Method require a Tax Category with a Tax Rate for the Cart'sshippingAddress.
taxMode | The new TaxMode. Can beDisabled, External, ExternalAmount, or Platform |
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.
Change Price RoundingMode
priceRoundingMode | New value to set. Can beHalfDown, HalfEven, or HalfUp |
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)
Change Tax RoundingMode
taxRoundingMode | New value to set. Can beHalfDown, HalfEven, or HalfUp |
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)
Change TaxCalculationMode
taxCalculationMode | New value to set. Can beLineItemLevel, or UnitPriceLevel |
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`
Add DiscountCode
codeString | |
validateDuplicatesBoolean | Default: false |
Remove DiscountCode
discountCode | Discount Code to remove from the Cart. |
Set DirectDiscounts
directDiscountsIgnoreCartDiscounts is true, Direct Discounts can only be added when no DiscountCode has been added to the Cart.discountsArray of DirectDiscountDraft |
|
DirectDiscountDraft
value | Defines the effect the Discount will have. |
target | Defines what segment of the Cart will be discounted. If value is set to giftLineItem, this must not be set. |
participateInBestDealSelectionBoolean |
|
CartDiscountValueInput
relative | |
relativeCart | |
absolute | |
absoluteCart | |
fixed | |
fixedCart | |
giftLineItem |
RelativeDiscountValueInput
permyriadInt |
RelativeCartDiscountValueInput
permyriadInt | |
applicationMode | Can be ProportionateDistribution, EvenDistribution, or IndividualApplication |
DiscountApplicationMode
ProportionateDistributionEvenDistributionIndividualApplication
AbsoluteDiscountValueInput
moneyArray of MoneyInput |
AbsoluteCartDiscountValueInput
moneyArray of MoneyInput | |
applicationMode | Can be ProportionateDistribution, EvenDistribution, or IndividualApplication |
FixedPriceDiscountValueInput
moneyArray of CartDiscountValueBaseMoneyInput |
CartDiscountValueBaseMoneyInput
centPrecision | |
highPrecision | |
currencyCode | CurrencyCode and centAmount are deprecated. Please use Money(centPrecision) or HighPrecisionMoney(highPrecision). |
centAmountLong | CurrencyCode and centAmount are deprecated. Please use Money(centPrecision) or HighPrecisionMoney(highPrecision). |
FixedPriceCartDiscountValueInput
moneyArray of CartDiscountValueBaseMoneyInput | |
applicationMode | Can be ProportionateDistribution, EvenDistribution, or IndividualApplication |
GiftLineItemValueInput
product | |
variantIdInt | |
distributionChannel | |
supplyChannel |
CartDiscountTargetInput
lineItems | |
customLineItems | |
shipping | |
multiBuyLineItems | |
multiBuyCustomLineItems | |
totalPrice | |
pattern |
LineItemsTargetInput
predicateString |
CustomLineItemsTargetInput
predicateString |
ShippingTargetInput
dummyString |
MultiBuyLineItemsTargetInput
SelectionMode
CheapestMostExpensive
MultiBuyCustomLineItemsTargetInput
CartDiscountTotalPriceTargetInput
dummyString |
CartDiscountPatternTargetInput
triggerPatternArray of PatternComponentInput | |
targetPatternArray of PatternComponentInput | |
maxOccurrenceInt | |
selectionMode | Can be Cheapest, or MostExpensive |
PatternComponentInput
CountOnLineItemUnits | |
CountOnCustomLineItemUnits |
CountOnLineItemUnitsInput
predicateString | |
minCountInt | Default: 1 |
maxCountInt | |
excludeCountInt |
CountOnCustomLineItemUnitsInput
predicateString | |
minCountInt | Default: 1 |
maxCountInt | |
excludeCountDEPRECATEDInt | Please use 'triggerPattern' to exclude. |
Set DirectDiscountsIgnoreCartDiscounts
directDiscountsIgnoreCartDiscountsBoolean |
The value can be set to
true only if the Cart does not have both discountCodes and directDiscounts.
|
Add Payment
payment | Payment to add to the Cart. Must not be assigned to another Order or active Cart already. |
Remove Payment
payment | Payment to remove from the Cart. |
Set Billing Address
address | Value to set. It replaces the entire address, including Custom Fields if
custom is not included. To preserve Custom Fields, include the custom object in the request.If omitted, any existing value is removed. |
Set Shipping Address
countryTaxRateFallbackEnabled field to true in the CartsConfiguration by using
the Change CountryTaxRateFallbackEnabled update action.address | Value to set. It replaces the entire address, including Custom Fields if
custom is not included. To preserve Custom Fields, include the custom object in the request.If not set, the shipping address is unset, and the taxedPrice and taxRate are unset in all Line Items of the Cart. |
Add ItemShippingAddress
itemShippingAddresses of a Cart. Use this action when shipping is defined per item. For example, when shipping items to multiple addresses or when using different Shipping Methods, even if all items share the same address.address | Address to append to
itemShippingAddresses.The new Address must have a key that is unique across this Cart. |
Remove ItemShippingAddress
addressKeyString | key of the Address to remove from itemShippingAddresses. |
Update ItemShippingAddress
itemShippingAddresses by keeping the Address key.address | The new Address with the same key as the Address it will replace. |
Add ShippingMethod
Multiple ShippingMode.shippingKeyString | User-defined identifier for the Shipping that must be unique across the Cart with Multiple ShippingMode. |
shippingMethod | ResourceIdentifier to a ShippingMethod to add to the Cart with
Multiple ShippingMode.
InvalidOperation error is returned in one of the following cases:
|
externalTaxRate | Tax Rate used to tax a shipping expense if the Cart has the External TaxMode. |
shippingAddress | Determines the shipping rate and Tax Rate of the Line Items. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
custom | Custom Fields for the Shipping Method. |
deliveriesArray of DeliveryDraft | Deliveries to be shipped with the referenced Shipping Method. Default:[] |
estimatedDelivery | Estimated time window during which this shipment is expected to be delivered. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
ShippingRateInputDraft
Classification | |
Score |
ClassificationShippingRateInputDraft
keyString | Key of the value used as a programmatic identifier. |
ScoreShippingRateInputDraft
scoreInt | Abstract value for categorizing a Cart. |
DeliveryDraft
keyString | User-defined identifier of the Delivery. Must be unique among Deliveries in the Order. |
itemsArray of DeliveryItemDraftType | Line Items or Custom Line Items to deliver.
It can also be specified individually for each Parcel. |
parcelsArray of ParcelDraft | Information regarding the appearance, content, and shipment of a parcel. |
address | Address to which the Parcels are delivered. |
custom | Custom Fields for the Delivery. |
DeliveryItemDraftType
idString | |
quantityLong |
ParcelDraft
idString | |
keyString | |
createdAt | |
measurements | |
trackingData | |
itemsArray of DeliveryItemDraftType | Default: [] |
custom |
ParcelMeasurementsDraftType
heightInMillimeterInt | |
lengthInMillimeterInt | |
widthInMillimeterInt | |
weightInGramInt |
TrackingDataDraftType
trackingIdString | |
carrierString | |
providerString | |
providerTransactionString | |
isReturnBoolean | Default: false |
Remove ShippingMethod
Multiple ShippingMode.shippingKeyString | User-defined unique identifier of the Shipping Method to remove from the Cart. |
Set ShippingMethod
shippingMethod | Value to set. If omitted, any existing value is removed. InvalidOperation error is returned in one of the following cases:
|
externalTaxRate | An external Tax Rate can be set if the Cart has the External TaxMode. |
estimatedDelivery | Estimated time window during which the shipment is expected to be delivered.
If not set, any existing estimate on the Cart's ShippingInfo is cleared. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Add Custom ShippingMethod
Multiple ShippingMode.shippingKeyString | User-defined identifier for the custom Shipping Method that must be unique across the Cart with Multiple ShippingMode. |
shippingMethodNameString | Name of the custom Shipping Method. |
shippingAddress | Determines the shipping rate and Tax Rate of the associated Line Items. |
shippingRate | Determines the shipping price. |
shippingRateInput | Input used to select a ShippingRatePriceTier.
The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
taxCategory | Tax Category used to determine a shipping Tax Rate if the Cart has the Platform TaxMode. |
externalTaxRate | Tax Rate used to tax a shipping expense if the Cart has the External TaxMode. |
custom | Custom Fields for the custom Shipping Method. |
deliveriesArray of DeliveryDraft | Deliveries to be shipped with the custom Shipping Method. Default:[] |
ShippingRateInputDraft
Classification | |
Score |
ClassificationShippingRateInputDraft
keyString | Key of the value used as a programmatic identifier. |
ScoreShippingRateInputDraft
scoreInt | Abstract value for categorizing a Cart. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
DeliveryDraft
keyString | User-defined identifier of the Delivery. Must be unique among Deliveries in the Order. |
itemsArray of DeliveryItemDraftType | Line Items or Custom Line Items to deliver.
It can also be specified individually for each Parcel. |
parcelsArray of ParcelDraft | Information regarding the appearance, content, and shipment of a parcel. |
address | Address to which the Parcels are delivered. |
custom | Custom Fields for the Delivery. |
DeliveryItemDraftType
idString | |
quantityLong |
ParcelDraft
idString | |
keyString | |
createdAt | |
measurements | |
trackingData | |
itemsArray of DeliveryItemDraftType | Default: [] |
custom |
ParcelMeasurementsDraftType
heightInMillimeterInt | |
lengthInMillimeterInt | |
widthInMillimeterInt | |
weightInGramInt |
TrackingDataDraftType
trackingIdString | |
carrierString | |
providerString | |
providerTransactionString | |
isReturnBoolean | Default: false |
Set Custom ShippingMethod
Single ShippingMode and a shippingAddress.shippingMethod field instead.shippingMethodNameString | Name of the custom Shipping Method. |
shippingRate | Determines the shipping price. |
taxCategory | Tax Category used to determine the Tax Rate when the Cart has the Platform TaxMode. |
externalTaxRate | |
custom | Custom Fields for the custom Shipping Method. |
estimatedDelivery | Estimated time window during which the shipment is expected to be delivered.
If not set, any existing estimate on the Cart's ShippingInfo is cleared. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Set Estimated Delivery
estimatedDelivery | Value to set. If empty, any existing value is removed. |
shippingKeyString | key of the Shipping to update.
This is required and valid only for Carts with Multiple ShippingMode.
An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode. |
Set ShippingRateInput
shippingRateInput | The data type of this field depends on the
shippingRateInputType.type configured in the Project:
|
ShippingRateInputDraft
Classification | |
Score |
ClassificationShippingRateInputDraft
keyString | Key of the value used as a programmatic identifier. |
ScoreShippingRateInputDraft
scoreInt | Abstract value for categorizing a Cart. |
Set Locale
Set Country
country | Value to set. If omitted, any existing value is removed. If the Cart is bound to a store, the provided value must be included in the Store's countries.
Otherwise a CountryNotConfiguredInStore error is returned. |
Set DeleteDaysAfterLastModification
Number of days after the last modification before a Cart is deleted.
RecurringOrder are not affected by this update action.deleteDaysAfterLastModificationInt | Value to set.
If omitted, the default value for this field configured in Project settings is assigned. |
Set Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set CustomField
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. |
Set Reservation Expiration in Minutes BETA
reservationExpirationInMinutesInt | Value to set. Must be a positive integer. |
Recalculate
priceMode of the Product related to a Line Item is of Embedded ProductPriceMode,
the updated price of that LineItem may not correspond to a Price in the variant.prices anymore.updateProductDataBoolean |
false |
Freeze Cart
dummyString | |
strategy | Can be HardFreeze, or SoftFreeze |
FreezeStrategy
HardFreeze- Stricter version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
SoftFreeze- More lenient version of a Cart freeze (See [Freeze a Cart](https://docs.commercetools.com/api/carts-orders-overview#freeze-a-cart) for details).
Unfreeze Cart
dummyString |
Lock Cart
dummyString |
Unlock Cart
dummyString |
Set RecurringPaymentConfiguration
recurringPaymentConfiguration |
RecurringPaymentConfigurationDraft
paymentStrategy | Checkout |
paymentAllocationsArray of PaymentAllocationDraft | Payment Methods charged for the Orders generated by the Recurring Order, and the share of the Order total charged to each of them. |
PaymentStrategy
Checkout
PaymentAllocationDraft
idString | Unique identifier of the resulting RecurringPaymentAllocation within the RecurringPaymentConfiguration. |
paymentMethod | Payment Method charged for this share of the Order total. |
allocation | Share of the Order total charged to the paymentMethod. |
AllocationInputDraft
Absolute | |
Relative |
AbsoluteInputDraft
amount |
RelativeInputDraft
percentageInt |
Set RecurringPaymentStrategy
paymentStrategy | Checkout |
PaymentStrategy
Checkout
Add RecurringPaymentAllocation
idString | |
paymentMethod | |
allocation |
AllocationInputDraft
Absolute | |
Relative |
AbsoluteInputDraft
amount |
RelativeInputDraft
percentageInt |
Remove RecurringPaymentAllocation
idString |
on Line Item
Change LineItem Quantity
shippingDetails field is kept in its current state to avoid data loss.ReserveOnCart:- If the requested quantity cannot be reserved, the Line Item quantity does not change and a CannotUpdateReservationWarning is returned in the Cart response.
- Changing the quantity of a reserved Line Item also updates the reservation expiration time. To synchronize the expiration across the rest of the Line Items in the Cart, you must call the Set Cart Reservation Expiration in Minutes update action after any Line Item changes.
lineItemIdString | |
lineItemKeyString | |
quantityLong | New value to set. If 0, the Line Item is removed from the Cart. |
externalPrice | Only valid for the general Carts API. Ignored for the My Carts API. |
externalTotalPrice | Only valid for the general Carts API. Ignored for the My Carts API. |
BaseMoneyInput
centPrecision | |
highPrecision |
ExternalLineItemTotalPriceDraft
price | |
totalPrice |
Set LineItem TaxRate
External TaxMode.lineItemIdString | |
externalTaxRate | Value to set. If omitted, any existing value is removed. |
shippingKeyString | key of the ShippingMethod used for this Line Item.
This is required for Carts with Multiple ShippingMode. |
lineItemKeyString |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Set LineItem TaxAmount
ExternalAmount TaxMode. This update action sets the taxedPrice and taxRate on a Line Item and must be used after any price-affecting change occurs.lineItemIdString | |
externalTaxAmount | Value to set. If omitted, any existing value is removed. |
shippingKeyString | key of the ShippingMethod used for this Line Item.
This is required for Carts with Multiple ShippingMode. |
lineItemKeyString |
ExternalTaxAmountDraft
Can only be set by these update actions:
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Carts
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Order Edits
totalGross | Total gross amount ( totalNet + taxPortions) of the Line Item or Custom Line Item. |
taxRate | Tax Rates and subrates of states and countries. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Set LineItem Price
lineItemIdString | |
externalPrice | Value to set.
If
externalPrice is not given and the priceMode is ExternalPrice, the external price is unset and the priceMode is set to Platform.To set the money value in high precision, use HighPrecisionMoneyDraft. |
lineItemKeyString |
BaseMoneyInput
centPrecision | |
highPrecision |
Set LineItem TotalPrice
totalPrice and price, and changes the priceMode to ExternalTotal LineItemPriceMode.
Cannot be used on Gift Line Items (see LineItemMode).lineItemIdString | |
externalTotalPrice | Value to set.
If externalTotalPrice is not given and the priceMode is ExternalTotal, the external price is unset and the priceMode is set to Platform. |
lineItemKeyString |
ExternalLineItemTotalPriceDraft
price | |
totalPrice |
BaseMoneyInput
centPrecision | |
highPrecision |
Set LineItem DistributionChannel
price as described in Line Item price selection.lineItemIdString | |
distributionChannel |
|
lineItemKeyString |
Set LineItem SupplyChannel
TrackOnly or ReserveOnOrder.lineItemIdString | |
supplyChannel |
|
lineItemKeyString |
Set LineItem ShippingDetails
lineItemIdString | |
shippingDetails | Value to set. If omitted, the existing value is removed. |
lineItemKeyString |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
Apply DeltaToLineItemShippingDetailsTargets
lineItemIdString | |
lineItemKeyString | |
targetsDeltaDraft | |
targetsDeltaArray of ShippingTargetDraft |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
Set LineItemRecurrenceInfo
lineItemIdString | |
recurrenceInfo |
LineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt | |
priceSelectionMode | Can be Dynamic, or Fixed |
Set LineItem Custom Type
lineItemIdString | |
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString | |
lineItemKeyString |
Set LineItem CustomField
lineItemIdString | |
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. |
lineItemKeyString |
Set LineItem InventoryMode
ReserveOnCart, a reservation is automatically created if sufficient stock is available. When changing from ReserveOnCart to another mode, the reservation is released.lineItemIdString | |
inventoryMode | Inventory mode specific to the Line Item only, and valid for the entire Can be quantity of the Line Item.
Set only if the inventory mode should be different from the inventoryMode specified on the Cart.None, TrackOnly, ReserveOnOrder, or ReserveOnCart |
lineItemKeyString |
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.
on Custom Line Item
Change CustomLineItem Quantity
shippingDetails field is kept in its current state to avoid data loss.customLineItemIdString | |
customLineItemKeyString | |
quantityLong | New value to set. If 0, the Custom Line Item is removed from the Cart. |
Set CustomLineItem TaxRate
External TaxMode.customLineItemIdString | |
customLineItemKeyString | |
externalTaxRate | Value to set. If omitted, an existing value is removed. |
shippingKeyString | key of the ShippingMethod used for this Custom Line Item.
This is required for Carts with Multiple ShippingMode. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Set CustomLineItem TaxAmount
ExternalAmount TaxMode.customLineItemIdString | |
customLineItemKeyString | |
externalTaxAmount | Value to set. If omitted, any existing value is removed. |
shippingKeyString | key of the ShippingMethod used for this Custom Line Item.
This is required for Carts with Multiple ShippingMode. |
ExternalTaxAmountDraft
Can only be set by these update actions:
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Carts
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Order Edits
totalGross | Total gross amount ( totalNet + taxPortions) of the Line Item or Custom Line Item. |
taxRate | Tax Rates and subrates of states and countries. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Change CustomLineItem Price Mode
customLineItemIdString | |
customLineItemKeyString | |
mode | New value to set. Must not be empty. Can beExternal, or Standard |
CustomLineItemPriceMode
External- Cart discounts are deactivated for the custom line items with this price mode.
Standard- This is the default mode.
Change CustomLineItem Money
customLineItemIdString | |
customLineItemKeyString | |
money | Value to set. Must not be empty. Can be a negative amount. To set the money value in high precision, use HighPrecisionMoneyDraft. |
BaseMoneyInput
centPrecision | |
highPrecision |
Set CustomLineItem ShippingDetails
customLineItemIdString | |
customLineItemKeyString | |
shippingDetails | Value to set. If omitted, any existing value is removed. |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
Apply DeltaToCustomLineItemShippingDetailsTargets
customLineItemIdString | |
customLineItemKeyString | |
targetsDeltaDraft | |
targetsDeltaArray of ShippingTargetDraft |
ItemShippingDetailsDraft
targetsArray of ShippingTargetDraft | Default: [] |
shippingTargetsArray of ShippingMethodTargetDraft | Default: [] |
itemShippingAddressTargetsArray of ItemShippingAddressTargetDraft | Default: [] |
ShippingTargetDraft
addressKeyString | |
quantityLong | |
shippingMethodKeyString |
ShippingMethodTargetDraft
shippingMethodKeyString | |
quantityLong |
ItemShippingAddressTargetDraft
addressKeyString | |
quantityLong |
Set CustomLineItemRecurrenceInfo
customLineItemIdString | |
customLineItemKeyString | |
recurrenceInfo |
CustomLineItemRecurrenceInfoInputDraft
recurrencePolicy | |
expiresAt |
Set CustomLineItem Custom Type
customLineItemIdString | |
customLineItemKeyString | |
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set CustomLineItem CustomField
customLineItemIdString | |
customLineItemKeyString | |
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. |
on Billing Address
Set Billing Address Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Billing Address CustomField
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. |
on Shipping Address
Set Shipping Address Custom Type
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Shipping Address CustomField
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. |
on ItemShipping Address
Set ItemShipping Address Custom Type
addressKeyString | |
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set ItemShipping Address CustomField
addressKeyString | |
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. |
on Shipping Method
Set ShippingMethod TaxAmount
ExternalAmount TaxMode.externalTaxAmount | Value to set. If omitted, any existing value is removed. |
shippingKeyString | key of the ShippingMethod to update.
This is required and valid only for Carts with Multiple ShippingMode.
An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode. |
ExternalTaxAmountDraft
Can only be set by these update actions:
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Carts
- Set LineItem TaxAmount, Set CustomLineItem TaxAmount, or Set ShippingMethod TaxAmount on Order Edits
totalGross | Total gross amount ( totalNet + taxPortions) of the Line Item or Custom Line Item. |
taxRate | Tax Rates and subrates of states and countries. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
Set ShippingMethod TaxRate
External TaxMode.externalTaxRate | Value to set. If omitted, any existing value is removed. |
shippingKeyString | key of the ShippingMethod to update.
This is required and valid only for Carts with Multiple ShippingMode.
An InvalidOperation error is returned if shippingKey is provided for Carts with Single ShippingMode, or omitted for Carts with Multiple ShippingMode. |
ExternalTaxRateDraft
nameString | Name of the Tax Rate. |
amountFloat | Percentage in the range of 0-1.
|
country | Country for which the tax applies. |
stateString | State within the specified country. |
subRatesArray of SubRateDraft | 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 Default: amount.
These subrates are used to calculate the taxPortions field of a Cart or Order and the taxedPrice field of LineItems, CustomLineItems, and ShippingInfos.[] |
includedInPriceBoolean |
false |
taxRoundingTarget | Determines whether the Can be taxRoundingMode of the Cart or Order is applied to the net price or the tax amount when includedInPrice is true. The field is ignored if includedInPrice is false.Net, or TaxDefault: Net |
SubRateDraft
nameString | |
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.
on Shipping
Set Shipping Custom Type
shippingKeyString | |
fieldsArray of CustomFieldInput | |
type | |
typeKeyString | |
typeIdString |
Set Shipping CustomField
shippingKeyString | The shippingKey of the Shipping to customize. Used to specify which Shipping Method to customize
on a Cart with Multiple ShippingMode.
Leave this empty to customize the one and only ShippingMethod on a Single ShippingMode Cart. |
nameString | Name of the Custom Field. |
valueString | If value is absent or null, this field will be removed if it exists.
Trying to remove a field that does not exist will fail with an InvalidOperation error.
If value is provided, it is set for the field defined by name. |