Mutations and types for importing Orders in the platform.

Mutations

Import Order

MUTATIONimportOrder
Arguments
draft​
Output:Order

Output types

Order

An order can be created from a cart, usually after a checkout process has been completed. documentation
customerId​
String​
id of the Customer that the Order belongs to.
customer​
customerEmail​
String​

Email address of the Customer that the Order belongs to.

anonymousId​
String​
Anonymous session associated with the Order.
lineItems​
Array of LineItem​
Line Items that are part of the Order.
customLineItems​
Array of CustomLineItem​
Custom Line Items that are part of the Order.
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.
Taxes are included if TaxRate includedInPrice is true for each price.
taxedPrice​
  • For Platform TaxMode, it is automatically set when a shipping address is set.
  • For External TaxMode, it is automatically set when shippingAddress and external Tax Rates for all Line Items, Custom Line Items, and Shipping Methods in the Cart are set.
If a discount applies on totalPrice, this field holds the proportionally discounted value.
discountOnTotalPrice​

Discounts that apply on the total price of the Order.

shippingAddress​
Shipping address associated with the Order. Determines eligible ShippingMethod rates and Tax Rates of Line Items.
billingAddress​

Billing address associated with the Order.

inventoryMode​

Indicates how stock quantities are tracked for Line Items in the Order.

Can be None, TrackOnly, ReserveOnOrder, or ReserveOnCart​
taxMode​

Indicates how Tax Rates are set.

Can be Disabled, External, ExternalAmount, or Platform​
priceRoundingMode​
Indicates how the total prices on LineItems and CustomLineItems are rounded when calculated.
Can be HalfDown, HalfEven, or HalfUp​
taxRoundingMode​
Indicates how monetary values are rounded when calculating taxes for taxedPrice.
Can be HalfDown, HalfEven, or HalfUp​
taxCalculationMode​
Indicates how taxes are calculated when calculating taxes for taxedPrice.
Can be LineItemLevel, or UnitPriceLevel​
customerGroup​
Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
customerGroupRef​
Reference to the Customer Group of the Customer that the Order belongs to. Used for Line Item price selection.
country​
shippingKey​
String​
key of the ShippingMethod for Single ShippingMode.
shippingInfo​
Shipping-related information for Single ShippingMode. Automatically set when a Shipping Method is set.
discountCodes​
Array of DiscountCodeInfo​

Discount Codes added to the Order.

If directDiscountsIgnoreCartDiscounts is true, an Order that has directDiscounts cannot have discountCodes.
directDiscounts​
Array of DirectDiscount​

Direct Discounts added to the Order.

If directDiscountsIgnoreCartDiscounts is true, an Order that has discountCodes cannot have directDiscounts.
refusedGifts​
Array of CartDiscount​
Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.
refusedGiftsRefs​
Array of Reference​
Automatically set when a Line Item with GiftLineItem LineItemMode is removed from the Order.
paymentInfo​

Payment information related to the Order.

locale​
Languages of the Order. Can only contain 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 the origin of the Cart from which the Order was created.

Can be Customer, Merchant, Quote, or RecurringOrder​
storeRef​
Reference to a Store the Order belongs to.
store​
Reference to a Store the Order belongs to.
itemShippingAddresses​
Array of Address​
Additional shipping addresses of the Order as specified by LineItems using the shippingDetails field. Eligible Shipping Methods or applicable Tax Rates are determined by the address in shippingAddress, and not itemShippingAddresses.
businessUnit​
Reference to a Business Unit the Order belongs to. Only available for B2B-enabled Projects.
businessUnitRef​
Reference to a Business Unit the Order belongs to. Only available for B2B-enabled Projects.
shipping​
Array of Shipping​
Shipping-related information for 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 there can be one or multiple Shipping Methods.

Can be Multiple, or Single​
shippingCustomFields​
Custom Fields of the Shipping Method for Single ShippingMode.
placement​
Can be InStore, or Online​
discountTypeCombination​

Indicates if a combination of discount types can apply on an Order.

completedAt​
User-defined date and time (UTC) of the Order. Present only on an Order created using Order Import.
orderNumber​
String​

User-defined identifier of the Order that is unique across a Project.

orderState​

Current status of the Order.

Can be Cancelled, Complete, Confirmed, or Open​
stateRef​
State of the Order. This reference can point to a State in a custom workflow.
state​
State of the Order. This reference can point to a State in a custom workflow.
shipmentState​

