Order Edits

Please note that the OrderEdit feature in its initial release does not support the tracking or reserving of inventory. An OrderEdit can therefore only be created if the InventoryMode of the order is "None".

• action - String - "setCustomField"
• name - String - Required
• value - Value - Optional
  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, set the value of the field defined by the name.

• action - String - "changeOrderState"
• orderState - OrderState - Required

This update action produces an OrderStateChangedMessage.

• action - String - "changeShipmentState"
• shipmentState - ShipmentState - Required

This update action produces an OrderShipmentStateChangedMessage.

• action - String - "changePaymentState"
• paymentState - PaymentState - Required

Changing the payment state of the order produces the OrderPaymentStateChangedMessage.

• action - String - "updateSyncInfo"
• channel - ResourceIdentifier to a Channel
  Connection to a particular synchronization destination.
• externalId - String - Optional
  Can be used to reference an external order instance, file etc.
• syncedAt - DateTime - Optional If not provided, then current date would be used

• action - String - "addReturnInfo" - Required
• returnDate - DateTime - Optional
• returnTrackingId - String - Optional
  Identifies which return tracking ID is connected to this particular return.
• items - Array of ReturnItemDraft - Required
  Items to be returned.

This update action produces a ReturnInfoAddedMessage.

• action - String - "setReturnInfo"
• items - Array of ReturnInfoDraft - Optional
  Items to be returned.

This update action produces the ReturnInfoSetMessage.

To set a ReturnShipmentState, there needs to be at least one ReturnInfo with at least one ReturnItem created before.

• action - String - "setReturnShipmentState"
• returnItemId - String - ID of the concerning ReturnItem
• shipmentState - ReturnShipmentState

This update action produces an OrderReturnShipmentStateChangedMessage.

To set a ReturnPaymentState, there needs to be at least one ReturnInfo with at least one ReturnItem created before.

• action - String - "setReturnPaymentState"
• returnItemId - String - ID of the concerning ReturnItem
• paymentState - ReturnPaymentState

• action - String - "transitionLineItemState"
• lineItemId - String
• quantity - Number
• fromState - Reference to a State
• toState - Reference to a State
• actualTransitionDate - DateTime - Optional

This update action produces a LineItemStateTransitionMessage.

• action - String - "transitionCustomLineItemState"
• customLineItemId - String
• quantity - Number
• fromState - Reference to a State
• toState - Reference to a State
• actualTransitionDate - DateTime - Optional

This update action produces a CustomLineItemStateTransitionMessage.

The import of states does not follow any predefined rules and should be only used if no transitions are defined. The quantity in the ItemStates must match the sum of all LineItems states' quantities.

• action - String - "importLineItemState"
• lineItemId - String
• state - Array of ItemState

The import of states does not follow any predefined rules and should be only used if no transitions are defined. The quantity in the ItemStates must match the sum of all CustomLineItem states' quantities.

• action - String - "importCustomLineItemState"
• customLineItemId - String
• state - Array of ItemState

A Delivery can only be added to an Order if its shippingInfo exists.

• action - String - "addDelivery"
• items - Array of DeliveryItem - Optional
• address - AddressDraft - Optional
• parcels - Array of ParcelDraft - Optional
• custom - CustomFieldsDraft - Optional

This update action produces a DeliveryAddedMessage and the ParcelAddedToDeliveryMessage if the action contains a Parcel.

Sets the address value on an existing Delivery.

• action - String - "setDeliveryAddress"
• deliveryId - String The ID of the Delivery which should be updated.
• address - AddressDraft - Optional
  If not set an existing address is removed from the delivery.

This update action produces a DeliveryAddressSetMessage.

To add a Parcel, there needs to be at least one Delivery created before.

• action - String - "addParcelToDelivery"
• deliveryId - String - ID of the Delivery to which the parcel should be added.
• measurements - ParcelMeasurements - Optional
• trackingData - TrackingData - Optional
• items - Array of DeliveryItem - Optional

This update action produces a ParcelAddedToDeliveryMessage.

Sets a string that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order.

• action - String - "setOrderNumber"
• orderNumber - String - Optional
  It should be unique across a project. Once it's set, it cannot be changed.

Transition to a new state. If there is no state yet, the new state must be an initial state. If the existing state has transitions set, there must be a direct transition to the new state. If transitions is not set, no validation is performed. These validations can be turned off by setting the force parameter to true.

• action - String - "transitionState"
• state - Reference to a State
• force - Boolean - Optional - Defaults to false

This update action produces an OrderStateTransitionMessage.

