`id` String	The unique ID of the API client. This is the OAuth2 `client_id` and can be used to obtain a token.
`createdAt` DateTime
`name` String
`scope` String	A whitespace separated list of the OAuth scopes. This is the OAuth2 `scope` and can be used to obtain a token.
`lastUsedAt` Date	The last day this API Client was used to obtain a token.
`deleteAt` DateTime	If set, the client will be deleted on (or shortly after) this point in time.
`secret` String	The secret is only shown once in the response of creating the API Client. This is the OAuth2 `client_secret` and can be used to obtain a token.

ApiClientDraft

`name` String
`scope` String
`deleteDaysAfterCreation` Int	If set, the client will be deleted after the specified amount of days.

ApiClientPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of ApiClient

CartAddCustomLineItemAction

`action` String	`"addCustomLineItem"`
`money` Money
`name` LocalizedString
`quantity` Int
`slug` String
`taxCategory` TaxCategoryResourceIdentifier
`externalTaxRate` ExternalTaxRateDraft
`custom` CustomFieldsDraft

Example: json

{
  "action" : "addCustomLineItem",
  "name" : {
    "en" : "Name EN",
    "de" : "Name DE"
  },
  "quantity" : 1,
  "money" : {
    "currencyCode" : "EUR",
    "centAmount" : 4200
  },
  "slug" : "mySlug",
  "taxCategory" : {
    "typeId" : "tax-category",
    "id" : "{{category-id}}"
  }
}

CartAddDiscountCodeAction

`action` String	`"addDiscountCode"`
`code` String

Example: json

{
  "action" : "addDiscountCode",
  "code" : "mydiscountcode"
}

CartAddItemShippingAddressAction

`action` String	`"addItemShippingAddress"`
`address` BaseAddress

Example: json