Shipment status of the Order.

Can be Backorder, Canceled, Delayed, Delivered, Partial, Pending, Ready, or Shipped​
paymentState​

Payment status of the Order.

Can be BalanceDue, CreditOwed, Failed, Paid, or Pending​
syncInfo​
Array of SyncInfo​
Contains synchronization activity information of the Order (like export or import). Can only be set with Update SyncInfo update action.
returnInfo​
Array of ReturnInfo​

Contains information regarding the returns associated with the Order.

purchaseOrderNumber​
String​

User-defined identifier of a purchase Order.

It is typically set by the Buyer and can be used with Quotes to track the purchase Order during the quote and order flow.
directDiscountsIgnoreCartDiscounts​
Boolean​
  • If true, only Direct Discounts apply to the Order. Matching Cart Discounts are ignored, and Discount Codes cannot be added.
  • If false, Cart Discounts, Discount Codes, and Direct Discounts apply to the Order.
lastMessageSequenceNumber​DEPRECATED
Long​

An internal field that should not be used in customer logic

Internal-only field.

cartRef​
Reference to the Cart for an Order created from Cart. The referenced Cart will have the Ordered CartState.
cart​
Cart​
Reference to the Cart for an Order created from Cart. The referenced Cart will have the Ordered CartState.
quoteRef​
Reference to the Quote for an Order created from Quote.
quote​
Reference to the Quote for an Order created from Quote.
recurringOrderRef​
Reference to the RecurringOrder that generated this Order.
recurringOrder​
Reference to the RecurringOrder that generated this Order.
custom​

Custom Fields of the Order.

id​
String​

Unique identifier of the Order.

version​
Long​

Current version of the Order.

createdAt​

Date and time (UTC) the Order was initially created.

lastModifiedAt​

Date and time (UTC) the Order was last updated.

createdBy​

IDs and references that created the Order.

lastModifiedBy​

IDs and references that last modified the Order.

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.

id​
String​

Unique identifier of the LineItem.

key​
String​

User-defined identifier of the LineItem. Unique among LineItems in the Cart or Order.

productId​
String​
id of the Product the Line Item is based on.
productKey​
String​
key of the Product.

This field is only present on:

  • Line Items in a Cart when the key is available on that specific Product at the time the LineItem was created or updated on the Cart.
  • Line Items in an Order when the key is available on the specific Product at the time the Order was created from the Cart.

Present on resources created or updated after 3 December 2021.

name​
String​

Name of the Product.

nameAllLocales​
Array of LocalizedString​

Name of the Product.

productSlug​
String​
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.
productSlugAllLocales​
Array 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.
quantity​
Long​
Quantity of the Product Variant present in the Cart or Order.
addedAt​

Date and time (UTC) the Line Item was added to the Cart.

lastModifiedAt​

Date and time (UTC) the Line Item was last updated.

state​
Array 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​
  • For a Cart with Platform TaxMode, the taxRate of Line Items is set automatically once a shipping address is set. The rate is based on the TaxCategory that applies for the shipping address.
  • For a Cart with External TaxMode, the taxRate of Line Items can be set using ExternalTaxRateDraft.
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​
Used to select a Product Price. The referenced Channel has the ProductDistribution ChannelRoleEnum.
distributionChannelRef​
Used to select a Product Price. The referenced Channel has the ProductDistribution ChannelRoleEnum.
discountedPricePerQuantity​

Discounted price of a single quantity of the Line Item.

lineItemMode​

Indicates how the Line Item is added to the Cart.

Can be GiftLineItem, or Standard​
priceMode​

Indicates how the Price for the Line Item is set.

Can be ExternalPrice, ExternalTotal, or Platform​
custom​

Custom Fields of the Line Item.

inventoryMode​
Inventory mode specific to this Line Item only, and valid for the entire quantity of the Line Item. Only present if the inventory mode is different from the inventoryMode specified on the Cart.
Can be 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.

perMethodTaxRate​
Array 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.
taxedPricePortions​
Array 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

typeId​
String​
id​
String​
version​
Long​

ProductVariant

Represents a Product Variant embedded in a Product.
Only available for Projects with the ProductCatalogModel Classic. When the Project has the Modular catalog model, use the Variants API instead.
id​
Int​

A unique, sequential identifier of the Product Variant within the Product.

key​
String​