This action sets, overwrites, or removes any existing value for customerEmail.
This action does not change the customer email on the Cart the order has been created from.

• action - String - "setCustomerEmail"
• email - String - Optional

This update action produces an OrderCustomerEmailSetMessage.

Relates a Customer to the order. In case the customer belongs to a CustomerGroup the order's field customerGroup would be updated automatically. When applied, no prices or discounts will be re-calculated on the order.

• action - String - "setCustomerId"
• customerId - String - Optional
  If set, a Customer with the given ID must exist in the project.

This update action produces an OrderCustomerSetMessage.

This action sets, overwrites, or removes any existing value for shippingAddress.
Changing the shipping address does not recalculate the cart. The taxes might not fit to the shipping address anymore.
This action does not change the shipping address on the Cart the order has been created from.

• action - String - "setShippingAddress"
• address - AddressDraft - Optional

This update action produces an OrderShippingAddressSetMessage.

This action sets, overwrites, or removes any existing value for billingAddress.
This action does not change the billing address on the Cart the order has been created from.

• action - String - "setBillingAddress"
• address - AddressDraft - Optional

This update action produces an OrderBillingAddressSetMessage.

This action sets, overwrites, or removes any existing custom type and fields for an existing order.

• action - String - "setCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing CustomFields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing order.

This action sets, overwrites, or removes any existing custom type and fields for an existing shippingAddress.

• action - String - "setShippingAddressCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing shippingAddress.

• action - String - "setShippingAddressCustomField"
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes any existing custom type and fields for an existing billingAddress.

• action - String - "setBillingAddressCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value. If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing billingAddress.

• action - String - "setBillingAddressCustomField"
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes any existing custom type and fields for an existing itemShippingAddress.

• action - String - "setItemShippingAddressCustomType"
• addressKey - String - Required
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing itemShippingAddress.

• action - String - "setItemShippingAddressCustomField"
• addressKey - String - Required
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes any existing custom type and fields for an existing address in a Delivery.

• action - String - "setDeliveryAddressCustomType"
• deliveryId - String - Required
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing address in a Delivery.

• action - String - "setDeliveryAddressCustomField"
• deliveryId - String - Required
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes any existing custom type and fields for a existing Delivery.

• action - String - "setDeliveryCustomType"
• deliveryId - String - Required
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for a existing Delivery.

• action - String - "setDeliveryCustomField"
• deliveryId - String - Required
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes any existing custom type and fields for a existing Parcel.

• action - String - "setParcelCustomType"
• parcelId - String - Required
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing custom fields are removed.
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for a existing Parcel.

• action - String - "setParcelCustomField"
• parcelId - String - Required
• name - String - Required
  The name of the Custom Field to set
• value - Value - Optional
  Specifies the format of the value of the Custom Field defined by name. If value is absent or null, the field specified by name, if it exists, is removed. Trying to remove a field that does not exist will fail with an InvalidOperation error.

This action sets, overwrites, or removes the existing custom type and fields for an existing order LineItem.

• action - String - "setLineItemCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing CustomFields are removed at the same time.
• lineItemId - String
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing order LineItem.

• action - String - "setLineItemCustomField"
• lineItemId - String
• name - String - Required
• value - Value - Optional
  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, set the value of the field defined by the name.

This action sets, overwrites, or removes the existing custom type and fields for an existing order ReturnItem.

• action - String - "setReturnItemCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing CustomFields are removed at the same time.
• returnItemId - String
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing order ReturnItem.

• action - String - "setReturnItemCustomField"
• returnItemId - String
• name - String - Required
• value - Value - Optional
  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, set the value of the field defined by the name.

This action adds a payment to the PaymentInfo. The payment must not be assigned to another Order or active Cart yet.

• action - String - "addPayment"
• payment - Reference to a Payment

This action removes a payment from the PaymentInfo.

• action - String - "removePayment"
• payment - Reference to a Payment

Sets the locale. Must be one of the languages supported for this Project.

• action - String - "setLocale"
• locale - String conforming to IETF language tag - Optional

Updates the delivery items of a Delivery.

• action - String - "setDeliveryItems"
• deliveryId - String - ID of the Delivery for which the items should be set
• items - Array of DeliveryItem

This update action produces a DeliveryItemsUpdatedMessage.

Removes a parcel in a Delivery.

• action - String - "removeParcelFromDelivery"
• parcelId - String - ID of the Parcel which shall be removed

This update action produces a ParcelRemovedFromDeliveryMessage.

Removes a Delivery.

• action - String - "removeDelivery"
• deliveryId - String - ID of the Delivery which shall be removed