{
  "action" : "addItemShippingAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

CartAddLineItemAction

`action` String	`"addLineItem"`
`distributionChannel` ChannelResourceIdentifier
`externalTaxRate` ExternalTaxRateDraft
`productId` String
`variantId` Int
`sku` String
`quantity` Int
`supplyChannel` ChannelResourceIdentifier
`externalPrice` Money
`externalTotalPrice` ExternalLineItemTotalPrice
`shippingDetails` ItemShippingDetailsDraft
`custom` CustomFieldsDraft

Example: json

{
  "action" : "addLineItem",
  "productId" : "{{product-id}}",
  "variantId" : 2,
  "quantity" : 1,
  "supplyChannel" : {
    "typeId" : "channel",
    "id" : "{{channel-id}}"
  },
  "distributionChannel" : {
    "typeId" : "channel",
    "id" : "{{channel-id}}"
  },
  "externalTaxRate" : {
    "name" : "StandardExternalTaxRate",
    "amount" : 0.19,
    "country" : "DE",
    "state" : "Bavaria"
  },
  "shippingDetails" : {
    "targets" : [ {
      "addressKey" : "AddressKeyStringFromAddress",
      "quantity" : 2
    } ]
  }
}

CartAddPaymentAction

`action` String	`"addPayment"`
`payment` PaymentResourceIdentifier

Example: json

{
  "action" : "addPayment",
  "payment" : {
    "id" : "{{payment-id}}",
    "typeId" : "payment"
  }
}

CartAddShoppingListAction

`action` String	`"addShoppingList"`
`shoppingList` ShoppingListResourceIdentifier
`supplyChannel` ChannelResourceIdentifier
`distributionChannel` ChannelResourceIdentifier

Example: json

{
  "action" : "addShoppingList",
  "shoppingList" : {
    "id" : "{{shopping-list-id}}",
    "typeId" : "shopping-list"
  },
  "supplyChannel" : {
    "typeId" : "channel",
    "id" : "{{channel-id}}"
  },
  "distributionChannel" : {
    "typeId" : "channel",
    "id" : "{{channel-id}}"
  }
}

CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction

`action` String	`"applyDeltaToCustomLineItemShippingDetailsTargets"`
`customLineItemId` String
`targetsDelta` Array of ItemShippingTarget

Example: json

{
  "action" : "applyDeltaToCustomLineItemShippingDetailsTargets",
  "customLineItemId" : "{{lineItemId}}",
  "targetsDelta" : [ {
    "addressKey" : "addressKeyString",
    "quantity" : 1
  } ]
}

CartApplyDeltaToLineItemShippingDetailsTargetsAction

`action` String	`"applyDeltaToLineItemShippingDetailsTargets"`
`lineItemId` String
`targetsDelta` Array of ItemShippingTarget

Example: json

{
  "action" : "applyDeltaToLineItemShippingDetailsTargets",
  "lineItemId" : "{{lineItemId}}",
  "targetsDelta" : [ {
    "addressKey" : "addressKeyString",
    "quantity" : 1
  } ]
}

CartChangeCustomLineItemMoneyAction

`action` String	`"changeCustomLineItemMoney"`
`customLineItemId` String
`money` Money

Example: json

{
  "action" : "changeCustomLineItemMoney",
  "customLineItemId" : "{{customLineItemId}}",
  "money" : {
    "currencyCode" : "EUR",
    "centAmount" : 4200
  }
}

CartChangeCustomLineItemQuantityAction

`action` String	`"changeCustomLineItemQuantity"`
`customLineItemId` String
`quantity` Int

Example: json

{
  "action" : "changeCustomLineItemQuantity",
  "customLineItemId" : "{{lineItemId}}",
  "quantity" : 1
}

CartChangeLineItemQuantityAction

`action` String	`"changeLineItemQuantity"`
`lineItemId` String
`quantity` Int
`externalPrice` Money
`externalTotalPrice` ExternalLineItemTotalPrice

Example: json

{
  "action" : "changeLineItemQuantity",
  "lineItemId" : "{{lineItemId}}",
  "quantity" : 1
}

CartChangeTaxCalculationModeAction

`action` String	`"changeTaxCalculationMode"`
`taxCalculationMode` TaxCalculationMode

Example: json

{
  "action" : "changeTaxCalculationMode",
  "taxCalculationMode" : "LineItemLevel"
}

CartChangeTaxModeAction

`action` String	`"changeTaxMode"`
`taxMode` TaxMode

Example: json

{
  "action" : "changeTaxMode",
  "taxMode" : "Platform"
}

CartChangeTaxRoundingModeAction

`action` String	`"changeTaxRoundingMode"`
`taxRoundingMode` RoundingMode

Example: json

{
  "action" : "changeTaxRoundingMode",
  "taxRoundingMode" : "HalfUp"
}

CartDraft

`key` String	User-specific unique identifier of the cart.
`currency` CurrencyCode	A three-digit currency code as per ISO 4217.
`customerId` String	Id of an existing Customer.
`customerEmail` String
`customerGroup` CustomerGroupResourceIdentifier	Will be set automatically when the `customerId` is set and the customer is a member of a customer group. Can be set explicitly when no `customerId` is present.
`anonymousId` String	Assigns the new cart to an anonymous session (the customer has not signed up/in yet).
`store` StoreResourceIdentifier	Assigns the new cart to the store. The store assignment can not be modified.
`country` String	A two-digit country code as per ISO 3166-1 alpha-2.
`inventoryMode` InventoryMode	Default inventory mode is `None`.
`taxMode` TaxMode	The default tax mode is `Platform`.
`taxRoundingMode` RoundingMode	The default tax rounding mode is `HalfEven`.
`taxCalculationMode` TaxCalculationMode	The default tax calculation mode is `LineItemLevel`.
`lineItems` Array of LineItemDraft
`customLineItems` Array of CustomLineItemDraft
`shippingAddress` BaseAddress	The shipping address is used to determine the eligible shipping methods and rates as well as the tax rate of the line items.
`billingAddress` BaseAddress
`shippingMethod` ShippingMethodResourceIdentifier
`externalTaxRateForShippingMethod` ExternalTaxRateDraft	An external tax rate can be set for the `shippingMethod` if the cart has the `External` TaxMode.
`locale` String	Must be one of the languages supported for this project
`deleteDaysAfterLastModification` Int	The cart will be deleted automatically if it hasn't been modified for the specified amount of days and it is in the `Active` CartState. If a ChangeSubscription for carts exists, a `ResourceDeleted` notification will be sent.
`origin` CartOrigin	The default origin is `Customer`.
`shippingRateInput` ShippingRateInputDraft	The shippingRateInput is used as an input to select a ShippingRatePriceTier. 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.
`itemShippingAddresses` Array of BaseAddress	Contains addresses for carts with multiple shipping addresses. Each address must contain a key which is unique in this cart. Line items will use these keys to reference the addresses under their `shippingDetails`. The addresses captured here are not used to determine eligible shipping methods or the applicable tax rate. Only the cart's `shippingAddress` is used for this.
`discountCodes` Array of String	The code of existing DiscountCodes.
`custom` CustomFieldsDraft	The custom fields.

CartOrigin

Customer
Merchant

CartPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of Cart

CartRecalculateAction

`action` String	`"recalculate"`
`updateProductData` Boolean	If set to `true`, the line item product data (`name`, `variant` and `productType`) will also be updated. If set to `false`, only the prices and tax rates of the line item will be updated. The updated price of a line item may not correspond to a price in `variant.prices` anymore.

Example: json

{
  "action" : "recalculate",
  "updateProductData" : false
}

CartReference

`id` String
`typeId` String	`"cart"`
`obj` Cart

CartRemoveCustomLineItemAction

`action` String	`"removeCustomLineItem"`
`customLineItemId` String

Example: json

{
  "action" : "removeCustomLineItem",
  "customLineItemId" : "{{customLineItemId}}"
}

CartRemoveDiscountCodeAction

`action` String	`"removeDiscountCode"`
`discountCode` DiscountCodeReference

Example: json

{
  "action" : "removeDiscountCode",
  "discountCode" : {
    "typeId" : "discount-code",
    "id" : "{{discount-code-id}}"
  }
}

CartRemoveItemShippingAddressAction

`action` String	`"removeItemShippingAddress"`
`addressKey` String

Example: json

{
  "action" : "removeItemShippingAddress",
  "addressKey" : "{{addressKey}}"
}

CartRemoveLineItemAction

`action` String	`"removeLineItem"`
`lineItemId` String
`quantity` Int
`externalPrice` Money
`externalTotalPrice` ExternalLineItemTotalPrice
`shippingDetailsToRemove` ItemShippingDetailsDraft

Example: json

{
  "action" : "removeLineItem",
  "lineItemId" : "{{lineItemId}}",
  "quantity" : 1,
  "externalPrice" : {
    "currencyCode" : "EUR",
    "centAmount" : 4000
  },
  "shippingDetailsToRemove" : {
    "targets" : [ {
      "addressKey" : "AddressKeyStringFromAddress",
      "quantity" : 2
    } ]
  }
}

CartRemovePaymentAction

`action` String	`"removePayment"`
`payment` PaymentResourceIdentifier

Example: json

{
  "action" : "removePayment",
  "payment" : {
    "id" : "{{payment-id}}",
    "typeId" : "payment"
  }
}

CartResourceIdentifier

`id` String
`key` String
`typeId` String	`"cart"`

CartSetAnonymousIdAction

`action` String	`"setAnonymousId"`
`anonymousId` String	If not set, any existing anonymous ID will be removed.

Example: json

{
  "action" : "setAnonymousId",
  "anonymousId" : "idString"
}

CartSetBillingAddressAction

`action` String	`"setBillingAddress"`
`address` BaseAddress

Example: json

{
  "action" : "setBillingAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

CartSetBillingAddressCustomFieldAction

`action` String	`"setBillingAddressCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setBillingAddressCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetBillingAddressCustomTypeAction

`action` String	`"setBillingAddressCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setBillingAddressCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetCartTotalTaxAction

`action` String	`"setCartTotalTax"`
`externalTotalGross` Money	The total gross amount of the cart (totalNet + taxes).
`externalTaxPortions` Array of TaxPortionDraft

Example: json

{
  "action" : "setCartTotalTax",
  "externalTotalGross" : {
    "currencyCode" : "EUR",
    "centAmount" : 10000
  }
}

CartSetCountryAction

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

Example: json

{
  "action" : "setCountry",
  "country" : "DE"
}

CartSetCustomerEmailAction

`action` String	`"setCustomerEmail"`
`email` String

Example: json

{
  "action" : "setCustomerEmail",
  "email" : "foo@bar.com"
}

CartSetCustomerGroupAction

`action` String	`"setCustomerGroup"`
`customerGroup` CustomerGroupResourceIdentifier

Example: json

{
  "action" : "setCustomerGroup",
  "customerGroup" : {
    "id" : "{{customer-group-id}}",
    "typeId" : "customer-group"
  }
}

CartSetCustomerIdAction

`action` String	`"setCustomerId"`
`customerId` String	If set, a customer with the given ID must exist in the project.

Example: json

{
  "action" : "setCustomerId",
  "customerId" : "{{customer-id}}"
}

CartSetCustomFieldAction

`action` String	`"setCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetCustomLineItemCustomFieldAction

`action` String	`"setCustomLineItemCustomField"`
`customLineItemId` String
`name` String
`value` Any

Example: json

{
  "action" : "setCustomLineItemCustomField",
  "customLineItemId" : "{{customLineItemId}}",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetCustomLineItemCustomTypeAction

`action` String	`"setCustomLineItemCustomType"`
`customLineItemId` String
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setCustomLineItemCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  },
  "customLineItemId" : "{{customLineItemId}}"
}

CartSetCustomLineItemShippingDetailsAction

`action` String	`"setCustomLineItemShippingDetails"`
`customLineItemId` String
`shippingDetails` ItemShippingDetailsDraft

Example: json

{
  "action" : "setCustomLineItemShippingDetails",
  "customLineItemId" : "{{lineItemId}}",
  "shippingDetails" : {
    "targets" : [ {
      "addressKey" : "{{addressKey}}",
      "quantity" : 1
    } ]
  }
}

CartSetCustomLineItemTaxAmountAction

`action` String	`"setCustomLineItemTaxAmount"`
`customLineItemId` String
`externalTaxAmount` ExternalTaxAmountDraft

Example: json

{
  "action" : "setCustomLineItemTaxAmount",
  "customLineItemId" : "{{customLineItemId}}",
  "externalTaxAmount" : {
    "totalGross" : {
      "centAmount" : 2000000,
      "currencyCode" : "EUR"
    },
    "taxRate" : {
      "name" : "myTaxRate",
      "amount" : 0.19,
      "country" : "DE"
    }
  }
}

CartSetCustomLineItemTaxRateAction

`action` String	`"setCustomLineItemTaxRate"`
`customLineItemId` String
`externalTaxRate` ExternalTaxRateDraft

Example: json

{
  "action" : "setCustomLineItemTaxRate",
  "customLineItemId" : "{{customLineItemId}}",
  "externalTaxRate" : {
    "name" : "TaxRateName",
    "country" : "DE",
    "amount" : 0.19
  }
}

CartSetCustomShippingMethodAction

`action` String	`"setCustomShippingMethod"`
`shippingMethodName` String
`shippingRate` ShippingRateDraft
`taxCategory` TaxCategoryResourceIdentifier
`externalTaxRate` ExternalTaxRateDraft

Example: json

{
  "action" : "setCustomShippingMethod",
  "shippingMethodName" : "myCustomShippingMethod",
  "shippingRate" : {
    "price" : {
      "currencyCode" : "EUR",
      "centAmount" : 4200
    }
  },
  "taxCategory" : {
    "id" : "{{category-id}}",
    "typeId" : "tax-category"
  }
}

CartSetCustomTypeAction

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetDeleteDaysAfterLastModificationAction

`action` String	`"setDeleteDaysAfterLastModification"`
`deleteDaysAfterLastModification` Int

Example: json

{
  "action" : "setDeleteDaysAfterLastModification",
  "deleteDaysAfterLastModification" : 90
}

CartSetDeliveryAddressCustomFieldAction

`action` String	`"setDeliveryAddressCustomField"`
`deliveryId` String
`name` String
`value` Any

Example: json

{
  "action" : "setDeliveryAddressCustomField",
  "deliveryId" : "{{delivery-id}}",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetDeliveryAddressCustomTypeAction

`action` String	`"setDeliveryAddressCustomType"`
`deliveryId` String
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setDeliveryAddressCustomType",
  "deliveryId" : "{{delivery-id}}",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetItemShippingAddressCustomFieldAction

`action` String	`"setItemShippingAddressCustomField"`
`addressKey` String
`name` String
`value` Any

Example: json

{
  "action" : "setItemShippingAddressCustomField",
  "addressKey" : "{{address-key}}",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetItemShippingAddressCustomTypeAction

`action` String	`"setItemShippingAddressCustomType"`
`addressKey` String
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setItemShippingAddressCustomType",
  "addressKey" : "{{address-key}}",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetKeyAction

`key` String
`action` String	`"setKey"`

Example: json

{
  "action" : "setKey",
  "key" : "myNewKey"
}

CartSetLineItemCustomFieldAction

`action` String	`"setLineItemCustomField"`
`lineItemId` String
`name` String
`value` Any

Example: json

{
  "action" : "setLineItemCustomField",
  "lineItemId" : "{{lineItemId}}",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetLineItemCustomTypeAction

`action` String	`"setLineItemCustomType"`
`lineItemId` String
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setLineItemCustomType",
  "lineItemId" : "{{lineItemId}}",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetLineItemDistributionChannelAction

`action` String	`"setLineItemDistributionChannel"`
`lineItemId` String
`distributionChannel` ChannelResourceIdentifier

Example: json

{
  "action" : "setLineItemDistributionChannel",
  "lineItemId" : "{{lineItemId}}",
  "distributionChannel" : {
    "typeId" : "channel",
    "id" : "{{channel-id}}"
  }
}

CartSetLineItemPriceAction

`action` String	`"setLineItemPrice"`
`lineItemId` String
`externalPrice` Money

Example: json

{
  "action" : "setLineItemPrice",
  "lineItemId" : "{{lineItemId}}",
  "externalPrice" : {
    "currencyCode" : "EUR",
    "centAmount" : 4000
  }
}

CartSetLineItemShippingDetailsAction

`action` String	`"setLineItemShippingDetails"`
`lineItemId` String
`shippingDetails` ItemShippingDetailsDraft

Example: json

{
  "action" : "setLineItemShippingDetails",
  "lineItemId" : "{{lineItemId}}",
  "shippingDetails" : {
    "targets" : [ {
      "addressKey" : "{{addressKey}}",
      "quantity" : 1
    } ]
  }
}

CartSetLineItemTaxAmountAction

`action` String	`"setLineItemTaxAmount"`
`lineItemId` String
`externalTaxAmount` ExternalTaxAmountDraft

Example: json

{
  "action" : "setLineItemTaxAmount",
  "lineItemId" : "{{lineItemId}}",
  "externalTaxAmount" : {
    "totalGross" : {
      "currencyCode" : "EUR",
      "centAmount" : 100
    },
    "taxRate" : {
      "name" : "myTaxRate",
      "amount" : 0.19,
      "country" : "DE"
    }
  }
}

CartSetLineItemTaxRateAction

`action` String	`"setLineItemTaxRate"`
`lineItemId` String
`externalTaxRate` ExternalTaxRateDraft

Example: json

{
  "action" : "setLineItemTaxRate",
  "lineItemId" : "{{lineItemId}}",
  "externalTaxRate" : {
    "name" : "myTaxRate",
    "amount" : 0.19,
    "country" : "DE"
  }
}

CartSetLineItemTotalPriceAction

`action` String	`"setLineItemTotalPrice"`
`lineItemId` String
`externalTotalPrice` ExternalLineItemTotalPrice

Example: json

{
  "action" : "setLineItemTotalPrice",
  "lineItemId" : "{{lineItemId}}",
  "externalTotalPrice" : {
    "price" : {
      "currencyCode" : "EUR",
      "centAmount" : 4200
    },
    "totalPrice" : {
      "currencyCode" : "EUR",
      "centAmount" : 4200
    }
  }
}

CartSetLocaleAction

`action` String	`"setLocale"`
`locale` String

Example: json

{
  "action" : "setLocale",
  "locale" : "de-DE"
}

CartSetShippingAddressAction

`action` String	`"setShippingAddress"`
`address` BaseAddress

Example: json

{
  "action" : "setShippingAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

CartSetShippingAddressCustomFieldAction

`action` String	`"setShippingAddressCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setShippingAddressCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartSetShippingAddressCustomTypeAction

`action` String	`"setShippingAddressCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setShippingAddressCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartSetShippingMethodAction

`action` String	`"setShippingMethod"`
`shippingMethod` ShippingMethodResourceIdentifier
`externalTaxRate` ExternalTaxRateDraft

Example: json

{
  "action" : "setShippingMethod",
  "shippingMethod" : {
    "id" : "{{shipping-method-id}}",
    "typeId" : "shipping-method"
  }
}

CartSetShippingMethodTaxAmountAction

`action` String	`"setShippingMethodTaxAmount"`
`externalTaxAmount` ExternalTaxAmountDraft

Example: json

{
  "action" : "setShippingMethodTaxAmount",
  "externalTaxAmount" : {
    "totalGross" : {
      "centAmount" : 2000000,
      "currencyCode" : "EUR"
    },
    "taxRate" : {
      "name" : "myTaxRate",
      "amount" : 0.19,
      "country" : "DE"
    }
  }
}

CartSetShippingMethodTaxRateAction

`action` String	`"setShippingMethodTaxRate"`
`externalTaxRate` ExternalTaxRateDraft

Example: json

{
  "action" : "setShippingMethodTaxRate",
  "externalTaxRate" : {
    "name" : "myTaxRate",
    "amount" : 0.19,
    "country" : "DE"
  }
}

CartSetShippingRateInputAction

`action` String	`"setShippingRateInput"`
`shippingRateInput` ShippingRateInputDraft	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.

Example: json

{
  "action" : "setShippingRateInput",
  "shippingRateInput" : {
    "type" : "Classification",
    "key" : "shippingRateString"
  }
}

CartState

Active
Merged
Ordered

CartUpdate

`version` Int
`actions` Array of CartUpdateAction

CartUpdateAction

action

String

CartUpdateItemShippingAddressAction

`action` String	`"updateItemShippingAddress"`
`address` BaseAddress

Example: json

{
  "action" : "updateItemShippingAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

ClassificationShippingRateInput

`key` String
`type` String	`"Classification"`
`label` LocalizedString

ClassificationShippingRateInputDraft

`key` String
`type` String	`"Classification"`

CustomLineItem

`id` String	The unique ID of this CustomLineItem.
`name` LocalizedString	The name of this CustomLineItem.
`money` TypedMoney	The cost to add to the cart. The amount can be negative.
`taxedPrice` TaxedItemPrice	Set once the `taxRate` is set.
`totalPrice` TypedMoney	The total price of this custom line item. If custom line item is discounted, then the `totalPrice` would be the discounted custom line item price multiplied by `quantity`. Otherwise a total price is just a `money` multiplied by the `quantity`. `totalPrice` may or may not include the taxes: it depends on the taxRate.includedInPrice property.
`slug` String	A unique String in the cart to identify this CustomLineItem.
`quantity` Int	The amount of a CustomLineItem in the cart. Must be a positive integer.
`state` Array of ItemState
`taxCategory` TaxCategoryReference
`taxRate` TaxRate	Will be set automatically in the `Platform` TaxMode once the shipping address is set is set. For the `External` tax mode the tax rate has to be set explicitly with the ExternalTaxRateDraft.
`discountedPricePerQuantity` Array of DiscountedLineItemPriceForQuantity
`shippingDetails` ItemShippingDetails	Container for custom line item specific address(es). CustomLineItem fields that can be used in query predicates: `slug`, `name`, `quantity`, `money`, `state`, `discountedPricePerQuantity`.
`custom` CustomFields

CustomLineItemDraft

`name` LocalizedString
`quantity` Int	The amount of a CustomLineItemin the cart. Must be a positive integer.
`money` Money
`slug` String
`taxCategory` TaxCategoryResourceIdentifier	The given tax category will be used to select a tax rate when a cart has the TaxMode `Platform`.
`externalTaxRate` ExternalTaxRateDraft	An external tax rate can be set if the cart has the `External` TaxMode.
`shippingDetails` ItemShippingDetailsDraft	Container for custom line item specific address(es).
`custom` CustomFieldsDraft	The custom fields.

CustomLineItemImportDraft

`name` LocalizedString
`quantity` Int	The amount of a CustomLineItem in the cart. Must be a positive integer.
`money` Money	The cost to add to the cart. The amount can be negative.
`slug` String
`state` Array of ItemState
`taxRate` TaxRate
`taxCategory` TaxCategoryResourceIdentifier
`shippingDetails` ItemShippingDetailsDraft
`custom` CustomFieldsDraft	The custom fields.

DiscountCodeInfo

`discountCode` DiscountCodeReference
`state` DiscountCodeState

DiscountCodeState

NotActive
DoesNotMatchCart
MatchesCart
MaxApplicationReached
ApplicationStoppedByPreviousDiscount
NotValid

DiscountedLineItemPortion

`discount` CartDiscountReference
`discountedAmount` TypedMoney

DiscountedLineItemPrice

`value` TypedMoney
`includedDiscounts` Array of DiscountedLineItemPortion

DiscountedLineItemPriceForQuantity

`quantity` Float
`discountedPrice` DiscountedLineItemPrice

ExternalLineItemTotalPrice

`price` Money
`totalPrice` Money

ExternalTaxAmountDraft

`totalGross` Money	The total gross amount of the item (totalNet + taxes).
`taxRate` ExternalTaxRateDraft

ExternalTaxRateDraft

`name` String
`amount` Float	Percentage in the range of [0..1]. Must be supplied if no `subRates` are specified. If `subRates` are specified then the `amount` can be omitted or it must be the sum of the amounts of all `subRates`.
`country` String	A two-digit country code as per ISO 3166-1 alpha-2.
`state` String	The state in the country
`subRates` Array of SubRate	For countries (e.g. the US) where the total tax is a combination of multiple taxes (e.g. state and local taxes).
`includedInPrice` Boolean	The default value for `includedInPrice` is FALSE.

InventoryMode

TrackOnly
ReserveOnOrder
None

ItemShippingDetails

`targets` Array of ItemShippingTarget	Used to map what sub-quantity should be shipped to which address. Duplicate address keys are not allowed.
`valid` Boolean	`true` if the quantity of the (custom) line item is equal to the sum of the sub-quantities in `targets`, `false` otherwise. A cart cannot be ordered when the value is `false`. The error InvalidItemShippingDetails will be triggered.

ItemShippingDetailsDraft

targets

Array of ItemShippingTarget

Used to capture one or more (custom) line item specific shipping addresses. By specifying sub-quantities, it is possible to set multiple shipping addresses for one line item. A cart can have shippingDetails where the targets sum does not match the quantity of the line item or custom line item. For the order creation and order updates the targets sum must match the quantity.

ItemShippingTarget

`addressKey` String	The key of the address in the cart's `itemShippingAddresses`
`quantity` Float	The quantity of items that should go to the address with the specified `addressKey`. Only positive values are allowed. Using `0` as quantity is also possible in a draft object, but the element will not be present in the resulting ItemShippingDetails.

LineItem

`id` String	The unique ID of this LineItem.
`lastModifiedAt` DateTime	The date when the LineItem was last modified by one of the following actions setLineItemShippingDetails, addLineItem, removeLineItem, or changeLineItemQuantity. Optional only for backwards compatible reasons. When the LineItem is created lastModifiedAt is set to addedAt.
`productId` String
`name` LocalizedString	The product name.
`productSlug` LocalizedString	The slug of a product is inserted on the fly. It is always up-to-date and can therefore be used to link to the product detail page of the product. It is empty if the product has been deleted. The slug is also empty if the cart or order is retrieved via Reference Expansion or is a snapshot in a Message.
`productType` ProductTypeReference
`variant` ProductVariant	The variant data is saved when the variant is added to the cart, and not updated automatically. It can manually be updated with the Recalculate update action.
`price` Price	The price of a line item is selected from the prices array of the product variant. If the `variant` field hasn't been updated, the price may not correspond to a price in `variant.prices`.
`taxedPrice` TaxedItemPrice	Set once the `taxRate` is set.
`totalPrice` TypedMoney	The total price of this line item. If the line item is discounted, then the `totalPrice` is the DiscountedLineItemPriceForQuantity multiplied by `quantity`. Otherwise the total price is the product price multiplied by the `quantity`. `totalPrice` may or may not include the taxes: it depends on the taxRate.includedInPrice property.
`quantity` Int	The amount of a LineItem in the cart. Must be a positive integer.
`addedAt` DateTime	When the line item was added to the cart. Optional for backwards compatibility reasons only.
`state` Array of ItemState
`taxRate` TaxRate	Will be set automatically in the `Platform` TaxMode once the shipping address is set is set. For the `External` tax mode the tax rate has to be set explicitly with the ExternalTaxRateDraft.
`supplyChannel` ChannelReference	The supply channel identifies the inventory entries that should be reserved. The channel has the role InventorySupply.
`distributionChannel` ChannelReference	The distribution channel is used to select a ProductPrice. The channel has the role ProductDistribution.
`discountedPricePerQuantity` Array of DiscountedLineItemPriceForQuantity
`priceMode` LineItemPriceMode
`lineItemMode` LineItemMode
`shippingDetails` ItemShippingDetails	Container for line item specific address(es).
`custom` CustomFields

LineItemDraft

`productId` String
`variantId` Int
`sku` String
`quantity` Int	The amount of a `LineItem`in the cart. Must be a positive integer. Default: `1`
`addedAt` DateTime	When the line item was added to the cart. Optional for backwards compatibility reasons only.
`supplyChannel` ChannelResourceIdentifier	By providing supply channel information, you can unique identify inventory entries that should be reserved. The provided channel should have the InventorySupply role.
`distributionChannel` ChannelResourceIdentifier	The channel is used to select a ProductPrice. The provided channel should have the ProductDistribution role.
`externalTaxRate` ExternalTaxRateDraft	An external tax rate can be set if the cart has the `External` TaxMode.
`externalPrice` Money	Sets the line item `price` to the given value and sets the line item `priceMode` to `ExternalPrice` LineItemPriceMode.
`externalTotalPrice` ExternalLineItemTotalPrice	Sets the line item `price` and `totalPrice` to the given values and sets the line item `priceMode` to `ExternalTotal` LineItemPriceMode.
`shippingDetails` ItemShippingDetailsDraft	Container for line item specific address(es).
`custom` CustomFieldsDraft	The custom fields.

LineItemMode

Standard
GiftLineItem

LineItemPriceMode

Platform
ExternalTotal
ExternalPrice

ProductPublishScope

All
Prices

ReplicaCartDraft

`key` String	User-specific unique identifier of the cart.
`reference` Union

RoundingMode

HalfEven
HalfUp
HalfDown

ScoreShippingRateInput

`type` String	`"Score"`
`score` Float

ScoreShippingRateInputDraft

`type` String	`"Score"`
`score` Float

ShippingInfo

`shippingMethodName` String
`price` TypedMoney	Determined based on the ShippingRate and its tiered prices, and either the sum of LineItem prices or the `shippingRateInput` field.
`shippingRate` ShippingRate	The shipping rate used to determine the price.
`taxedPrice` TaxedItemPrice	Set once the `taxRate` is set.
`taxRate` TaxRate	Will be set automatically in the `Platform` TaxMode once the shipping address is set is set. For the `External` tax mode the tax rate has to be set explicitly with the ExternalTaxRateDraft.
`taxCategory` TaxCategoryReference
`shippingMethod` ShippingMethodReference	Not set if custom shipping method is used.
`deliveries` Array of Delivery	Deliveries are compilations of information on how the articles are being delivered to the customers.
`discountedPrice` DiscountedLineItemPrice
`shippingMethodState` ShippingMethodState	Indicates whether the ShippingMethod referenced in this ShippingInfo is allowed for the cart or not.

ShippingMethodState

DoesNotMatchCart
MatchesCart

ShippingRateInput

type

String

ShippingRateInputDraft

type

String

TaxCalculationMode

LineItemLevel
UnitPriceLevel

TaxedItemPrice

`totalNet` TypedMoney
`totalGross` TypedMoney	TaxedItemPrice fields can not be used in query predicates.

TaxedPrice

`totalNet` TypedMoney
`totalGross` TypedMoney
`taxPortions` Array of TaxPortion	TaxedPrice fields that can be used in query predicates: `totalNet`, `totalGross`.

TaxedPriceDraft

`totalNet` Money
`totalGross` Money
`taxPortions` Array of TaxPortionDraft

TaxMode

Platform
External
ExternalAmount
Disabled

TaxPortion

`name` String
`rate` Float	A number in the range [0..1] Maximum: `1`
`amount` TypedMoney

TaxPortionDraft

`name` String
`rate` Float	Maximum: `1`
`amount` Money

CartDiscountChangeCartPredicateAction

`action` String	`"changeCartPredicate"`
`cartPredicate` String	A valid Cart predicate.

Example: json

{
  "action" : "changeCartPredicate",
  "cartPredicate" : "cartPredicateString"
}

CartDiscountChangeIsActiveAction

`action` String	`"changeIsActive"`
`isActive` Boolean

Example: json

{
  "action" : "changeIsActive",
  "isActive" : false
}

CartDiscountChangeNameAction

`action` String	`"changeName"`
`name` LocalizedString

Example: json

{
  "action" : "changeName",
  "name" : {
    "en" : "NewNameEN",
    "de" : "NewNameDE"
  }
}

CartDiscountChangeRequiresDiscountCodeAction

`action` String	`"changeRequiresDiscountCode"`
`requiresDiscountCode` Boolean

Example: json

{
  "action" : "changeRequiresDiscountCode",
  "requiresDiscountCode" : true
}

CartDiscountChangeSortOrderAction

`action` String	`"changeSortOrder"`
`sortOrder` String	The string must contain a number between 0 and 1. A discount with greater sortOrder is prioritized higher than a discount with lower sortOrder.

Example: json

{
  "action" : "changeSortOrder",
  "sortOrder" : "0.2"
}

CartDiscountChangeStackingModeAction

`action` String	`"changeStackingMode"`
`stackingMode` StackingMode

Example: json

{
  "action" : "changeStackingMode",
  "stackingMode" : "Stacking"
}

CartDiscountChangeTargetAction

`action` String	`"changeTarget"`
`target` CartDiscountTarget

Example: json

{
  "action" : "changeTarget",
  "target" : {
    "type" : "lineItems",
    "predicate" : "sku = \"myOtherSKU\""
  }
}

CartDiscountChangeValueAction

`action` String	`"changeValue"`
`value` CartDiscountValueDraft

Example: json

{
  "action" : "changeValue",
  "value" : {
    "type" : "absolute",
    "money" : [ {
      "currencyCode" : "EUR",
      "centAmount" : 40099
    } ]
  }
}

CartDiscountCustomLineItemsTarget

`type` String	`"customLineItems"`
`predicate` String

CartDiscountDraft

`key` String	User-specific unique identifier for a cart discount. Must be unique across a project. The field can be reset using the Set Key UpdateAction.
`name` LocalizedString
`description` LocalizedString
`value` CartDiscountValueDraft
`cartPredicate` String	A valid Cart predicate.
`target` CartDiscountTarget	Must not be set when the `value` has type `giftLineItem`, otherwise a CartDiscountTarget must be set.
`sortOrder` String	The string must contain a number between 0 and 1. A discount with greater sort order is prioritized higher than a discount with lower sort order. The sort order must be unambiguous among all cart discounts.
`isActive` Boolean	Only active discount can be applied to the cart. Defaults to `true`.
`validFrom` DateTime
`validUntil` DateTime
`requiresDiscountCode` Boolean	States whether the discount can only be used in a connection with a DiscountCode. Defaults to `false`.
`stackingMode` StackingMode	Specifies whether the application of this discount causes the following discounts to be ignored. Defaults to Stacking.
`custom` CustomFields

CartDiscountLineItemsTarget

`type` String	`"lineItems"`
`predicate` String

CartDiscountPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of CartDiscount

CartDiscountReference

`id` String
`typeId` String	`"cart-discount"`
`obj` CartDiscount

CartDiscountResourceIdentifier

`id` String
`key` String
`typeId` String	`"cart-discount"`

CartDiscountSetCustomFieldAction

`action` String	`"setCustomField"`
`name` String
`value` Any	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`. The FieldDefinition determines the format for the `value` to be provided.

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CartDiscountSetCustomTypeAction

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	If absent, the custom type and any existing CustomFields are removed.
`fields` Object	A valid JSON object, based on the FieldDefinitions of the Type. Sets the custom fields to this value.

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CartDiscountSetDescriptionAction

`action` String	`"setDescription"`
`description` LocalizedString	If the `description` parameter is not included, the field will be emptied.

Example: json

{
  "action" : "setDescription",
  "description" : {
    "en" : "New Description EN",
    "de" : "New Description DE"
  }
}

CartDiscountSetKeyAction

`key` String	If `key` is absent or `null`, this field will be removed if it exists.
`action` String	`"setKey"`

CartDiscountSetValidFromAction

`action` String	`"setValidFrom"`
`validFrom` DateTime	If absent, the field with the value is removed in case a value was set before.

Example: json

{
  "action" : "setValidFrom",
  "validFrom" : "2017-10-15T15:00:00.000Z"
}

CartDiscountSetValidFromAndUntilAction

`action` String	`"setValidFromAndUntil"`
`validFrom` DateTime	If absent, the field with the value is removed in case a value was set before.
`validUntil` DateTime	If absent, the field with the value is removed in case a value was set before.

Example: json

{
  "action" : "setValidFromAndUntil",
  "validFrom" : "2017-10-15T15:00:00.000Z",
  "validUntil" : "2017-10-15T15:05:00.000Z"
}

CartDiscountSetValidUntilAction

`action` String	`"setValidUntil"`
`validUntil` DateTime	If absent, the field with the value is removed in case a value was set before.

Example: json

{
  "action" : "setValidUntil",
  "validUntil" : "2017-10-15T20:00:00.000Z"
}

CartDiscountShippingCostTarget

type

String

"shipping"

CartDiscountTarget

type

String

CartDiscountUpdate

`version` Int
`actions` Array of CartDiscountUpdateAction

CartDiscountUpdateAction

action

String

CartDiscountValue

type

String

CartDiscountValueAbsolute

`type` String	`"absolute"`
`money` Array of TypedMoney

CartDiscountValueAbsoluteDraft

`type` String	`"absolute"`
`money` Array of Money

CartDiscountValueDraft

type

String

CartDiscountValueFixed

`type` String	`"fixed"`
`money` Array of TypedMoney

CartDiscountValueFixedDraft

`type` String	`"fixed"`
`money` Array of Money

CartDiscountValueGiftLineItem

`type` String	`"giftLineItem"`
`product` ProductReference
`variantId` Int
`supplyChannel` ChannelReference	The channel must have the role `InventorySupply`
`distributionChannel` ChannelReference	The channel must have the role `ProductDistribution`

CartDiscountValueGiftLineItemDraft

`type` String	`"giftLineItem"`
`product` ProductResourceIdentifier
`variantId` Int
`supplyChannel` ChannelResourceIdentifier	The channel must have the role `InventorySupply`
`distributionChannel` ChannelResourceIdentifier	The channel must have the role `ProductDistribution`

CartDiscountValueRelative

`type` String	`"relative"`
`permyriad` Int

CartDiscountValueRelativeDraft

`type` String	`"relative"`
`permyriad` Int

MultiBuyCustomLineItemsTarget

`type` String	`"multiBuyCustomLineItems"`
`predicate` String	A valid custom line item target predicate. The discount will be applied to custom line items that are matched by the predicate.
`triggerQuantity` Int	Quantity of line items that need to be present in order to trigger an application of this discount.
`discountedQuantity` Int	Quantity of line items that are discounted per application of this discount.
`maxOccurrence` Int	Maximum number of applications of this discount.
`selectionMode` SelectionMode

MultiBuyLineItemsTarget

`type` String	`"multiBuyLineItems"`
`predicate` String	A valid line item target predicate. The discount will be applied to line items that are matched by the predicate.
`triggerQuantity` Int	Quantity of line items that need to be present in order to trigger an application of this discount.
`discountedQuantity` Int	Quantity of line items that are discounted per application of this discount.
`maxOccurrence` Int	Maximum number of applications of this discount.
`selectionMode` SelectionMode

SelectionMode

Cheapest
MostExpensive

StackingMode

Stacking
StopAfterThisDiscount

CategoryAddAssetAction

`action` String	`"addAsset"`
`asset` AssetDraft
`position` Int	When specified, the value might be `0` and should be lower than the total of the assets list.

Example: json

{
  "action" : "addAsset",
  "asset" : {
    "sources" : [ {
      "uri" : "https://www.commercetools.de/ct-logo.svg",
      "key" : "vector"
    } ],
    "name" : {
      "de" : "commercetools Logo",
      "en" : "commercetools logo"
    }
  }
}

CategoryChangeAssetNameAction

`action` String	`"changeAssetName"`
`assetId` String
`assetKey` String
`name` LocalizedString

Example: json

{
  "action" : "changeAssetName",
  "assetId" : "{{assetId}}",
  "name" : {
    "de" : "Mein Asset",
    "en" : "My asset"
  }
}

CategoryChangeAssetOrderAction

`action` String	`"changeAssetOrder"`
`assetOrder` Array of String

Example: json

{
  "action" : "changeAssetOrder",
  "assetOrder" : [ "{{assetId1}}", "{{assetId2}}" ]
}

CategoryChangeNameAction

`action` String	`"changeName"`
`name` LocalizedString

Example: json

{
  "action" : "changeName",
  "name" : {
    "de" : "neuer Category Name",
    "en" : "new category name"
  }
}

CategoryChangeOrderHintAction

`action` String	`"changeOrderHint"`
`orderHint` String

Example: json

{
  "action" : "changeOrderHint",
  "orderHint" : "0.1"
}

CategoryChangeParentAction

`action` String	`"changeParent"`
`parent` CategoryResourceIdentifier

Example: json

{
  "action" : "changeParent",
  "parent" : {
    "typeId" : "category",
    "id" : "{{category-id}}"
  }
}

CategoryChangeSlugAction

`action` String	`"changeSlug"`
`slug` LocalizedString	Allowed are alphabetic, numeric, underscore (_) and hyphen (-) characters. Maximum size is {{ site.data.api-limits.slugLength }}.

Example: json

{
  "action" : "changeSlug",
  "slug" : {
    "de" : "meine-kategorie",
    "en" : "my-category"
  }
}

CategoryDraft

`key` String	User-defined unique identifier for the category. Keys can only contain alphanumeric characters (`a-Z, 0-9`), underscores and hyphens (`-, _`) and be between 2 and 256 characters.
`name` LocalizedString
`slug` LocalizedString	human-readable identifier usually used as deep-link URL to the related category. Allowed are alphabetic, numeric, underscore (`_`) and hyphen (`-`) characters. Maximum size is 256. Must be unique across a project! The same category can have the same slug for different languages.
`description` LocalizedString
`parent` CategoryResourceIdentifier	A category that is the parent of this category in the category tree. The parent can be set by its ID or by its key.
`orderHint` String	An attribute as base for a custom category order in one level. A random value will be assigned by API if not set.
`externalId` String
`metaTitle` LocalizedString
`metaDescription` LocalizedString
`metaKeywords` LocalizedString
`assets` Array of AssetDraft
`custom` CustomFieldsDraft	The custom fields.

CategoryPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of Category

CategoryReference

`id` String
`typeId` String	`"category"`
`obj` Category

CategoryRemoveAssetAction

`action` String	`"removeAsset"`
`assetId` String
`assetKey` String

Example: json

{
  "action" : "removeAsset",
  "assetId" : "{{assetId}}"
}

CategoryResourceIdentifier

`id` String
`key` String
`typeId` String	`"category"`

CategorySetAssetCustomFieldAction

`action` String	`"setAssetCustomField"`
`assetId` String
`assetKey` String
`name` String
`value` Any

Example: json

{
  "action" : "setAssetCustomField",
  "assetId" : "{{assetId}}",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CategorySetAssetCustomTypeAction

`action` String	`"setAssetCustomType"`
`assetId` String
`assetKey` String
`type` TypeResourceIdentifier	If set, the custom type is set to this new value. If absent, the custom type and any existing custom fields are removed.
`fields` Object	If set, the custom fields are set to this new value.

Example: json

{
  "action" : "setAssetCustomType",
  "assetId" : "{{assetId}}",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CategorySetAssetDescriptionAction

`action` String	`"setAssetDescription"`
`assetId` String
`assetKey` String
`description` LocalizedString

Example: json

{
  "action" : "setAssetDescription",
  "assetId" : "{{assetId}}",
  "description" : {
    "de" : "Dies ist eine Asset-Beschreibung",
    "en" : "This is an asset description"
  }
}

CategorySetAssetKeyAction

`action` String	`"setAssetKey"`
`assetId` String
`assetKey` String	User-defined identifier for the asset. If left blank or set to `null`, the asset key is unset/removed.

Example: json

{
  "action" : "setAssetKey",
  "assetId" : "{{assetId}}"
}

CategorySetAssetSourcesAction

`action` String	`"setAssetSources"`
`assetId` String
`assetKey` String
`sources` Array of AssetSource

Example: json

{
  "action" : "setAssetSources",
  "assetId" : "{{assetId}}",
  "sources" : [ {
    "uri" : "https://www.commercetools.de/ct-logo.svg",
    "key" : "vector"
  } ]
}

CategorySetAssetTagsAction

`action` String	`"setAssetTags"`
`assetId` String
`assetKey` String
`tags` Array of String

Example: json

{
  "action" : "setAssetTags",
  "assetId" : "{{assetId}}"
}

CategorySetCustomFieldAction

`action` String	`"setCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CategorySetCustomTypeAction

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	If absent, the custom type and any existing CustomFields are removed.
`fields` FieldContainer	A valid JSON object, based on the FieldDefinitions of the Type. Sets the custom fields to this value.

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CategorySetDescriptionAction

`action` String	`"setDescription"`
`description` LocalizedString

Example: json

{
  "action" : "setDescription",
  "description" : {
    "de" : "This is a category description",
    "en" : "Dies ist eine Kategorie-Beschreibung"
  }
}

CategorySetExternalIdAction

`action` String	`"setExternalId"`
`externalId` String	If not defined, the external ID is unset.

Example: json

{
  "action" : "setExternalId",
  "externalId" : "externalIdString"
}

CategorySetKeyAction

`key` String	User-defined unique identifier for the category. Keys can only contain alphanumeric characters (`a-Z, 0-9`), underscores and hyphens (`-, _`) and be between 2 and 256 characters. If `key` is absent or `null`, this field will be removed if it exists.
`action` String	`"setKey"`

Example: json

{
  "action" : "setKey",
  "key" : "myNewKey"
}

CategorySetMetaDescriptionAction

`action` String	`"setMetaDescription"`
`metaDescription` LocalizedString

Example: json

{
  "action" : "setMetaDescription",
  "metaDescription" : {
    "de" : "Dies ist meine MetaDecription",
    "en" : "this is my meta description"
  }
}

CategorySetMetaKeywordsAction

`action` String	`"setMetaKeywords"`
`metaKeywords` LocalizedString

Example: json

{
  "action" : "setMetaKeywords",
  "metaKeywords" : {
    "de" : "commercetools, genial",
    "en" : "commercetools, aweseome"
  }
}

CategorySetMetaTitleAction

`action` String	`"setMetaTitle"`
`metaTitle` LocalizedString

Example: json

{
  "action" : "setMetaTitle",
  "metaTitle" : {
    "de" : "Dies ist mein Meta-Title",
    "en" : "This is my meta title"
  }
}

CategoryUpdate

`version` Int
`actions` Array of CategoryUpdateAction

CategoryUpdateAction

action

String

ChannelAddRolesAction

`action` String	`"addRoles"`
`roles` Array of ChannelRoleEnum

Example: json

{
  "action" : "addRoles",
  "roles" : [ "InventorySupply" ]
}

ChannelChangeDescriptionAction

`action` String	`"changeDescription"`
`description` LocalizedString

Example: json

{
  "action" : "changeDescription",
  "description" : {
    "en" : "new Description EN",
    "de" : "new Description DE"
  }
}

ChannelChangeKeyAction

`key` String
`action` String	`"changeKey"`

Example: json

{
  "action" : "changeKey",
  "key" : "myNewChannelKey"
}

ChannelChangeNameAction

`action` String	`"changeName"`
`name` LocalizedString

Example: json

{
  "action" : "changeName",
  "name" : {
    "en" : "new Channel Name EN",
    "de" : "new Channel Name DE"
  }
}

ChannelDraft

`key` String
`roles` Array of ChannelRoleEnum	If not specified, then channel will get InventorySupply role by default
`name` LocalizedString
`description` LocalizedString
`address` BaseAddress
`geoLocation` GeoJson
`custom` CustomFieldsDraft	The custom fields.

ChannelPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of Channel

ChannelReference

`id` String
`typeId` String	`"channel"`
`obj` Channel

ChannelRemoveRolesAction

`action` String	`"removeRoles"`
`roles` Array of ChannelRoleEnum

Example: json

{
  "action" : "removeRoles",
  "roles" : [ "InventorySupply" ]
}

ChannelResourceIdentifier

`id` String
`key` String
`typeId` String	`"channel"`

ChannelRoleEnum

InventorySupply
ProductDistribution
OrderExport
OrderImport
Primary

ChannelSetAddressAction

`action` String	`"setAddress"`
`address` BaseAddress

Example: json

{
  "action" : "setAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

ChannelSetAddressCustomFieldAction

`action` String	`"setAddressCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setAddressCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

ChannelSetAddressCustomTypeAction

`action` String	`"setAddressCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setAddressCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

ChannelSetCustomFieldAction

`action` String	`"setCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

ChannelSetCustomTypeAction

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

ChannelSetGeoLocationAction

`action` String	`"setGeoLocation"`
`geoLocation` GeoJson

Example: json

{
  "action" : "setGeoLocation",
  "geoLocation" : {
    "type" : "Point",
    "coordinates" : [ 48.163569, 11.558663 ]
  }
}

ChannelSetRolesAction

`action` String	`"setRoles"`
`roles` Array of ChannelRoleEnum

Example: json

{
  "action" : "setRoles",
  "roles" : [ "ProductDistribution", "Primary" ]
}

ChannelUpdate

`version` Int
`actions` Array of ChannelUpdateAction

ChannelUpdateAction

action

String

Address

`id` String
`key` String
`title` String
`salutation` String
`firstName` String
`lastName` String
`streetName` String
`streetNumber` String
`additionalStreetInfo` String
`postalCode` String
`city` String
`region` String
`state` String
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`company` String
`department` String
`building` String
`apartment` String
`pOBox` String
`phone` String
`mobile` String
`email` String
`fax` String
`additionalAddressInfo` String
`externalId` String
`custom` CustomFields

AddressDraft

`id` String
`key` String
`title` String
`salutation` String
`firstName` String
`lastName` String
`streetName` String
`streetNumber` String
`additionalStreetInfo` String
`postalCode` String
`city` String
`region` String
`state` String
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`company` String
`department` String
`building` String
`apartment` String
`pOBox` String
`phone` String
`mobile` String
`email` String
`fax` String
`additionalAddressInfo` String
`externalId` String
`custom` CustomFieldsDraft

Asset

`id` String
`key` String
`sources` Array of AssetSource
`name` LocalizedString
`description` LocalizedString
`tags` Array of String
`custom` CustomFields

AssetDimensions

`w` Int
`h` Int

AssetDraft

`key` String
`sources` Array of AssetSource
`name` LocalizedString
`description` LocalizedString
`tags` Array of String
`custom` CustomFieldsDraft

AssetSource

`key` String
`uri` String
`dimensions` AssetDimensions
`contentType` String

BaseAddress

`id` String
`key` String
`title` String
`salutation` String
`firstName` String
`lastName` String
`streetName` String
`streetNumber` String
`additionalStreetInfo` String
`postalCode` String
`city` String
`region` String
`state` String
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`company` String
`department` String
`building` String
`apartment` String
`pOBox` String
`phone` String
`mobile` String
`email` String
`fax` String
`additionalAddressInfo` String
`externalId` String

BaseResource

`id` String
`version` Int
`createdAt` DateTime
`lastModifiedAt` DateTime

CentPrecisionMoney

`type` String	`"centPrecision"`
`fractionDigits` Int	Maximum: `12`
`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.

CentPrecisionMoneyDraft

`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.
`type` String	`"centPrecision"`
`fractionDigits` Int	Maximum: `12`

ClientLogging

`clientId` String
`externalUserId` String
`customer` CustomerReference
`anonymousId` String

CreatedBy

`clientId` String
`externalUserId` String
`customer` CustomerReference
`anonymousId` String

DiscountedPrice

`value` Money
`discount` ProductDiscountReference

GeoJson

type

String

GeoJsonPoint

`type` String	`"Point"`
`coordinates` Array of Number

HighPrecisionMoney

`type` String	`"highPrecision"`
`fractionDigits` Int	Maximum: `12`
`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.
`preciseAmount` Int

HighPrecisionMoneyDraft

`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.
`type` String	`"highPrecision"`
`fractionDigits` Int	Maximum: `12`
`preciseAmount` Int

Image

`url` String
`dimensions` ImageDimensions
`label` String

ImageDimensions

`w` Int
`h` Int

KeyReference

`key` String
`typeId` ReferenceTypeId

LastModifiedBy

`clientId` String
`externalUserId` String
`customer` CustomerReference
`anonymousId` String

LocalizedString

/^[a-z]{2}-[A-Z]{2}?$/

Any string property matching this regular expression

Money

`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.

MoneyType

centPrecision
highPrecision

PagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of BaseResource
`meta` Object

Price

`id` String
`value` TypedMoney
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`customerGroup` CustomerGroupReference
`channel` ChannelReference
`validFrom` DateTime
`validUntil` DateTime
`discounted` DiscountedPrice
`tiers` Array of PriceTier
`custom` CustomFields

PriceDraft

`value` Money
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`customerGroup` CustomerGroupResourceIdentifier
`channel` ChannelResourceIdentifier
`validFrom` DateTime
`validUntil` DateTime
`tiers` Array of PriceTierDraft
`discounted` DiscountedPrice
`custom` CustomFieldsDraft

PriceTier

`minimumQuantity` Int
`value` TypedMoney

PriceTierDraft

`minimumQuantity` Int
`value` Money

QueryPrice

`id` String
`value` Money
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`customerGroup` CustomerGroupReference
`channel` ChannelReference
`validFrom` DateTime
`validUntil` DateTime
`discounted` DiscountedPrice
`tiers` Array of PriceTierDraft
`custom` CustomFields

Reference

`id` String
`typeId` ReferenceTypeId

ReferenceTypeId

cart
cart-discount
category
channel
customer
customer-email-token
customer-group
customer-password-token
discount-code
extension
inventory-entry
key-value-document
order
order-edit
payment
product
product-discount
product-type
review
shipping-method
shopping-list
state
store
subscription
tax-category
type
zone

ResourceIdentifier

`id` String
`key` String
`typeId` ReferenceTypeId

ScopedPrice

`id` String
`value` TypedMoney
`currentValue` TypedMoney
`country` CountryCode	A two-digit country code as per ISO 3166-1 alpha-2.
`customerGroup` CustomerGroupReference
`channel` ChannelReference
`validFrom` DateTime
`validUntil` DateTime
`discounted` DiscountedPrice
`custom` CustomFields

TypedMoney

`type` MoneyType
`fractionDigits` Int	Maximum: `12`
`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.

TypedMoneyDraft

`centAmount` Int
`currencyCode` CurrencyCode	The currency code compliant to ISO 4217.
`type` MoneyType
`fractionDigits` Int	Maximum: `12`

Update

`version` Int
`actions` Array of UpdateAction

UpdateAction

action

String

AnonymousCartSignInMode

MergeWithExistingCustomerCart
UseAsNewActiveCustomerCart

CustomerAddAddressAction

`action` String	`"addAddress"`
`address` BaseAddress

Example: json

{
  "action" : "addAddress",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

CustomerAddBillingAddressIdAction

`action` String	`"addBillingAddressId"`
`addressId` String
`addressKey` String

Example: json

{
  "action" : "addBillingAddressId",
  "addressId" : "{{addressId}}"
}

CustomerAddShippingAddressIdAction

`action` String	`"addShippingAddressId"`
`addressId` String
`addressKey` String

Example: json

{
  "action" : "addShippingAddressId",
  "addressId" : "{{addressId}}"
}

CustomerAddStoreAction

`action` String	`"addStore"`
`store` StoreResourceIdentifier

Example: json

{
  "action" : "addStore",
  "store" : {
    "key" : "{{store-key}}",
    "typeId" : "store"
  }
}

CustomerChangeAddressAction

`action` String	`"changeAddress"`
`addressId` String
`addressKey` String
`address` BaseAddress

Example: json

{
  "action" : "changeAddress",
  "addressId" : "{{addressId}}",
  "address" : {
    "id" : "exampleAddress",
    "key" : "exampleKey",
    "title" : "My Address",
    "salutation" : "Mr.",
    "firstName" : "Example",
    "lastName" : "Person",
    "streetName" : "Examplary Street",
    "streetNumber" : "4711",
    "additionalStreetInfo" : "Backhouse",
    "postalCode" : "80933",
    "city" : "Exemplary City",
    "region" : "Exemplary Region",
    "state" : "Exemplary State",
    "country" : "DE",
    "company" : "My Company Name",
    "department" : "Sales",
    "building" : "Hightower 1",
    "apartment" : "247",
    "pOBox" : "2471",
    "phone" : "+49 89 12345678",
    "mobile" : "+49 171 2345678",
    "email" : "mail@mail.com",
    "fax" : "+49 89 12345679",
    "additionalAddressInfo" : "no additional Info",
    "externalId" : "Information not needed"
  }
}

CustomerChangeEmailAction

`action` String	`"changeEmail"`
`email` String

Example: json

{
  "action" : "changeEmail",
  "email" : "mail@mail.com"
}

CustomerChangePassword

`id` String
`version` Int
`currentPassword` String
`newPassword` String

CustomerCreateEmailToken

`id` String
`version` Int
`ttlMinutes` Int

CustomerCreatePasswordResetToken

`email` String
`ttlMinutes` Int

CustomerDraft

`key` String	User-specific unique identifier for a customer. Must be unique across a project. The field can be reset using the Set Key UpdateAction
`customerNumber` String	String that uniquely identifies a customer. It can be used to create more human-readable (in contrast to ID) identifier for the customer. It should be unique across a project. Once it's set it cannot be changed.
`email` String	The customer's email address and the main identifier of uniqueness for a customer account. Email addresses are either unique to the store they're specified for, or for the entire project, and are case insensitive. For more information, see Email uniquenes.
`password` String
`firstName` String
`lastName` String
`middleName` String
`title` String
`anonymousCart` CartResourceIdentifier	Identifies a single cart that will be assigned to the new customer account.
`anonymousId` String	Identifies carts and orders belonging to an anonymous session that will be assigned to the new customer account.
`dateOfBirth` Date
`companyName` String
`vatId` String
`addresses` Array of BaseAddress	Sets the ID of each address to be unique in the addresses list.
`defaultShippingAddress` Int	The index of the address in the addresses array. The `defaultShippingAddressId` of the customer will be set to the ID of that address.
`shippingAddresses` Array of Integer	The indices of the shipping addresses in the addresses array. The `shippingAddressIds` of the Customer will be set to the IDs of that addresses.
`defaultBillingAddress` Int	The index of the address in the addresses array. The `defaultBillingAddressId` of the customer will be set to the ID of that address.
`billingAddresses` Array of Integer	The indices of the billing addresses in the addresses array. The `billingAddressIds` of the customer will be set to the IDs of that addresses.
`isEmailVerified` Boolean
`externalId` String
`customerGroup` CustomerGroupResourceIdentifier
`locale` String	Must be one of the languages supported for this project
`salutation` String
`stores` Array of StoreResourceIdentifier	References to the stores the customer account is associated with. If no stores are specified, the customer is a global customer, and can log in using the Password Flow for global Customers. If one or more stores are specified, the customer can only log in using the Password Flow for Customers in a Store for those specific stores.
`custom` CustomFieldsDraft	The custom fields.

CustomerEmailVerify

`version` Int
`tokenValue` String

CustomerPagedQueryResponse

`limit` Int
`count` Int
`total` Int
`offset` Int
`results` Array of Customer

CustomerReference

`id` String
`typeId` String	`"customer"`
`obj` Customer

CustomerRemoveAddressAction

`action` String	`"removeAddress"`
`addressId` String
`addressKey` String

Example: json

{
  "action" : "removeAddress",
  "addressId" : "{{addressId}}"
}

CustomerRemoveBillingAddressIdAction

`action` String	`"removeBillingAddressId"`
`addressId` String
`addressKey` String

Example: json

{
  "action" : "removeBillingAddressId",
  "addressId" : "{{addressId}}"
}

CustomerRemoveShippingAddressIdAction

`action` String	`"removeShippingAddressId"`
`addressId` String
`addressKey` String

Example: json

{
  "action" : "removeShippingAddressId",
  "addressId" : "{{addressId}}"
}

CustomerRemoveStoreAction

`action` String	`"removeStore"`
`store` StoreResourceIdentifier

Example: json

{
  "action" : "removeStore",
  "store" : {
    "key" : "{{store-key}}",
    "typeId" : "store"
  }
}

CustomerResetPassword

`version` Int
`tokenValue` String
`newPassword` String

CustomerResourceIdentifier

`id` String
`key` String
`typeId` String	`"customer"`

CustomerSetAddressCustomFieldAction

`action` String	`"setAddressCustomField"`
`addressId` String
`name` String
`value` Any

Example: json

{
  "action" : "setAddressCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString",
  "addressId" : "{{address-id}}"
}

CustomerSetAddressCustomTypeAction

`action` String	`"setAddressCustomType"`
`type` TypeResourceIdentifier
`fields` FieldContainer
`addressId` String

Example: json

{
  "action" : "setAddressCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  },
  "addressId" : "{{address-id}}"
}

CustomerSetCompanyNameAction

`action` String	`"setCompanyName"`
`companyName` String	If not defined, the company name is unset.

Example: json

{
  "action" : "setCompanyName",
  "companyName" : "Company Ltd."
}

CustomerSetCustomerGroupAction

`action` String	`"setCustomerGroup"`
`customerGroup` CustomerGroupResourceIdentifier	If not defined, the customer group is unset.

Example: json

{
  "action" : "setCustomerGroup",
  "customerGroup" : {
    "id" : "{{customer-group-id}}",
    "typeId" : "customer-group"
  }
}

CustomerSetCustomerNumberAction

`action` String	`"setCustomerNumber"`
`customerNumber` String	It should be unique across a project. Once it's set, it cannot be changed.

Example: json

{
  "action" : "setCustomerNumber",
  "customerNumber" : "123"
}

CustomerSetCustomFieldAction

`action` String	`"setCustomField"`
`name` String
`value` Any

Example: json

{
  "action" : "setCustomField",
  "name" : "ExamplaryStringTypeField",
  "value" : "TextString"
}

CustomerSetCustomTypeAction

`action` String	`"setCustomType"`
`type` TypeResourceIdentifier	If absent, the custom type and any existing custom fields are removed.
`fields` FieldContainer	A valid JSON object, based on the FieldDefinitions of the Type. Sets the custom fields to this value.

Example: json

{
  "action" : "setCustomType",
  "type" : {
    "id" : "{{type-id}}",
    "typeId" : "type"
  },
  "fields" : {
    "examplaryStringTypeField" : "TextString"
  }
}

CustomerSetDateOfBirthAction

`action` String	`"setDateOfBirth"`
`dateOfBirth` Date	If not defined, the date of birth is unset.

Example: json

{
  "action" : "setDateOfBirth",
  "dateOfBirth" : "2015-10-21"
}

CustomerSetDefaultBillingAddressAction

`action` String	`"setDefaultBillingAddress"`
`addressId` String	If not defined, the customer's `defaultBillingAddress` is unset.
`addressKey` String

Example: json

{
  "action" : "setDefaultBillingAddress",
  "addressId" : "{{addressId}}"
}

CustomerSetDefaultShippingAddressAction

`action` String	`"setDefaultShippingAddress"`
`addressId` String	If not defined, the customer's `defaultShippingAddress` is unset.
`addressKey` String

Example: json

{
  "action" : "setDefaultShippingAddress",
  "addressId" : "{{addressId}}"
}

CustomerSetExternalIdAction

`action` String	`"setExternalId"`
`externalId` String	If not defined, the external ID is unset.

Example: json

{
  "action" : "setExternalId",
  "externalId" : "123"
}

CustomerSetFirstNameAction

`action` String	`"setFirstName"`
`firstName` String

Example: json

{
  "action" : "setFirstName",
  "fistName" : "Example"
}

CustomerSetKeyAction

`key` String	If `key` is absent or `null`, this field will be removed if it exists.
`action` String	`"setKey"`

Example: json

{
  "action" : "setKey",
  "key" : "newKey"
}

CustomerSetLastNameAction

`action` String	`"setLastName"`
`lastName` String

Example: json

{
  "action" : "setLastName",
  "lastName" : "Person"
}

CustomerSetLocaleAction

`action` String	`"setLocale"`
`locale` String

Example: json

{
  "action" : "setLocale",
  "locale" : "de-DE"
}

CustomerSetMiddleNameAction

`action` String	`"setMiddleName"`
`middleName` String

Example: json

{
  "action" : "setMiddleName",
  "middleName" : "middleName"
}

CustomerSetSalutationAction

`action` String	`"setSalutation"`
`salutation` String

Example: json

{
  "action" : "setSalutation",
  "salutation" : "Mr"
}

CustomerSetStoresAction

`action` String	`"setStores"`
`stores` Array of StoreResourceIdentifier

Example: json

{
  "action" : "setStores",
  "stores" : [ {
    "key" : "{{store-key}}",
    "typeId" : "store"
  } ]
}

CustomerSetTitleAction

`action` String	`"setTitle"`
`title` String

Example: json

{
  "action" : "setTitle",
  "title" : "Dr"
}

CustomerSetVatIdAction

`action` String	`"setVatId"`
`vatId` String	If not defined, the vat Id is unset.

Example: json

{
  "action" : "setVatId",
  "vatId" : "vatId"
}

CustomerSignin

`email` String
`password` String
`anonymousCartId` String
`anonymousCart` CartResourceIdentifier
`anonymousCartSignInMode` AnonymousCartSignInMode
`anonymousId` String
`updateProductData` Boolean

CustomerSignInResult

`customer` Customer
`cart` Cart	A cart that is associated to the customer. Empty if the customer does not have a cart yet.

CustomerToken

`id` String
`createdAt` DateTime
`lastModifiedAt` DateTime
`customerId` String
`expiresAt` DateTime
`value` String