User-defined identifier of the ProductVariant. Unique among ProductVariants in the same Product.

This is different from Product key.
sku​
String​

User-defined SKU of the Product Variant. Unique across all ProductVariants in a Project.

prices​
Array 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.

allRecurrencePrices​
Array of ProductPrice​

Returns all recurrence prices based on the price selection rules.

images​
Array of Image​

Images of the Product Variant.

assets​
Array 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).
attributesRaw​

This field contains raw attributes data

ProductPrice

id​
String​
value​
key​
String​
country​
customerGroup​
customerGroupRef​
channel​
channelRef​
validFrom​
validUntil​
discounted​
tiers​
Array of ProductPriceTier​
custom​
recurrencePolicy​
recurrencePolicyRef​

DiscountedProductPriceValue

value​
discountRef​
discount​

ProductPriceTier

minimumQuantity​
Int​
value​

ProductVariantAvailabilityWithChannels

noChannel​
channels​

ProductVariantAvailability

Product variant availability

isOnStock​
Boolean​
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.
restockableInDays​
Int​

Number of days to restock a Product Variant once it is out of stock.

availableQuantity​
Long​

Number of items of the Product Variant that are in stock.

version​
Long​
Current version of the InventoryEntry.
id​
String​
Unique identifier of the InventoryEntry.

ProductVariantAvailabilitiesResult

Product variant availabilities

limit​
Int​
offset​
Int​
total​
Int​
results​

ProductVariantAvailabilityWithChannel

channelRef​
channel​
availability​

RawProductAttribute

attributeDefinition​
name​
String​
value​
Json​
attributesRaw​
BETA: This feature can be subject to change and should be used carefully in production. https://docs.commercetools.com/api/contract#public-beta
referencedResource​
referencedResourceSet​

AttributeDefinition

type​

Describes the Type of the Attribute.

name​
String​
User-defined name of the Attribute that is unique within the Project.
label​
String​

Human-readable label for the Attribute.

isRequired​
Boolean​
Whether the Attribute must have a value on a ProductVariant.
attributeConstraint​

Specifies how Attributes are validated across all variants of a Product.

Can be None, Unique, CombinationUnique, or SameForAll​
level​

Specifies whether the Attribute is defined at the Product or Variant level.

Can be Variant, or Product​
inputTip​
String​

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​
isSearchable​
Boolean​
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.
savedToLineItem​
Boolean​
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.
labelAllLocales​
Array of LocalizedString​

Human-readable label for the Attribute.

inputTipAllLocales​
Array 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.

taxPortions​
Array 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.

rate​
Float​

A number in the range 0-1.

amount​

Money value of the tax portion.

name​
String​

Name of the tax portion.

ItemState

quantity​
Long​

Quantity of Line Items or Custom Line Items in this State.

stateRef​

State of the Line Items or Custom Line Items in a custom workflow.

state​

State of the Line Items or Custom Line Items in a custom workflow.

TaxRate

name​
String​

Name of the TaxRate.

amount​
Float​
Tax rate. If subrates are used, the amount is the sum of all rates in subRates.
includedInPrice​
Boolean​
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​
state​
String​
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.
id​
String​
Present if the TaxRate is part of a TaxCategory. Absent for external TaxRates in LineItem, CustomLineItem, and ShippingInfo.
key​
String​
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.
subRates​
Array 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 Net.
Can be Net, or Tax​

SubRate

It is used to calculate the taxPortions field in a Cart or Order.
name​
String​

Name of the SubRate.

amount​
Float​

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

quantity​
Long​

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.
includedDiscounts​

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:
  • The value is zero for a (Custom) Line Item matching the triggerPattern, indicating it participated in the discount as a trigger.
  • The value is the actual discount amount for a (Custom) Line Item matching the targetPattern.

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

targets​
Array of ItemShippingTarget​

Holds information on the quantity of Line Items or Custom Line Items and the address it is shipped.

valid​
Boolean​
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