This update action produces a DeliveryRemovedMessage.

• action - String - "setParcelMeasurements"
• parcelId - String - ID of the Parcel which shall be updated
• measurements - ParcelMeasurements - Optional

This update action produces a ParcelMeasurementsUpdatedMessage.

• action - String - "setParcelTrackingData"
• parcelId - String - ID of the Parcel which shall be updated
• trackingData - TrackingData - Optional

This update action produces a ParcelTrackingDataUpdatedMessage.

Updates the items of a Parcel.

• action - String - "setParcelItems"
• parcelId - String - ID of the Parcel which shall be updated
• items - Array of DeliveryItem

This update action produces a ParcelItemsUpdatedMessage.

Sets the ItemShippingDetails for a line item.

• action - String - "setLineItemShippingDetails"
• lineItemId - String
  The ID of the line item that is to be updated.
• shippingDetails - ItemShippingDetailsDraft - Optional
  The new shipping details for the line item.

Sets the ItemShippingDetails for a custom line item.

• action - String - "setCustomLineItemShippingDetails"
• customLineItemId - String
  The ID of the custom line item that is to be updated.
• shippingDetails - ItemShippingDetailsDraft - Optional
  The new shipping details for the custom line item.

Add an address to the itemShippingAddresses array.

• action - String - "addItemShippingAddress"
• address - AddressDraft
  The address must have a key that is unique in this cart/order.

Removes an address from the itemShippingAddresses array. An address can only be removed if it is not referenced in any ItemShippingTarget.

• action - String - "removeItemShippingAddress"
• addressKey - String
  The key of the address that is to be removed

Updates an address in the itemShippingAddresses array.

• action - String - "updateItemShippingAddress"
• address - AddressDraft
  The address which is to replace the address with the key already present in the array

Updates the Store the order is assigned to. It should be used to migrate existing orders to a newly introduced store. Therefore no validations are performed (such as that the customer is allowed to create orders in the store).

• action - String - "setStore"
• store - ResourceIdentifier to a Store - Optional

This update action produces an OrderStoreSetMessage.

Sets the country of the cart. When the country is set, the LineItem prices are updated.

• action - String - "setCountry"
• country - String - Optional
  A two-digit country code as per ISO 3166-1 alpha-2.

Sets the ShippingMethod. Prerequisite: The cart must contain a shipping address. This update action can fail with an InvalidOperation if the referenced shipping method has a predicate which does not match the cart.

• action - String - "setShippingMethod"
• shippingMethod - ResourceIdentifier to a ShippingMethod - Optional
• externalTaxRate - ExternalTaxRateDraft - Optional
  An external tax rate can be set if the cart has the External TaxMode.

Sets a custom shipping method (independent of the ShippingMethods defined in the project). The custom shipping method can be unset with the setShippingMethod action without the shippingMethod. Prerequisite: The cart must contain a shipping address.

• action - String - "setCustomShippingMethod"
• shippingMethodName - String - Required
• shippingRate - ShippingRateDraft - Required
  The shipping rate used to determine the price.
• taxCategory - ResourceIdentifier to a TaxCategory - Optional
  The given tax category will be used to select a tax rate when a cart has the TaxMode Platform.
• externalTaxRate - ExternalTaxRateDraft - Optional
  An external tax rate can be set if the cart has the External TaxMode.

Adds a DiscountCode to the cart to enable the related CartDiscounts.

• action - String - "addDiscountCode"
• code - String - Required
  The code of an existing DiscountCode.

The number of discount codes in a cart is limited to 10.

Specific Error Codes:

• MatchingPriceNotFound

Removes a discount code from the cart.

• action - String - "removeDiscountCode"
• discountCode - Reference to a DiscountCode - Required

Sets the customer group of the cart. The LineItem prices will be updated according to the customer group.
This action cannot be used if a customer is assigned to the cart. In that case the platform will automatically select the customer group the respective customer is assigned to.

• action - String - "setCustomerGroup"
• customerGroup - ResourceIdentifier to a CustomerGroup - Optional

A shipping method tax amount can be set if the cart has the ExternalAmount TaxMode.

• action - String - "setShippingMethodTaxAmount"
• externalTaxAmount - ExternalTaxAmountDraft - Optional

A shipping method tax rate can be set if the cart has the External TaxMode.

• action - String - "setShippingMethodTaxRate"
• externalTaxRate - ExternalTaxRateDraft - Optional

Changes the TaxMode of a cart. When a tax mode is changed from External to Platform or Disabled, all previously set external tax rates will be removed. When changing the tax mode to Platform, line items, custom line items and shipping method require a tax category with a tax rate for the given shipping address.

• action - String - "changeTaxMode"
• taxMode - TaxMode

Changes the tax RoundingMode of a cart. When changing the tax rounding mode, the taxes are recalculated.

• action - String - "changeTaxRoundingMode"
• taxRoundingMode - RoundingMode

The shippingRateInput is used as an input to select a ShippingRatePriceTier. If no matching tier can be found, or the input is not set, the default price is used.

• action - String - "setShippingRateInput"
• shippingRateInput - ShippingRateInputDraft - Optional
  Based on the definition of ShippingRateInputType. If CartClassification is defined, it must be ClassificationShippingRateInput. If CartScore is defined, it must be ScoreShippingRateInput. Otherwise it can not bet set.

Changes the TaxCalculationMode of a cart. When changing the tax calculation mode, the taxes are recalculated.

• action - String - "changeTaxCalculationMode"
• taxCalculationMode - TaxCalculationMode

Adds all LineItems of a ShoppingList to the cart.

• action - String - "addShoppingList"
• shoppingList - ResourceIdentifier of a ShoppingList
• supplyChannel - ResourceIdentifier of a Channel - Optional
  If present a Reference to the channel will be set for all LineItems that are added to the cart.
  The channel must have the InventorySupply channelRoleEnum.
• distributionChannel - ResourceIdentifier of a Channel - Optional
  If present a Reference to the channel will be set for all LineItems that are added to the cart.
  The Channel must have the ProductDistribution ChannelRoleEnum

Adds a product variant in the given quantity to the cart.

If the cart already contains a line item for the same product variant with the same LineItemMode, custom fields, supply, and distribution channel, then only the quantity of the existing LineItem is increased. If shippingDetails are set, they will be merged, meaning 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 will always be added when the externalPrice or the externalTotalPrice is set in this update action.
The LineItem price is set as described in LineItem Price selection.

• action - String - "addLineItem"
• LineItemDraft - Required

Specific Error Codes:

• MatchingPriceNotFound
• MissingTaxRateForCountry

Decreases the quantity of the given LineItem. The LineItem price is updated as described in LineItem Price selection.

• action - String - "removeLineItem"
• lineItemId - String - Required
  ID of an existing LineItem in the cart.
• quantity - Number - Optional If the quantity is absent or the line item quantity drops to less than 1, the line item is removed from the cart.
• externalPrice - Money - Optional
  Sets the line item price to the given value when decreasing the quantity of a line item with the ExternalPrice LineItemPriceMode priceMode.
• externalTotalPrice - ExternalLineItemTotalPrice - Optional
  Sets the line item price and totalPrice to the given values when decreasing the quantity of a line item with the ExternalTotal LineItemPriceMode priceMode.
• shippingDetailsToRemove - ItemShippingDetailsDraft - Optional
  Container for line item specific address(es) that are to be removed.

Sets the quantity of the given LineItem.
If quantity is 0, the line item is removed from the cart.
The LineItem price is updated as described in LineItem Price selection.

ChangeLineItemQuantity does not support changing the shipping details when multiple shipping addresses are set for one line item. RemoveLineItem and AddLineItem support this, but not ChangeLineItem. This is the case because it is not possible to deduct how the distribution of sub-quantities should be adapted in accordance with the overall change in the line item quantity. Thus, the shippingDetails field will be kept in its current state to avoid data loss. Use SetLineItemShippingDetails in combination with this update action in one cart update command to change the line item quantity and shipping details together.

• action - String - "changeLineItemQuantity"
• lineItemId - String - Required
  ID of an existing LineItem in the cart.
• quantity - Number - Required
• externalPrice - Money - Optional
  Sets the line item price to the given value when changing the quantity of a line item with the ExternalPrice LineItemPriceMode priceMode.
• externalTotalPrice - ExternalLineItemTotalPrice - Optional
  Sets the line item price and totalPrice to the given values when changing the quantity of a line item with the ExternalTotal LineItemPriceMode priceMode.

A line item tax rate can be set if the cart has the External TaxMode.

• action - String - "setLineItemTaxRate"
• lineItemId - String
• externalTaxRate - ExternalTaxRateDraft - Optional

A line item tax amount can be set if the cart has the ExternalAmount TaxMode.

• action - String - "setLineItemTaxAmount"
• lineItemId - String
• externalTaxAmount - ExternalTaxAmountDraft - Optional

Sets the price of a line item and changes the priceMode of the line item to ExternalPrice LineItemPriceMode. If the price mode of the line item is ExternalPrice and no externalPrice is given, the external price is unset and the priceMode is set to Platform.