Determines the address (as a reference to an address in 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.

addressKey​
String​
Key of the address in the Cart itemShippingAddresses. Duplicate address keys are not allowed.
quantity​
Long​
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.
shippingMethodKey​
String​
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

shippingMethodKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
taxRate​

Tax Rate for the Shipping Method.

MethodTaxedPrice

shippingMethodKey​
String​
User-defined unique identifier of the Shipping Method in a Cart with Multiple ShippingMode.
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

typeId​
String​
id​
String​

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.

id​
String​

Unique identifier of the Custom Line Item.

key​
String​

User-defined identifier of the Custom Line Item. Unique among Custom Line Items in the Cart or Order.

name​
String​

Name of the Custom Line Item.

nameAllLocales​
Array 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.
Includes taxes if the TaxRate includedInPrice is true.
slug​
String​
User-defined identifier used in a deep-link URL for the Custom Line Item. It matches the pattern [a-zA-Z0-9_-]{2,256}.
quantity​
Long​
Number of Custom Line Items in the Cart or Order.
state​
Array 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​
  • For a Cart with Platform TaxMode, the taxRate of Custom Line Items is set automatically once a shipping address is set. The rate is based on the TaxCategory that applies for the shipping address.
  • For a Cart with External TaxMode, the taxRate of Custom Line Items can be set using ExternalTaxRateDraft.
taxedPrice​
Automatically set after the taxRate is set.
taxedPricePortions​
Array 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.
perMethodTaxRate​
Array 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.
discountedPricePerQuantity​

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.

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.

taxPortions​
Array 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.

includedDiscounts​

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​
A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart totalPrice.
discountRef​
A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart totalPrice.
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

shippingMethodName​
String​

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​
Automatically set in the Platform TaxMode after the shipping address is set.
For the External TaxMode the Tax Rate must be set explicitly with the ExternalTaxRateDraft.
deliveries​
Array 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.
message​
String​
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.

id​
String​

Unique identifier of the Delivery.

key​
String​

User-defined identifier of the Delivery. Unique among Deliveries in the Order.

createdAt​

Date and time (UTC) the Delivery was created.

items​
Array of DeliveryItem​

Line Items or Custom Line Items that are delivered.

parcels​
Array 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

id​
String​
id of the LineItem or CustomLineItem delivered.
quantity​
Long​

Quantity of Line Items or Custom Line Items delivered.

Parcel

Information regarding the appearance, content, and shipment of a Parcel.

id​
String​

Unique identifier of the Parcel.

key​
String​

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.

items​
Array of DeliveryItem​

Line Items or Custom Line Items delivered in this Parcel.

custom​

Custom Fields of the Parcel.

ParcelMeasurements

heightInMillimeter​
Int​

Height of the Parcel.

lengthInMillimeter​
Int​

Length of the Parcel.

widthInMillimeter​
Int​

Width of the Parcel.

weightInGram​
Int​

Weight of the Parcel.

TrackingData

Information that helps track a Parcel.

trackingId​
String​

Identifier to track the Parcel.

carrier​
String​

Name of the carrier that delivers the Parcel.

provider​
String​

Name of the provider that serves as facade to several carriers.

providerTransaction​
String​
Transaction identifier with the provider.
isReturn​
Boolean​
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.

from​

Date and time (UTC) of the earliest expected delivery.

until​
Date and time (UTC) of the latest expected delivery. When both from and until are set, until must be equal to or later than from.

DiscountCodeInfo

discountCodeRef​

Discount Code associated with the Cart or Order.

Indicates the state of the Discount Code applied to the Cart or Order.

Can be ApplicationStoppedByGroupBestDeal, ApplicationStoppedByPreviousDiscount, DoesNotMatchCart, MatchesCart, MaxApplicationReached, NotActive, or NotValid​
discountCode​

Discount Code associated with the Cart or Order.

DiscountCodeState

ApplicationStoppedByGroupBestDeal
ApplicationStoppedByPreviousDiscount
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

Represents a CartDiscount that is only associated with a single Cart or Order.
id​
String​

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.
participateInBestDealSelection​
Boolean​
  • If true, Direct Discounts compete against Product Discounts to apply the best deal.
  • If false, Direct Discounts are ignored when calculating the best deal comparison, and are applied on top of the discount type that offers the best deal.
This applies only when the DiscountCombinationMode for the Project is BestDeal.

CartDiscountValue

type​
String​

CartDiscountTarget

type​
String​

PaymentInfo

payments​
Array of Payment​
paymentRefs​
Array of Reference​

ShippingRateInput

type​
String​

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

shippingKey​
String​
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

type​
String​

OrderState

Cancelled
Complete
Confirmed
Open

ShipmentState

Backorder
Canceled
Delayed
Delivered
Partial
Pending
Ready
Shipped

PaymentState

BalanceDue
CreditOwed
Failed
Paid
Pending

SyncInfo

Stores information about order synchronization activities (like export or import).

channelRef​

Connection to a synchronization destination.

channel​

Connection to a synchronization destination.

externalId​
String​

Identifier of an external order instance, file, or other resource.

syncedAt​

Date and time (UTC) the information was synced.

ReturnInfo

Stores information about returns connected to this order.

items​
Array of ReturnItem​

Information on the Line Items or Custom Line Items returned.

returnTrackingId​
String​

User-defined identifier to track the return.

returnDate​

Date and time (UTC) the return is initiated.

ReturnItem

type​
String​
id​
String​
key​
String​
quantity​
Long​
comment​
String​
shipmentState​
Can be Advised, BackInStock, Returned, or Unusable​
paymentState​
Can be Initial, NonRefundable, NotRefunded, or Refunded​
custom​
lastModifiedAt​
createdAt​

ReturnShipmentState

Advised
BackInStock
Returned
Unusable

ReturnPaymentState

Initial
NonRefundable
NotRefunded
Refunded

Input types

ImportOrderDraft

orderNumber​
String​
customerId​
String​
customerEmail​
String​
store​
lineItems​
Default: []​
customLineItems​
Default: []​
totalPrice​
taxedPrice​
shippingAddress​
billingAddress​
customerGroup​
country​
orderState​
Can be Cancelled, Complete, Confirmed, or Open​
shipmentState​
Can be Backorder, Canceled, Delayed, Delivered, Partial, Pending, Ready, or Shipped​
paymentState​
Can be BalanceDue, CreditOwed, Failed, Paid, or Pending​
shippingInfo​
completedAt​
custom​
inventoryMode​
Can be None, TrackOnly, ReserveOnOrder, or ReserveOnCart​Default: None​
shippingDetails​
taxCalculationMode​
Can be LineItemLevel, or UnitPriceLevel​Default: LineItemLevel​
priceRoundingMode​
Can be HalfDown, HalfEven, or HalfUp​Default: HalfEven​
taxRoundingMode​
Can be HalfDown, HalfEven, or HalfUp​Default: HalfEven​
origin​
Can be Customer, Merchant, Quote, or RecurringOrder​Default: Customer​
itemShippingAddresses​
Array of AddressInput​
Default: []​
state​
paymentInfo​
purchaseOrderNumber​
String​

MoneyInput

currencyCode​
centAmount​
Long​

OrderState

Cancelled
Complete
Confirmed
Open

ShipmentState

Backorder
Canceled
Delayed
Delivered
Partial
Pending
Ready
Shipped

PaymentState

BalanceDue
CreditOwed
Failed
Paid
Pending

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.

ItemShippingDetailsDraft

targets​
Default: []​
shippingTargets​
Default: []​
itemShippingAddressTargets​
Default: []​

ShippingTargetDraft

addressKey​
String​
quantity​
Long​
shippingMethodKey​
String​

ShippingMethodTargetDraft

shippingMethodKey​
String​
quantity​
Long​

ItemShippingAddressTargetDraft

addressKey​
String​
quantity​
Long​

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`

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)

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.

LineItemImportDraft

Represents a snapshot of a Product Variant at the time it was imported with the Order. The Product Variant can be specified by providing a productId and variant.id, or by providing a variant.sku.
productId​
String​
id of the Product the Product Variant belongs to.
If provided, you must also set variant.id.
name​

Name of the Line Item.

key​
String​

User-defined identifier of the Line Item. Must be unique among Line Items in the Order.

price​
The Line Item price for quantity = 1. The amount can be negative.
quantity​
Long​

Quantity of the Product Variant. Can be a negative value.

supplyChannel​
The Channel used to supply Line Items. By providing supply Channel information, you can uniquely identify Inventory entries that should be reserved. This Channel must have the InventorySupply role.
distributionChannel​
The Channel used to select a Price. This Channel must have the ProductDistribution role.
taxRate​
The tax rate used to calculate the taxedPrice of the Line Item if taxedPrice is not provided.
variant​
The Product Variant to use as a Line Item.
inventoryMode​
Inventory mode specific to the LineItem, valid for the entire quantity of the LineItem. Set only if Inventory mode should be different from the inventoryMode specified on the OrderImportDraft.
Can be None, TrackOnly, ReserveOnOrder, or ReserveOnCart​
state​
Array of ItemStateDraftType​

States of the Line Item.

custom​

Custom Fields for the LineItem.

shippingDetails​

Container for Line Item-specific addresses.

taxedPrice​
Taxed price of the Line Item. If provided, the values are stored as-is on the resulting LineItem instead of being derived from price, quantity, and taxRate.
Can only be set if taxRate is also set.

ProductPriceDataInput

value​
key​
String​
country​
customerGroup​
validFrom​
validUntil​
tiers​
Default: []​
custom​
discounted​
recurrencePolicy​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

TaxRateInput

name​
String​
amount​
Float​
includedInPrice​
Boolean​
country​
state​
String​
id​
String​
key​
String​
subRates​
Array of SubRateDraft​
Default: []​
taxRoundingTarget​
Can be Net, or Tax​Default: Net​

SubRateDraft

name​
String​
amount​
Float​

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.

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.

ItemStateDraftType

quantity​
Long​
state​

ItemShippingDetailsDraft

targets​
Default: []​
shippingTargets​
Default: []​
itemShippingAddressTargets​
Default: []​

ShippingTargetDraft

addressKey​
String​
quantity​
Long​
shippingMethodKey​
String​

ShippingMethodTargetDraft

shippingMethodKey​
String​
quantity​
Long​

ItemShippingAddressTargetDraft

addressKey​
String​
quantity​
Long​

ProductVariantImportDraft

Contains the Product Variant to be used in the LineItemImportDraft.
id​
Int​
The id of the ProductVariant. Required if you do not set a value for sku. If set, you must specify a productId in the LineItemImportDraft also.
sku​
String​
The sku of the ProductVariant. Required if you do not set a value for id.
prices​
The Prices of the Product Variant if you want to override the prices property in the referenced ProductVariant. If not set, the prices from the referenced ProductVariant are used in the resulting Order. If set, each Price must have its unique price scope (same value.currencyCode, country, customerGroup, channel, validFrom and validUntil).
Default: []​
images​
Array of ImageInput​
The Images of the Product Variant if you want to override the images property in the referenced ProductVariant. If not set, the images from the referenced ProductVariant are copied to the resulting Order.
Default: []​
attributes​
The Attributes of the Product Variant if you want to override the attributes property in the referenced ProductVariant. If not set, the attributes from the referenced ProductVariant are copied to the resulting Order.
Default: []​

ProductPriceDataInput

value​
key​
String​
country​
customerGroup​
validFrom​
validUntil​
tiers​
Default: []​
custom​
discounted​
recurrencePolicy​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

ImageInput

url​
String​
label​
String​
dimensions​

DimensionsInput

width​
Int​
height​
Int​

ProductAttributeInput

An input object used to define a ProductAttribute.

The value should be passed in a form of escaped JSON.

Examples for value:
  • FieldType String: "\"This is a string\""
  • FieldType DateTimeType: "\"2018-10-12T14:00:00.000Z\""
  • FieldType Number: "4"
  • FieldType Set with an elementType of String: "[\"This is a string\", \"This is another string\"]"
  • FieldType Reference: "{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"
name​
String​
value​
String​

The value should be passed in a form of escaped JSON.

Examples for value:
  • FieldType String: "\"This is a string\""
  • FieldType DateTimeType: "\"2018-10-12T14:00:00.000Z\""
  • FieldType Number: "4"
  • FieldType Set with an elementType of String: "[\"This is a string\", \"This is another string\"]"
  • FieldType Reference: "{\"id\": \"b911b62d-353a-4388-93ee-8d488d9af962\", \"typeId\": \"product\"}"

CustomLineItemImportDraft

Custom Line Items contain generic user-defined items that are not linked to Products.

name​

Name of the Custom Line Item.

key​
String​

User-defined identifier of the Custom Line Item. Must be unique among Custom Line Items in the Order.

quantity​
Long​

Quantity of items in the Custom Line Item. Can be a negative value.

money​

The cost of individual items in the Custom Line Item. The amount can be negative.

To set the money value in high precision, use HighPrecisionMoneyDraft.
slug​
String​
User-defined identifier used in a deep-link URL for the Custom Line Item. This value should match the pattern [a-zA-Z0-9_-]{2,256}.
state​
Array of ItemStateDraftType​

State of the Custom Line Items.

taxRate​
The tax rate used to calculate the taxedPrice of the Custom Line Item if taxedPrice is not provided.
taxCategory​

Include a value to associate a Tax Category with the Custom Line Item.

custom​

Custom Fields for the CustomLineItem.

shippingDetails​

Container for Custom Line Item-specific addresses.

Can be External, or Standard​
taxedPrice​
Taxed price of the Custom Line Item. If provided, the values are stored as-is on the resulting CustomLineItem instead of being derived from money, quantity, and taxRate.
Can only be set if taxRate is also set.

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

ItemStateDraftType

quantity​
Long​
state​

TaxRateInput

name​
String​
amount​
Float​
includedInPrice​
Boolean​
country​
state​
String​
id​
String​
key​
String​
subRates​
Array of SubRateDraft​
Default: []​
taxRoundingTarget​
Can be Net, or Tax​Default: Net​

SubRateDraft

name​
String​
amount​
Float​

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

targets​
Default: []​
shippingTargets​
Default: []​
itemShippingAddressTargets​
Default: []​

ShippingTargetDraft

addressKey​
String​
quantity​
Long​
shippingMethodKey​
String​

ShippingMethodTargetDraft

shippingMethodKey​
String​
quantity​
Long​

ItemShippingAddressTargetDraft

addressKey​
String​
quantity​
Long​

CustomLineItemPriceMode

External
Cart discounts are deactivated for the custom line items with this price mode.
Standard
This is the default mode.

TaxedPriceDraft

totalNet​

Total net price of the Cart or Order.

totalGross​

Total gross price of the Cart or Order.

taxPortions​
Array of TaxPortionDraft​
Taxable portions added to the totalGross.
Calculated from the TaxRates.
totalTax​

Total tax applicable for the Cart or Order.

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

TaxPortionDraft

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 with the same rate and name will be accumulated to the same tax portion.
name​
String​

Name of the tax portion.

rate​
Float​

A number in the range 0-1.

amount​

Money value for the tax portion.

ShippingInfoImportDraft

Becomes the shippingInfo of the imported Order.
shippingMethodName​
String​

Name of the Shipping Method.

price​

The base price for the Shipping Method.

shippingRate​

Shipping rate information for the Order.

taxRate​

Include a Tax Rate for the Shipping Method.

taxCategory​

Include a value to associate a Tax Category with the shipping information.

deliveries​
Array of DeliveryDraft​

Information on how items are to be delivered to customers.

Default: []​
shippingMethod​

Include a value to associate a Shipping Method with the Order.

discountedPrice​

Discounted Price of the Shipping Method.

taxedPrice​
Taxed price of the Shipping Method. If provided, the values are stored as-is on the resulting ShippingInfo instead of being derived from price and taxRate.
shippingMethodState​
Indicates if the ShippingMethod referenced is allowed for the Order or not.
Can be DoesNotMatchCart, or MatchesCart​Default: MatchesCart​

MoneyInput

currencyCode​
centAmount​
Long​

TaxRateInput

name​
String​
amount​
Float​
includedInPrice​
Boolean​
country​
state​
String​
id​
String​
key​
String​
subRates​
Array of SubRateDraft​
Default: []​
taxRoundingTarget​
Can be Net, or Tax​Default: Net​

SubRateDraft

name​
String​
amount​
Float​

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

key​
String​

User-defined identifier of the Delivery. Must be unique among Deliveries in the Order.

items​
Line Items or Custom Line Items to deliver. It can also be specified individually for each Parcel.
parcels​
Array 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

id​
String​
quantity​
Long​

ParcelDraft

id​
String​
key​
String​
createdAt​
measurements​
trackingData​
items​
Default: []​
custom​

ParcelMeasurementsDraftType

heightInMillimeter​
Int​
lengthInMillimeter​
Int​
widthInMillimeter​
Int​
weightInGram​
Int​

TrackingDataDraftType

trackingId​
String​
carrier​
String​
provider​
String​
providerTransaction​
String​
isReturn​
Boolean​
Default: false​

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

DiscountedLineItemPriceDraft

value​

Discounted money value.

includedDiscounts​

Discounts to be applied.

Default: []​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

currencyCode​
preciseAmount​
Long​
fractionDigits​
Int​
centAmount​
Long​

DiscountedLineItemPortionDraft

discount​
A CartDiscountReference or DirectDiscountReference for the discount applicable on the Line Item.
discountedAmount​

Money value for the discount applicable.