• action - String - "setLineItemPrice"
• lineItemId - String
• externalPrice - Money - Optional

Sets the totalPrice and price of a line item and changes the priceMode of the line item to ExternalTotal LineItemPriceMode. If the price mode of the line item is ExternalTotal and no externalTotalPrice is given, the external price is unset and the priceMode is set to Platform.

• action - String - "setLineItemTotalPrice"
• lineItemId - String
• externalTotalPrice - ExternalLineItemTotalPrice - Optional

Sets the distribution channel of the given LineItem.
The LineItem price is updated as described in LineItem Price selection.

• action - String - "setLineItemDistributionChannel"
• lineItemId - String - Required
  ID of an existing LineItem in the cart.
• distributionChannel - ResourceIdentifier of a Channel - Optional
  If present a Reference to the channel will be set for the LineItem specified by lineItemId. If not present the current Reference to a distribution channel will be removed from the LineItem specified by lineItemId. The Channel must have the ProductDistribution ChannelRoleEnum

Adds a CustomLineItem to the cart.

If the cart already contains a CustomLineItem with the same slug, name, money, tax category, state, and custom fields, then only the quantity of the existing custom line item is increased. If shippingDetails are set, they will be merged, meaning all addresses will be present afterwards and, for address keys present in both shipping details, the quantity will be summed up. If the cart already contains a custom line item with the same slug that is otherwise not identical, an InvalidOperation error is returned.

• action - String - "addCustomLineItem"
• name - LocalizedString
• quantity - Number - Optional - Defaults to 1
• money - Money
• slug - String
• taxCategory - ResourceIdentifier to a TaxCategory - Required only for Platform TaxMode
  The given tax category will be used to select a tax rate when a cart has the tax mode Platform.
• externalTaxRate - ExternalTaxRateDraft - Optional
  An external tax rate can be set if the cart has the External TaxMode.
• custom - CustomFieldsDraft - Optional
  The custom fields.
• shippingDetails - ItemShippingDetailsDraft - Optional
  Container for custom line item specific address(es).

Specific Error Codes:

• MissingTaxRateForCountry

Removes the custom CustomLineItem from the cart.

Removing a custom line item does not support specifying a quantity, unlike the removal of line items. It's not possible to partially remove shippingDetails using this update action. See Change CustomLineItem Quantity for that.

• action - String - "removeCustomLineItem"
• customLineItemId - String - Required
  ID of an existing CustomLineItem in the cart.

Sets the quantity of the given CustomLineItem.

ChangeCustomLineItemQuantity does not support changing the shipping details when multiple shipping addresses are set for one custom line item. AddCustomLineItem support this. This is the case because it is not possible to deduct how the distribution of sub-quantities should be adapted in accordance with the overall change in the custom line item quantity. Thus, the shippingDetails field will be kept in its current state to avoid data loss. Use SetCustomLineItemShippingDetails in combination with this update action in one cart update command to change the custom line item quantity and shipping details together.

• action - String - "changeCustomLineItemQuantity"
• customLineItemId - String - Required
  ID of an existing CustomLineItem in the cart.
• quantity - Number - Required
  The new quantity being a value >= 0. If quantity is 0, the custom line item will be removed from the cart.

Sets the money of the given CustomLineItem.

• action - String - "changeCustomLineItemMoney"
• customLineItemId - String - Required
  ID of an existing CustomLineItem in the cart.
• money - Money - Required
  The new money.

This action sets, overwrites, or removes the custom type and fields for an existing CustomLineItem.

• action - String - "setCustomLineItemCustomType"
• type - ResourceIdentifier to a Type - Optional
  If set, the custom type is set to this new value.
  If absent, the custom type and any existing CustomFields are removed at the same time.
• customLineItemId - String
• fields - A valid JSON object, based on the FieldDefinitions of the Type - Optional
  If set, the custom fields are set to this new value.

This action sets, overwrites, or removes any existing custom field for an existing CustomLineItem.

• action - String - "setCustomLineItemCustomField"
• customLineItemId - String
• name - String - Required
• value - Value - Optional
  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, set the value of the field defined by the name.

A custom line item tax rate can be set if the cart has the External TaxMode.

• action - String - "setCustomLineItemTaxRate"
• customLineItemId - String
• externalTaxRate - ExternalTaxRateDraft - Optional

A custom line item tax amount can be set if the cart has the ExternalAmount TaxMode.

• action - String - "setCustomLineItemTaxAmount"
• customLineItemId - String
• externalTaxAmount - ExternalTaxAmountDraft - Optional