Module commercetools.cartsordershoppinglists

ballerinax/commercetools.cartsordershoppinglists Ballerina library

1.4.2

Overview

The Commercetools API v1 connector(https://docs.commercetools.com/api/) OpenAPI specification.

The commercetools Platform HTTP API(Carts, Order and Shopping List) offers an interface for programmatic access to retrieve certain information on carts, orders and shopping list.

Key Features

Programmatic access to create and manage resources via REST API
Secure authentication with API key or OAuth support
Seamless integration with REST API endpoints

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create and configure an OAuth2 client credentials by following this guide.

Clients

commercetools.cartsordershoppinglists: Client

Isolated

This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform HTTP API offers an interface for programmatic access to operations related to carts, orders and shopping lists.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create and configure an OAuth2 client credentials by following this guide.

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string - URL of the target service

getShoppingListByID

Isolated FunctionRemote Function

function getShoppingListByID(string projectKey, string id, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by ID.

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateShoppingListByID

Isolated FunctionRemote Function

function updateShoppingListByID(string projectKey, string id, ShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

id string -

payload ShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteShoppingListByID

Isolated FunctionRemote Function

function deleteShoppingListByID(string projectKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getShoppingListByKey

Isolated FunctionRemote Function

function getShoppingListByKey(string projectKey, string 'key, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by Key.

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateShoppingListByKey

Isolated FunctionRemote Function

function updateShoppingListByKey(string projectKey, string 'key, ShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Update a shopping list found by its Key.

Parameters

projectKey string -

'key string -

payload ShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteShoppingListByKey

Isolated FunctionRemote Function

function deleteShoppingListByKey(string projectKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getShoppingListInStoreByID

Isolated FunctionRemote Function

function getShoppingListInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by ID.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateShoppingListInStoreByID

Isolated FunctionRemote Function

function updateShoppingListInStoreByID(string projectKey, string storeKey, string id, ShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

id string -

payload ShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteShoppingListInStoreByID

Isolated FunctionRemote Function

function deleteShoppingListInStoreByID(string projectKey, string storeKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getShoppingListInStoreByKey

Isolated FunctionRemote Function

function getShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by Key.

Parameters

projectKey string -

storeKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateShoppingListInStoreByKey

Isolated FunctionRemote Function

function updateShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, ShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Update a shopping list found by its Key.

Parameters

projectKey string -

storeKey string -

'key string -

payload ShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteShoppingListInStoreByKey

Isolated FunctionRemote Function

function deleteShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

queryShoppingListInStore

Isolated FunctionRemote Function

function queryShoppingListInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ShoppingListPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ShoppingListPagedQueryResponse|error - 200

createShoppingListInStore

Isolated FunctionRemote Function

function createShoppingListInStore(string projectKey, string storeKey, ShoppingListDraft payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

payload ShoppingListDraft -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 201

getMyShoppingListByID

Isolated FunctionRemote Function

function getMyShoppingListByID(string projectKey, string id, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateMyShoppingListByID

Isolated FunctionRemote Function

function updateMyShoppingListByID(string projectKey, string id, MyShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

id string -

payload MyShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteMyShoppingListByID

Isolated FunctionRemote Function

function deleteMyShoppingListByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getMyShoppingListInStoreByID

Isolated FunctionRemote Function

function getMyShoppingListInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by ID.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateMyShoppingListInStoreByID

Isolated FunctionRemote Function

function updateMyShoppingListInStoreByID(string projectKey, string storeKey, string id, MyShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

id string -

payload MyShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteMyShoppingListInStoreByID

Isolated FunctionRemote Function

function deleteMyShoppingListInStoreByID(string projectKey, string storeKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getMyShoppingListByKey

Isolated FunctionRemote Function

function getMyShoppingListByKey(string projectKey, string 'key, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateMyShoppingListByKey

Isolated FunctionRemote Function

function updateMyShoppingListByKey(string projectKey, string 'key, MyShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

'key string -

payload MyShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteMyShoppingListByKey

Isolated FunctionRemote Function

function deleteMyShoppingListByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

getMyShoppingListInStoreByKey

Isolated FunctionRemote Function

function getMyShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, Expansion[]? expand) returns ShoppingList|error

Gets a shopping list by Key.

Parameters

projectKey string -

storeKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

updateMyShoppingListInStoreByKey

Isolated FunctionRemote Function

function updateMyShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, MyShoppingListUpdate payload, Expansion[]? expand) returns ShoppingList|error

Update a shopping list found by its Key.

Parameters

projectKey string -

storeKey string -

'key string -

payload MyShoppingListUpdate -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

deleteMyShoppingListInStoreByKey

Isolated FunctionRemote Function

function deleteMyShoppingListInStoreByKey(string projectKey, string storeKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 200

queryShoppingListsInStore

Isolated FunctionRemote Function

function queryShoppingListsInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ShoppingListPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ShoppingListPagedQueryResponse|error - 200

createShoppingListsInStore

Isolated FunctionRemote Function

function createShoppingListsInStore(string projectKey, string storeKey, MyShoppingListDraft payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

storeKey string -

payload MyShoppingListDraft -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 201

queryShoppingLists

Isolated FunctionRemote Function

function queryShoppingLists(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ShoppingListPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ShoppingListPagedQueryResponse|error - 200

createShoppingLists

Isolated FunctionRemote Function

function createShoppingLists(string projectKey, MyShoppingListDraft payload, Expansion[]? expand) returns ShoppingList|error

Parameters

projectKey string -

payload MyShoppingListDraft -

expand Expansion[]? (default ()) -

Return Type

ShoppingList|error - 201

getCartByID

Isolated FunctionRemote Function

function getCartByID(string projectKey, string id, Expansion[]? expand) returns Cart|error

The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateCartByID

Isolated FunctionRemote Function

function updateCartByID(string projectKey, string id, CartUpdate payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

id string -

payload CartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteCartByID

Isolated FunctionRemote Function

function deleteCartByID(string projectKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getCartByKey

Isolated FunctionRemote Function

function getCartByKey(string projectKey, string 'key, Expansion[]? expand) returns Cart|error

The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateCartByKey

Isolated FunctionRemote Function

function updateCartByKey(string projectKey, string 'key, CartUpdate payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

'key string -

payload CartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteCartByKey

Isolated FunctionRemote Function

function deleteCartByKey(string projectKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getCartInStoreByID

Isolated FunctionRemote Function

function getCartInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns Cart|error

Returns a cart by its ID from a specific Store. If the cart exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error. The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateCartInStoreByID

Isolated FunctionRemote Function

function updateCartInStoreByID(string projectKey, string storeKey, string id, CartUpdate payload, Expansion[]? expand) returns Cart|error

Updates a cart in the store specified by {storeKey}. If the cart exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

id string -

payload CartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteCartInStoreByID

Isolated FunctionRemote Function

function deleteCartInStoreByID(string projectKey, string storeKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getCartInStoreByKey

Isolated FunctionRemote Function

function getCartInStoreByKey(string projectKey, string storeKey, string 'key, Expansion[]? expand) returns Cart|error

Returns a cart by its key from a specific Store. If the cart exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error. The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

storeKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateCartInStoreByKey

Isolated FunctionRemote Function

function updateCartInStoreByKey(string projectKey, string storeKey, string 'key, CartUpdate payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

'key string -

payload CartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteCartInStoreByKey

Isolated FunctionRemote Function

function deleteCartInStoreByKey(string projectKey, string storeKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getCartByCustomerID

Isolated FunctionRemote Function

function getCartByCustomerID(string projectKey, string customerId, Expansion[]? expand) returns Cart|error

Retrieves the active cart of the customer that has been modified most recently. It does not consider carts with CartOrigin Merchant. If no active cart exists, a 404 Not Found error is returned.

The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

customerId string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getCartInStoreByCustomerID

Isolated FunctionRemote Function

function getCartInStoreByCustomerID(string projectKey, string storeKey, string customerId, Expansion[]? expand) returns Cart|error

Retrieves the active cart of the customer that has been modified most recently in a specific Store.

If the cart exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error.

The cart may not contain up-to-date prices, discounts etc. If you want to ensure they're up-to-date, send an Update request with the Recalculate update action instead.

Parameters

projectKey string -

storeKey string -

customerId string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

queryCarts

Isolated FunctionRemote Function

function queryCarts(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CartPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CartPagedQueryResponse|error - 200

createCart

Isolated FunctionRemote Function

function createCart(string projectKey, CartDraft payload, Expansion[]? expand) returns Cart|error

Creating a cart can fail with an InvalidOperation if the referenced shipping method in the CartDraft has a predicate which does not match the cart.

Parameters

projectKey string -

payload CartDraft -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 201

queryCartsInStore

Isolated FunctionRemote Function

function queryCartsInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CartPagedQueryResponse|error

Queries carts in a specific Store.

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CartPagedQueryResponse|error - 200

createCartInStore

Isolated FunctionRemote Function

function createCartInStore(string projectKey, string storeKey, CartDraft payload, Expansion[]? expand) returns Cart|error

Creates a cart in the store specified by {storeKey}. When using this endpoint the cart's store field is always set to the store specified in the path parameter. Creating a cart can fail with an InvalidOperation if the referenced shipping method in the CartDraft has a predicate which does not match the cart.

Parameters

projectKey string -

storeKey string -

payload CartDraft -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 201

replicateCart

Isolated FunctionRemote Function

function replicateCart(string projectKey, ReplicaCartDraft payload) returns Cart|error

Parameters

projectKey string -

payload ReplicaCartDraft -

Return Type

Cart|error - 201

replicateCartInStore

Isolated FunctionRemote Function

function replicateCartInStore(string projectKey, string storeKey, ReplicaCartDraft payload) returns Cart|error

Parameters

projectKey string -

storeKey string -

payload ReplicaCartDraft -

Return Type

Cart|error - 201

getMyCartByID

Isolated FunctionRemote Function

function getMyCartByID(string projectKey, string id, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateMyCartByID

Isolated FunctionRemote Function

function updateMyCartByID(string projectKey, string id, MyCartUpdate payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

id string -

payload MyCartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteMyCartByID

Isolated FunctionRemote Function

function deleteMyCartByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getMyCartInStoreByID

Isolated FunctionRemote Function

function getMyCartInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

updateMyCartInStoreByID

Isolated FunctionRemote Function

function updateMyCartInStoreByID(string projectKey, string storeKey, string id, MyCartUpdate payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

id string -

payload MyCartUpdate -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

deleteMyCartInStoreByID

Isolated FunctionRemote Function

function deleteMyCartInStoreByID(string projectKey, string storeKey, string id, decimal 'version, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 200

getMyActiveCart

Isolated FunctionRemote Function

function getMyActiveCart(string projectKey) returns Cart|error

Parameters

projectKey string -

Return Type

Cart|error - 200

getMyActiveCartInStoreByID

Isolated FunctionRemote Function

function getMyActiveCartInStoreByID(string projectKey, string storeKey) returns Cart|error

Parameters

projectKey string -

storeKey string -

Return Type

Cart|error - 200

queryMyCart

Isolated FunctionRemote Function

function queryMyCart(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CartPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CartPagedQueryResponse|error - 200

createMyCart

Isolated FunctionRemote Function

function createMyCart(string projectKey, MyCartDraft payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

payload MyCartDraft -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 201

queryMyCartInStore

Isolated FunctionRemote Function

function queryMyCartInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CartPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

CartPagedQueryResponse|error - 200

createMyCartInStore

Isolated FunctionRemote Function

function createMyCartInStore(string projectKey, string storeKey, MyCartDraft payload, Expansion[]? expand) returns Cart|error

Parameters

projectKey string -

storeKey string -

payload MyCartDraft -

expand Expansion[]? (default ()) -

Return Type

Cart|error - 201

getShippingMethodByID

Isolated FunctionRemote Function

function getShippingMethodByID(string projectKey, string id, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

updateShippingMethodByID

Isolated FunctionRemote Function

function updateShippingMethodByID(string projectKey, string id, ShippingMethodUpdate payload, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

id string -

payload ShippingMethodUpdate -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

deleteShippingMethodByID

Isolated FunctionRemote Function

function deleteShippingMethodByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

getShippingMethodByKey

Isolated FunctionRemote Function

function getShippingMethodByKey(string projectKey, string 'key, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

updateShippingMethodByKey

Isolated FunctionRemote Function

function updateShippingMethodByKey(string projectKey, string 'key, ShippingMethodUpdate payload, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

'key string -

payload ShippingMethodUpdate -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

deleteShippingMethodByKey

Isolated FunctionRemote Function

function deleteShippingMethodByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 200

queryShippingMethods

Isolated FunctionRemote Function

function queryShippingMethods(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ShippingMethodPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ShippingMethodPagedQueryResponse|error - 200

createShippingMethods

Isolated FunctionRemote Function

function createShippingMethods(string projectKey, ShippingMethodDraft payload, Expansion[]? expand) returns ShippingMethod|error

Parameters

projectKey string -

payload ShippingMethodDraft -

expand Expansion[]? (default ()) -

Return Type

ShippingMethod|error - 201

getShippingMethodsForCart

Isolated FunctionRemote Function

function getShippingMethodsForCart(string projectKey, string cartId, Expansion[]? expand) returns ShippingMethodPagedQueryResponse|error

Parameters

projectKey string -

cartId string -

expand Expansion[]? (default ()) -

Return Type

ShippingMethodPagedQueryResponse|error - 200

getShippingMethodsForCartInStoreByID

Isolated FunctionRemote Function

function getShippingMethodsForCartInStoreByID(string projectKey, string storeKey, string cartId, Expansion[]? expand) returns ShippingMethodPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

cartId string -

expand Expansion[]? (default ()) -

Return Type

ShippingMethodPagedQueryResponse|error - 200

getShippingMethodsForLocation

Isolated FunctionRemote Function

function getShippingMethodsForLocation(string projectKey, string country, string? state, string? currency, Expansion[]? expand) returns ShippingMethodPagedQueryResponse|error

Parameters

projectKey string -

country string -

state string? (default ()) -

currency string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ShippingMethodPagedQueryResponse|error - 200

getShippingMethodsForOrderEdit

Isolated FunctionRemote Function

function getShippingMethodsForOrderEdit(string projectKey, string orderEditId, string country, string? state) returns ShippingMethodPagedQueryResponse|error

Parameters

projectKey string -

orderEditId string -

country string -

state string? (default ()) -

Return Type

ShippingMethodPagedQueryResponse|error - 200

getZoneByID

Isolated FunctionRemote Function

function getZoneByID(string projectKey, string id, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

updateZoneByID

Isolated FunctionRemote Function

function updateZoneByID(string projectKey, string id, ZoneUpdate payload, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

id string -

payload ZoneUpdate -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

deleteZoneByID

Isolated FunctionRemote Function

function deleteZoneByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

getZoneByKey

Isolated FunctionRemote Function

function getZoneByKey(string projectKey, string 'key, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

updateZoneByKey

Isolated FunctionRemote Function

function updateZoneByKey(string projectKey, string 'key, ZoneUpdate payload, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

'key string -

payload ZoneUpdate -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

deleteZoneByKey

Isolated FunctionRemote Function

function deleteZoneByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 200

queryZones

Isolated FunctionRemote Function

function queryZones(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ZonePagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

ZonePagedQueryResponse|error - 200

createZones

Isolated FunctionRemote Function

function createZones(string projectKey, ZoneDraft payload, Expansion[]? expand) returns Zone|error

Parameters

projectKey string -

payload ZoneDraft -

expand Expansion[]? (default ()) -

Return Type

Zone|error - 201

getPaymentByID

Isolated FunctionRemote Function

function getPaymentByID(string projectKey, string id, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

updatePaymentByID

Isolated FunctionRemote Function

function updatePaymentByID(string projectKey, string id, PaymentUpdate payload, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

id string -

payload PaymentUpdate -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

deletePaymentByID

Isolated FunctionRemote Function

function deletePaymentByID(string projectKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

getPaymentByKey

Isolated FunctionRemote Function

function getPaymentByKey(string projectKey, string 'key, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

updatePaymentByKey

Isolated FunctionRemote Function

function updatePaymentByKey(string projectKey, string 'key, PaymentUpdate payload, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

'key string -

payload PaymentUpdate -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

deletePaymentByKey

Isolated FunctionRemote Function

function deletePaymentByKey(string projectKey, string 'key, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Payment|error

Parameters

projectKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 200

queryPayment

Isolated FunctionRemote Function

function queryPayment(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns PaymentPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

PaymentPagedQueryResponse|error - 200

createPayment

Isolated FunctionRemote Function

function createPayment(string projectKey, PaymentDraft payload, Expansion[]? expand) returns Payment|error

To create a payment object a payment draft object has to be given with the request.

Parameters

projectKey string -

payload PaymentDraft -

expand Expansion[]? (default ()) -

Return Type

Payment|error - 201

getMyPaymentByID

Isolated FunctionRemote Function

function getMyPaymentByID(string projectKey, string id, Expansion[]? expand) returns MyPayment|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

MyPayment|error - 200

updateMyPaymentByID

Isolated FunctionRemote Function

function updateMyPaymentByID(string projectKey, string id, MyPaymentUpdate payload, Expansion[]? expand) returns MyPayment|error

Parameters

projectKey string -

id string -

payload MyPaymentUpdate -

expand Expansion[]? (default ()) -

Return Type

MyPayment|error - 200

deleteMyPaymentByID

Isolated FunctionRemote Function

function deleteMyPaymentByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns MyPayment|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

MyPayment|error - 200

queryMyPayment

Isolated FunctionRemote Function

function queryMyPayment(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns MyPaymentPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

MyPaymentPagedQueryResponse|error - 200

createMyPayment

Isolated FunctionRemote Function

function createMyPayment(string projectKey, MyPaymentDraft payload, Expansion[]? expand) returns MyPayment|error

Parameters

projectKey string -

payload MyPaymentDraft -

expand Expansion[]? (default ()) -

Return Type

MyPayment|error - 201

getOrderByID

Isolated FunctionRemote Function

function getOrderByID(string projectKey, string id, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

updateOrderByID

Isolated FunctionRemote Function

function updateOrderByID(string projectKey, string id, OrderUpdate payload, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

id string -

payload OrderUpdate -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

deleteOrderByID

Isolated FunctionRemote Function

function deleteOrderByID(string projectKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

getOrderInStoreByID

Isolated FunctionRemote Function

function getOrderInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns Order|error

Returns an order by its ID from a specific Store. If the order exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

updateOrderInStoreByID

Isolated FunctionRemote Function

function updateOrderInStoreByID(string projectKey, string storeKey, string id, OrderUpdate payload, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

storeKey string -

id string -

payload OrderUpdate -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

deleteOrderInStoreByID

Isolated FunctionRemote Function

function deleteOrderInStoreByID(string projectKey, string storeKey, string id, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

storeKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

getOrderByOrderNumber

Isolated FunctionRemote Function

function getOrderByOrderNumber(string projectKey, string orderNumber, Expansion[]? expand) returns Order|error

In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, it should be provided in URL-encoded format.

Parameters

projectKey string -

orderNumber string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

updateOrderByOrderNumber

Isolated FunctionRemote Function

function updateOrderByOrderNumber(string projectKey, string orderNumber, OrderUpdate payload, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

orderNumber string -

payload OrderUpdate -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

deleteOrderByOrderNumber

Isolated FunctionRemote Function

function deleteOrderByOrderNumber(string projectKey, string orderNumber, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

orderNumber string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

queryOrder

Isolated FunctionRemote Function

function queryOrder(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns OrderPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

OrderPagedQueryResponse|error - 200

createOrderFromCart

Isolated FunctionRemote Function

function createOrderFromCart(string projectKey, OrderFromCartDraft payload, Expansion[]? expand) returns Order|error

Creates an order from a Cart. The cart must have a shipping address set before creating an order. When using the Platform TaxMode, the shipping address is used for tax calculation.

Parameters

projectKey string -

payload OrderFromCartDraft -

expand Expansion[]? (default ()) -

Return Type

Order|error - 201

queryOrdersInStore

Isolated FunctionRemote Function

function queryOrdersInStore(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns OrderPagedQueryResponse|error

Queries orders in a specific Store.

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

OrderPagedQueryResponse|error - 200

createOrdersInStore

Isolated FunctionRemote Function

function createOrdersInStore(string projectKey, string storeKey, OrderFromCartDraft payload, Expansion[]? expand) returns Order|error

Creates an order from a Cart from a specific Store. When using this endpoint the orders's store field is always set to the store specified in the path parameter. The cart must have a shipping address set before creating an order. When using the Platform TaxMode, the shipping address is used for tax calculation.

Parameters

projectKey string -

storeKey string -

payload OrderFromCartDraft -

expand Expansion[]? (default ()) -

Return Type

Order|error - 201

getOrderInStoreByOrderNumber

Isolated FunctionRemote Function

function getOrderInStoreByOrderNumber(string projectKey, string storeKey, string orderNumber, Expansion[]? expand) returns Order|error

Returns an order by its order number from a specific Store.

If the order exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error. In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, it should be provided in URL-encoded format.

Parameters

projectKey string -

storeKey string -

orderNumber string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

updateOrderInStoreByOrderNumber

Isolated FunctionRemote Function

function updateOrderInStoreByOrderNumber(string projectKey, string storeKey, string orderNumber, OrderUpdate payload, Expansion[]? expand) returns Order|error

Updates an order in the store specified by {storeKey}. If the order exists in the commercetools project but does not have the store field, or the store field references a different store, this method returns a ResourceNotFound error. In case the orderNumber does not match the regular expression [a-zA-Z0-9_-]+, it should be provided in URL-encoded format.

Parameters

projectKey string -

storeKey string -

orderNumber string -

payload OrderUpdate -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

deleteOrderInStoreByOrderNumber

Isolated FunctionRemote Function

function deleteOrderInStoreByOrderNumber(string projectKey, string storeKey, string orderNumber, decimal 'version, boolean? dataErasure, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

storeKey string -

orderNumber string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

getMyOrderByID

Isolated FunctionRemote Function

function getMyOrderByID(string projectKey, string id, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

getMyOrderInStoreByID

Isolated FunctionRemote Function

function getMyOrderInStoreByID(string projectKey, string storeKey, string id, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Order|error - 200

queryMyOrders

Isolated FunctionRemote Function

function queryMyOrders(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns OrderPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

OrderPagedQueryResponse|error - 200

createMyOrders

Isolated FunctionRemote Function

function createMyOrders(string projectKey, MyOrderFromCartDraft payload, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

payload MyOrderFromCartDraft -

expand Expansion[]? (default ()) -

Return Type

Order|error - 201

queryOrderInStoreFromCart

Isolated FunctionRemote Function

function queryOrderInStoreFromCart(string projectKey, string storeKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns OrderPagedQueryResponse|error

Parameters

projectKey string -

storeKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

OrderPagedQueryResponse|error - 200

createOrderInStoreFromCart

Isolated FunctionRemote Function

function createOrderInStoreFromCart(string projectKey, string storeKey, MyOrderFromCartDraft payload, Expansion[]? expand) returns Order|error

Parameters

projectKey string -

storeKey string -

payload MyOrderFromCartDraft -

expand Expansion[]? (default ()) -

Return Type

Order|error - 201

getOrderEditByID

Isolated FunctionRemote Function

function getOrderEditByID(string projectKey, string id, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

updateOrderEditByID

Isolated FunctionRemote Function

function updateOrderEditByID(string projectKey, string id, OrderEditUpdate payload, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

id string -

payload OrderEditUpdate -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

deleteOrderEditByID

Isolated FunctionRemote Function

function deleteOrderEditByID(string projectKey, string id, decimal 'version, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

getOrderEditByKey

Isolated FunctionRemote Function

function getOrderEditByKey(string projectKey, string 'key, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

updateOrderEditByKey

Isolated FunctionRemote Function

function updateOrderEditByKey(string projectKey, string 'key, OrderEditUpdate payload, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

'key string -

payload OrderEditUpdate -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

deleteOrderEditByKey

Isolated FunctionRemote Function

function deleteOrderEditByKey(string projectKey, string 'key, decimal 'version, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 200

queryOrderEdits

Isolated FunctionRemote Function

function queryOrderEdits(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns OrderEditPagedQueryResponse|error

Parameters

projectKey string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

'where QueryPredicate[]? (default ()) -

varAZaZ09 string[]? (default ()) -

Return Type

OrderEditPagedQueryResponse|error - 200

createOrderEdits

Isolated FunctionRemote Function

function createOrderEdits(string projectKey, OrderEditDraft payload, Expansion[]? expand) returns OrderEdit|error

Parameters

projectKey string -

payload OrderEditDraft -

expand Expansion[]? (default ()) -

Return Type

OrderEdit|error - 201

applyOrderEdit

Isolated FunctionRemote Function

function applyOrderEdit(string projectKey, string id, OrderEditApply payload) returns Response|error

Parameters

projectKey string -

id string -

payload OrderEditApply -

Return Type

Response|error -
Bad Request A 400 is the most commonly expected error response and indicates that a request failed due to providing bad input. Bad input can be a malformed request body, missing required parameters, wrongly typed or malformed parameters or a parameter that references another resource that does not exist. Clients need to resolve the problems mentioned in the response before re-sending the request. The following general error codes can appear in responses with the HTTP status code 400: * InvalidInput Invalid input has been sent to the service. The client application should validate the input according to the constraints described in the error message before sending the request. * InvalidOperation The resource(s) involved in the request are not in a valid state for the operation. The client application should validate the constraints described in the error message before sending the request. * InvalidField A field has an invalid value. Extra fields: * field - String The name of the field. * invalidValue - * The invalid value. * allowedValues - Array of * - Optional A fixed set of allowed values for the field, if any. * RequiredField A required field is missing a value. Extra fields: * field - String The name of the field. * DuplicateField A value for a field conflicts with an existing duplicate value. Extra fields: * field - String The name of the field. * duplicateValue - * The offending duplicate value.

createOrderByImport

Isolated FunctionRemote Function

function createOrderByImport(string projectKey, OrderImportDraft payload) returns Order|error

Create an Order by Import

Parameters

projectKey string -

payload OrderImportDraft -

Return Type

Order|error - 201

searchOrders

Isolated FunctionRemote Function

function searchOrders(string projectKey, OrderSearchRequest payload) returns OrderPagedSearchResponse|error

Parameters

projectKey string -

payload OrderSearchRequest -

Return Type

OrderPagedSearchResponse|error - 200

checkSearchIndex

Isolated FunctionRemote Function

function checkSearchIndex(string projectKey) returns Response|error

Checks whether a search index for the Project's Orders exists.

Parameters

projectKey string -

Return Type

Response|error - The index exists and the Search Orders endpoint can be used.

Records

commercetools.cartsordershoppinglists: AccessDeniedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: Address

Fields

Fields Included from *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
company string
department string
building string
apartment string
pOBox string
phone string
mobile string
email string
fax string
additionalAddressInfo string
externalId string
anydata...

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 -

company? string -

department? string -

building? string -

apartment? string -

pOBox? string -

phone? string -

mobile? string -

email? string -

fax? string -

additionalAddressInfo? string -

externalId? string -

custom? CustomFields -

commercetools.cartsordershoppinglists: AddressDraft

Fields

Fields Included from *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
company string
department string
building string
apartment string
pOBox string
phone string
mobile string
email string
fax string
additionalAddressInfo string
externalId string
anydata...

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 -

company? string -

department? string -

building? string -

apartment? string -

pOBox? string -

phone? string -

mobile? string -

email? string -

fax? string -

additionalAddressInfo? string -

externalId? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: AnonymousIdAlreadyInUseError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ApiClient

Fields

id? string -

name? string -

scope? string -

secret? string -

lastUsedAt? string -

deleteAt? string -

createdAt? string -

commercetools.cartsordershoppinglists: ApiClientDraft

Fields

name? string -

scope? string -

deleteDaysAfterCreation? int -

commercetools.cartsordershoppinglists: ApiClientPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? ApiClient[] -

commercetools.cartsordershoppinglists: Asset

Fields

id? string -

sources? AssetSource[] -

name? LocalizedString -

description? LocalizedString -

tags? string[] -

custom? CustomFields -

'key? string -

commercetools.cartsordershoppinglists: AssetDimensions

Fields

w? int -

h? int -

commercetools.cartsordershoppinglists: AssetDraft

Fields

sources? AssetSource[] -

name? LocalizedString -

description? LocalizedString -

tags? string[] -

custom? CustomFieldsDraft -

'key? string -

commercetools.cartsordershoppinglists: AssetSource

Fields

uri? string -

'key? string -

dimensions? AssetDimensions -

contentType? string -

commercetools.cartsordershoppinglists: AssignedProductReference

Fields

product? ProductReference -

commercetools.cartsordershoppinglists: Attribute

Fields

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: AttributeBooleanType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeDateTimeType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeDateType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeDefinition

Fields

'type? AttributeType -

name? string -

label? LocalizedString -

isRequired? boolean -

attributeConstraint? AttributeConstraintEnum -

inputTip? LocalizedString -

inputHint? TextInputHint -

isSearchable? boolean -

commercetools.cartsordershoppinglists: AttributeDefinitionAlreadyExistsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

conflictingProductTypeId? string -

conflictingProductTypeName? string -

conflictingAttributeName? string -

commercetools.cartsordershoppinglists: AttributeDefinitionDraft

Fields

'type? AttributeType -

name? string -

label? LocalizedString -

isRequired? boolean -

attributeConstraint? AttributeConstraintEnum -

inputTip? LocalizedString -

inputHint? TextInputHint -

isSearchable? boolean -

commercetools.cartsordershoppinglists: AttributeDefinitionTypeConflictError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

conflictingProductTypeId? string -

conflictingProductTypeName? string -

conflictingAttributeName? string -

commercetools.cartsordershoppinglists: AttributeEnumType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

values? AttributePlainEnumValue[] -

commercetools.cartsordershoppinglists: AttributeLocalizableTextType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeLocalizedEnumType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

values? AttributeLocalizedEnumValue[] -

commercetools.cartsordershoppinglists: AttributeLocalizedEnumValue

Fields

'key? string -

label? LocalizedString -

commercetools.cartsordershoppinglists: AttributeMoneyType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeNameDoesNotExistError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

invalidAttributeName? string -

commercetools.cartsordershoppinglists: AttributeNestedType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

typeReference? ProductTypeReference -

commercetools.cartsordershoppinglists: AttributeNumberType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributePlainEnumValue

Fields

'key? string -

label? string -

commercetools.cartsordershoppinglists: AttributeReferenceType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

referenceTypeId? ReferenceTypeId -

commercetools.cartsordershoppinglists: AttributeSetType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

elementType? AttributeType -

commercetools.cartsordershoppinglists: AttributeTextType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeTimeType

Fields

Fields Included from *AttributeType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: AttributeType

Fields

name? string -

commercetools.cartsordershoppinglists: AzureEventGridDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

uri? string -

accessKey? string -

commercetools.cartsordershoppinglists: AzureServiceBusDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

connectionString? string -

commercetools.cartsordershoppinglists: BadGatewayError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: BaseAddress

Fields

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 -

company? string -

department? string -

building? string -

apartment? string -

pOBox? string -

phone? string -

mobile? string -

email? string -

fax? string -

additionalAddressInfo? string -

externalId? string -

commercetools.cartsordershoppinglists: BaseResource

Fields

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

commercetools.cartsordershoppinglists: Cart

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

'key? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

customerId? string -

customerEmail? string -

anonymousId? string -

store? StoreKeyReference -

lineItems? LineItem[] -

customLineItems? CustomLineItem[] -

totalPrice? TypedMoney -

taxedPrice? TaxedPrice -

cartState? CartState -

shippingAddress? Address -

billingAddress? Address -

inventoryMode? InventoryMode -

taxMode? TaxMode -

taxRoundingMode? RoundingMode -

taxCalculationMode? TaxCalculationMode -

customerGroup? CustomerGroupReference -

country? CountryCode -

shippingInfo? ShippingInfo -

discountCodes? DiscountCodeInfo[] -

custom? CustomFields -

paymentInfo? PaymentInfo -

locale? string -

deleteDaysAfterLastModification? int -

refusedGifts? CartDiscountReference[] -

origin? CartOrigin -

shippingRateInput? ShippingRateInput -

itemShippingAddresses? Address[] -

commercetools.cartsordershoppinglists: CartAddCustomLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

money? Money -

name? LocalizedString -

quantity? int -

slug? string -

taxCategory? TaxCategoryResourceIdentifier -

custom? CustomFieldsDraft -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartAddDiscountCodeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

code? string -

commercetools.cartsordershoppinglists: CartAddItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CartAddLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

custom? CustomFieldsDraft -

distributionChannel? ChannelResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

productId? string -

variantId? int -

sku? string -

quantity? int -

supplyChannel? ChannelResourceIdentifier -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CartAddPaymentAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: CartAddShoppingListAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

shoppingList? ShoppingListResourceIdentifier -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

targetsDelta? ItemShippingTarget[] -

commercetools.cartsordershoppinglists: CartApplyDeltaToLineItemShippingDetailsTargetsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

targetsDelta? ItemShippingTarget[] -

commercetools.cartsordershoppinglists: CartChangeCustomLineItemMoneyAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

money? Money -

commercetools.cartsordershoppinglists: CartChangeCustomLineItemQuantityAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: CartChangeLineItemQuantityAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

commercetools.cartsordershoppinglists: CartChangeTaxCalculationModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

taxCalculationMode? TaxCalculationMode -

commercetools.cartsordershoppinglists: CartChangeTaxModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

taxMode? TaxMode -

commercetools.cartsordershoppinglists: CartChangeTaxRoundingModeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

taxRoundingMode? RoundingMode -

commercetools.cartsordershoppinglists: CartClassificationTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

value? string -

price? Money -

isMatching? boolean -

commercetools.cartsordershoppinglists: CartClassificationType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

values? CustomFieldLocalizedEnumValue[] -

commercetools.cartsordershoppinglists: CartDiscount

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

name? LocalizedString -

'key? string -

description? LocalizedString -

value? CartDiscountValue -

cartPredicate? string -

target? CartDiscountTarget -

sortOrder? string -

isActive? boolean -

validFrom? string -

validUntil? string -

requiresDiscountCode? boolean -

references? Reference[] -

stackingMode? StackingMode -

custom? CustomFields -

commercetools.cartsordershoppinglists: CartDiscountChangeCartPredicateAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

cartPredicate? string -

commercetools.cartsordershoppinglists: CartDiscountChangeIsActiveAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

isActive? boolean -

commercetools.cartsordershoppinglists: CartDiscountChangeNameAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: CartDiscountChangeRequiresDiscountCodeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

requiresDiscountCode? boolean -

commercetools.cartsordershoppinglists: CartDiscountChangeSortOrderAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

sortOrder? string -

commercetools.cartsordershoppinglists: CartDiscountChangeStackingModeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

stackingMode? StackingMode -

commercetools.cartsordershoppinglists: CartDiscountChangeTargetAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

target? CartDiscountTarget -

commercetools.cartsordershoppinglists: CartDiscountChangeValueAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

value? CartDiscountValueDraft -

commercetools.cartsordershoppinglists: CartDiscountCustomLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type? string -

predicate? string -

commercetools.cartsordershoppinglists: CartDiscountDraft

Fields

name? LocalizedString -

'key? string -

description? LocalizedString -

value? CartDiscountValueDraft -

cartPredicate? string -

target? CartDiscountTarget -

sortOrder? string -

isActive? boolean -

validFrom? string -

validUntil? string -

requiresDiscountCode? boolean -

stackingMode? StackingMode -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: CartDiscountLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type? string -

predicate? string -

commercetools.cartsordershoppinglists: CartDiscountPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? CartDiscount[] -

commercetools.cartsordershoppinglists: CartDiscountReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? CartDiscount -

commercetools.cartsordershoppinglists: CartDiscountResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: CartDiscountSetCustomFieldAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartDiscountSetCustomTypeAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: CartDiscountSetDescriptionAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: CartDiscountSetKeyAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: CartDiscountSetValidFromAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

validFrom? string -

commercetools.cartsordershoppinglists: CartDiscountSetValidFromAndUntilAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: CartDiscountSetValidUntilAction

Fields

Fields Included from *CartDiscountUpdateAction

action string
anydata...

action? string -

validUntil? string -

commercetools.cartsordershoppinglists: CartDiscountShippingCostTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: CartDiscountTarget

Fields

'type? string -

commercetools.cartsordershoppinglists: CartDiscountUpdate

Fields

'version? int -

actions? CartDiscountUpdateAction[] -

commercetools.cartsordershoppinglists: CartDiscountUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: CartDiscountValue

Fields

'type? string -

commercetools.cartsordershoppinglists: CartDiscountValueAbsolute

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type? string -

money? TypedMoney[] -

commercetools.cartsordershoppinglists: CartDiscountValueAbsoluteDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type? string -

money? Money[] -

commercetools.cartsordershoppinglists: CartDiscountValueDraft

Fields

'type? string -

commercetools.cartsordershoppinglists: CartDiscountValueFixed

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type? string -

money? TypedMoney[] -

commercetools.cartsordershoppinglists: CartDiscountValueFixedDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type? string -

money? Money[] -

commercetools.cartsordershoppinglists: CartDiscountValueGiftLineItem

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type? string -

product? ProductReference -

variantId? int -

supplyChannel? ChannelReference -

distributionChannel? ChannelReference -

commercetools.cartsordershoppinglists: CartDiscountValueGiftLineItemDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type? string -

product? ProductResourceIdentifier -

variantId? int -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: CartDiscountValueRelative

Fields

Fields Included from *CartDiscountValue

type string
anydata...

'type? string -

permyriad? int -

commercetools.cartsordershoppinglists: CartDiscountValueRelativeDraft

Fields

Fields Included from *CartDiscountValueDraft

type string
anydata...

'type? string -

permyriad? int -

commercetools.cartsordershoppinglists: CartDraft

Fields

currency? CurrencyCode -

'key? string -

customerId? string -

customerEmail? string -

customerGroup? CustomerGroupResourceIdentifier -

anonymousId? string -

store? StoreResourceIdentifier -

country? string -

inventoryMode? InventoryMode -

taxMode? TaxMode -

taxRoundingMode? RoundingMode -

taxCalculationMode? TaxCalculationMode -

lineItems? LineItemDraft[] -

customLineItems? CustomLineItemDraft[] -

shippingAddress? BaseAddress -

billingAddress? BaseAddress -

shippingMethod? ShippingMethodResourceIdentifier -

externalTaxRateForShippingMethod? ExternalTaxRateDraft -

custom? CustomFieldsDraft -

locale? string -

deleteDaysAfterLastModification? int -

origin? CartOrigin -

shippingRateInput? ShippingRateInputDraft -

itemShippingAddresses? BaseAddress[] -

discountCodes? string[] -

commercetools.cartsordershoppinglists: CartPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Cart[] -

commercetools.cartsordershoppinglists: CartRecalculateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

updateProductData? boolean -

commercetools.cartsordershoppinglists: CartReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Cart -

commercetools.cartsordershoppinglists: CartRemoveCustomLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

commercetools.cartsordershoppinglists: CartRemoveDiscountCodeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: CartRemoveItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

addressKey? string -

commercetools.cartsordershoppinglists: CartRemoveLineItemAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetailsToRemove? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CartRemovePaymentAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: CartResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: CartsConfiguration

Fields

countryTaxRateFallbackEnabled? boolean -

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: CartScoreTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

score? decimal -

price? Money -

priceFunction? PriceFunction -

isMatching? boolean -

commercetools.cartsordershoppinglists: CartScoreType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

commercetools.cartsordershoppinglists: CartSetAnonymousIdAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

anonymousId? string -

commercetools.cartsordershoppinglists: CartSetBillingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CartSetBillingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetBillingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetCartTotalTaxAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

externalTotalGross? Money -

externalTaxPortions? TaxPortionDraft[] -

commercetools.cartsordershoppinglists: CartSetCountryAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

country? CountryCode -

commercetools.cartsordershoppinglists: CartSetCustomerEmailAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: CartSetCustomerGroupAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customerGroup? CustomerGroupResourceIdentifier -

commercetools.cartsordershoppinglists: CartSetCustomerIdAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customerId? string -

commercetools.cartsordershoppinglists: CartSetCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetCustomLineItemCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetCustomLineItemCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetCustomLineItemShippingDetailsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CartSetCustomLineItemTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: CartSetCustomLineItemTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartSetCustomShippingMethodAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

shippingMethodName? string -

shippingRate? ShippingRateDraft -

taxCategory? TaxCategoryResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartSetCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: CartSetDeliveryAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

deliveryId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetDeliveryAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

deliveryId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetItemShippingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

addressKey? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetItemShippingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

addressKey? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetKeyAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: CartSetLineItemCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetLineItemCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetLineItemDistributionChannelAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: CartSetLineItemPriceAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalPrice? Money -

commercetools.cartsordershoppinglists: CartSetLineItemShippingDetailsAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CartSetLineItemSupplyChannelAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

supplyChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: CartSetLineItemTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: CartSetLineItemTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartSetLineItemTotalPriceAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTotalPrice? ExternalLineItemTotalPrice -

commercetools.cartsordershoppinglists: CartSetLocaleAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: CartSetShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CartSetShippingAddressCustomFieldAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CartSetShippingAddressCustomTypeAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CartSetShippingMethodAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

shippingMethod? ShippingMethodResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartSetShippingMethodTaxAmountAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: CartSetShippingMethodTaxRateAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: CartSetShippingRateInputAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

shippingRateInput? ShippingRateInputDraft -

commercetools.cartsordershoppinglists: CartUpdate

Fields

'version? int -

actions? CartUpdateAction[] -

commercetools.cartsordershoppinglists: CartUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: CartUpdateItemShippingAddressAction

Fields

Fields Included from *CartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CartValueTier

Fields

Fields Included from *ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

minimumCentAmount? int -

price? Money -

isMatching? boolean -

commercetools.cartsordershoppinglists: CartValueType

Fields

Fields Included from *ShippingRateInputType

type ShippingRateTierType
anydata...

'type? ShippingRateTierType -

commercetools.cartsordershoppinglists: Category

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

name? LocalizedString -

slug? LocalizedString -

description? LocalizedString -

ancestors? CategoryReference[] -

parent? CategoryReference -

orderHint? string -

externalId? string -

metaTitle? LocalizedString -

metaDescription? LocalizedString -

metaKeywords? LocalizedString -

custom? CustomFields -

assets? Asset[] -

'key? string -

commercetools.cartsordershoppinglists: CategoryAddAssetAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

asset? AssetDraft -

position? int -

commercetools.cartsordershoppinglists: CategoryChangeAssetNameAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: CategoryChangeAssetOrderAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetOrder? string[] -

commercetools.cartsordershoppinglists: CategoryChangeNameAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: CategoryChangeOrderHintAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

orderHint? string -

commercetools.cartsordershoppinglists: CategoryChangeParentAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

parent? CategoryResourceIdentifier -

commercetools.cartsordershoppinglists: CategoryChangeSlugAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

slug? LocalizedString -

commercetools.cartsordershoppinglists: CategoryCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

category? Category -

commercetools.cartsordershoppinglists: CategoryCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

category? Category -

commercetools.cartsordershoppinglists: CategoryDraft

Fields

name? LocalizedString -

slug? LocalizedString -

description? LocalizedString -

parent? CategoryResourceIdentifier -

orderHint? string -

externalId? string -

metaTitle? LocalizedString -

metaDescription? LocalizedString -

metaKeywords? LocalizedString -

custom? CustomFieldsDraft -

assets? AssetDraft[] -

'key? string -

commercetools.cartsordershoppinglists: CategoryOrderHints

commercetools.cartsordershoppinglists: CategoryPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Category[] -

commercetools.cartsordershoppinglists: CategoryReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Category -

commercetools.cartsordershoppinglists: CategoryRemoveAssetAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

commercetools.cartsordershoppinglists: CategoryResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: CategorySetAssetCustomFieldAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CategorySetAssetCustomTypeAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: CategorySetAssetDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: CategorySetAssetKeyAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

commercetools.cartsordershoppinglists: CategorySetAssetSourcesAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

sources? AssetSource[] -

commercetools.cartsordershoppinglists: CategorySetAssetTagsAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

assetId? string -

assetKey? string -

tags? string[] -

commercetools.cartsordershoppinglists: CategorySetCustomFieldAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CategorySetCustomTypeAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CategorySetDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: CategorySetExternalIdAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

externalId? string -

commercetools.cartsordershoppinglists: CategorySetKeyAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: CategorySetMetaDescriptionAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

metaDescription? LocalizedString -

commercetools.cartsordershoppinglists: CategorySetMetaKeywordsAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

metaKeywords? LocalizedString -

commercetools.cartsordershoppinglists: CategorySetMetaTitleAction

Fields

Fields Included from *CategoryUpdateAction

action string
anydata...

action? string -

metaTitle? LocalizedString -

commercetools.cartsordershoppinglists: CategorySlugChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

slug? LocalizedString -

oldSlug? LocalizedString -

commercetools.cartsordershoppinglists: CategorySlugChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

slug? LocalizedString -

oldSlug? LocalizedString -

commercetools.cartsordershoppinglists: CategoryUpdate

Fields

'version? int -

actions? CategoryUpdateAction[] -

commercetools.cartsordershoppinglists: CategoryUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: CentPrecisionMoney

Fields

Fields Included from *TypedMoney

type MoneyType
fractionDigits int
centAmount int
currencyCode CurrencyCode
anydata...

'type? MoneyType -

fractionDigits? int -

centAmount? int -

currencyCode? CurrencyCode -

commercetools.cartsordershoppinglists: CentPrecisionMoneyDraft

Fields

Fields Included from *TypedMoneyDraft

centAmount int
currencyCode CurrencyCode
type MoneyType
fractionDigits int
anydata...

centAmount? int -

currencyCode? CurrencyCode -

'type? MoneyType -

fractionDigits? int -

commercetools.cartsordershoppinglists: ChangeSubscription

Fields

resourceTypeId? string -

commercetools.cartsordershoppinglists: Channel

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

roles? ChannelRoleEnum[] -

name? LocalizedString -

description? LocalizedString -

address? Address -

reviewRatingStatistics? ReviewRatingStatistics -

custom? CustomFields -

geoLocation? GeoJson -

commercetools.cartsordershoppinglists: ChannelAddRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

roles? ChannelRoleEnum[] -

commercetools.cartsordershoppinglists: ChannelChangeDescriptionAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: ChannelChangeKeyAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ChannelChangeNameAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ChannelDraft

Fields

'key? string -

roles? ChannelRoleEnum[] -

name? LocalizedString -

description? LocalizedString -

address? BaseAddress -

custom? CustomFieldsDraft -

geoLocation? GeoJson -

commercetools.cartsordershoppinglists: ChannelPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? Channel[] -

commercetools.cartsordershoppinglists: ChannelReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Channel -

commercetools.cartsordershoppinglists: ChannelRemoveRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

roles? ChannelRoleEnum[] -

commercetools.cartsordershoppinglists: ChannelResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ChannelSetAddressAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: ChannelSetAddressCustomFieldAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ChannelSetAddressCustomTypeAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ChannelSetCustomFieldAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ChannelSetCustomTypeAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ChannelSetGeoLocationAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

geoLocation? GeoJson -

commercetools.cartsordershoppinglists: ChannelSetRolesAction

Fields

Fields Included from *ChannelUpdateAction

action string
anydata...

action? string -

roles? ChannelRoleEnum[] -

commercetools.cartsordershoppinglists: ChannelUpdate

Fields

'version? int -

actions? ChannelUpdateAction[] -

commercetools.cartsordershoppinglists: ChannelUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ClassificationShippingRateInput

Fields

Fields Included from *ShippingRateInput

type string
anydata...

'type? string -

'key? string -

label? LocalizedString -

commercetools.cartsordershoppinglists: ClassificationShippingRateInputDraft

Fields

Fields Included from *ShippingRateInputDraft

type string
anydata...

'type? string -

'key? string -

commercetools.cartsordershoppinglists: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy? ProxyConfig - Proxy server related options

commercetools.cartsordershoppinglists: ClientLogging

Fields

clientId? string -

externalUserId? string -

customer? CustomerReference -

anonymousId? string -

commercetools.cartsordershoppinglists: ConcurrentModificationError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

currentVersion? int -

commercetools.cartsordershoppinglists: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth OAuth2ClientCredentialsGrantConfig|BearerTokenConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol

http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig? PoolConfiguration - Configurations associated with request pooling

cache? CacheConfig - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker

retryConfig? RetryConfig - Configurations associated with retrying

responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits

secureSocket? ClientSecureSocket - SSL/TLS-related options

proxy? ProxyConfig - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

commercetools.cartsordershoppinglists: ContainerAndKey

Fields

'key? string -

container? string -

commercetools.cartsordershoppinglists: CreatedBy

Fields

Fields Included from *ClientLogging

clientId string
externalUserId string
customer CustomerReference
anonymousId string
anydata...

clientId? string -

externalUserId? string -

customer? CustomerReference -

anonymousId? string -

commercetools.cartsordershoppinglists: Customer

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

customerNumber? string -

email? string -

password? string -

firstName? string -

lastName? string -

middleName? string -

title? string -

dateOfBirth? string -

companyName? string -

vatId? string -

addresses? Address[] -

defaultShippingAddressId? string -

shippingAddressIds? string[] -

defaultBillingAddressId? string -

billingAddressIds? string[] -

isEmailVerified? boolean -

externalId? string -

customerGroup? CustomerGroupReference -

custom? CustomFields -

locale? string -

salutation? string -

'key? string -

stores? StoreKeyReference[] -

commercetools.cartsordershoppinglists: CustomerAddAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CustomerAddBillingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerAddressAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddressAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddressChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddressChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddressRemovedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddressRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

address? Address -

commercetools.cartsordershoppinglists: CustomerAddShippingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerAddStoreAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: CustomerChangeAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: CustomerChangeEmailAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: CustomerChangePassword

Fields

id? string -

'version? int -

currentPassword? string -

newPassword? string -

commercetools.cartsordershoppinglists: CustomerCompanyNameSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

companyName? string -

commercetools.cartsordershoppinglists: CustomerCompanyNameSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

companyName? string -

commercetools.cartsordershoppinglists: CustomerCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customer? Customer -

commercetools.cartsordershoppinglists: CustomerCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customer? Customer -

commercetools.cartsordershoppinglists: CustomerCreateEmailToken

Fields

id? string -

'version? int -

ttlMinutes? int -

commercetools.cartsordershoppinglists: CustomerCreatePasswordResetToken

Fields

email? string -

ttlMinutes? int -

commercetools.cartsordershoppinglists: CustomerDateOfBirthSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

dateOfBirth? string -

commercetools.cartsordershoppinglists: CustomerDateOfBirthSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

dateOfBirth? string -

commercetools.cartsordershoppinglists: CustomerDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: CustomerDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: CustomerDraft

Fields

customerNumber? string -

email? string -

password? string -

firstName? string -

lastName? string -

middleName? string -

title? string -

anonymousCartId? string -

anonymousCart? CartResourceIdentifier -

anonymousId? string -

dateOfBirth? string -

companyName? string -

vatId? string -

addresses? BaseAddress[] -

defaultShippingAddress? int -

shippingAddresses? int[] -

defaultBillingAddress? int -

billingAddresses? int[] -

isEmailVerified? boolean -

externalId? string -

customerGroup? CustomerGroupResourceIdentifier -

custom? CustomFieldsDraft -

locale? string -

salutation? string -

'key? string -

stores? StoreResourceIdentifier[] -

commercetools.cartsordershoppinglists: CustomerEmailChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

email? string -

commercetools.cartsordershoppinglists: CustomerEmailChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

email? string -

commercetools.cartsordershoppinglists: CustomerEmailVerifiedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: CustomerEmailVerifiedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: CustomerEmailVerify

Fields

'version? int -

tokenValue? string -

commercetools.cartsordershoppinglists: CustomerFirstNameSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

firstName? string -

commercetools.cartsordershoppinglists: CustomerFirstNameSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

firstName? string -

commercetools.cartsordershoppinglists: CustomerGroup

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? string -

custom? CustomFields -

commercetools.cartsordershoppinglists: CustomerGroupChangeNameAction

Fields

Fields Included from *CustomerGroupUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: CustomerGroupDraft

Fields

'key? string -

groupName? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: CustomerGroupPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? CustomerGroup[] -

commercetools.cartsordershoppinglists: CustomerGroupReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? CustomerGroup -

commercetools.cartsordershoppinglists: CustomerGroupResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: CustomerGroupSetCustomFieldAction

Fields

Fields Included from *CustomerGroupUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CustomerGroupSetCustomTypeAction

Fields

Fields Included from *CustomerGroupUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CustomerGroupSetKeyAction

Fields

Fields Included from *CustomerGroupUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: CustomerGroupSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: CustomerGroupSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: CustomerGroupUpdate

Fields

'version? int -

actions? CustomerGroupUpdateAction[] -

commercetools.cartsordershoppinglists: CustomerGroupUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: CustomerLastNameSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lastName? string -

commercetools.cartsordershoppinglists: CustomerLastNameSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lastName? string -

commercetools.cartsordershoppinglists: CustomerPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Customer[] -

commercetools.cartsordershoppinglists: CustomerPasswordUpdatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

reset? boolean -

commercetools.cartsordershoppinglists: CustomerPasswordUpdatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

reset? boolean -

commercetools.cartsordershoppinglists: CustomerReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Customer -

commercetools.cartsordershoppinglists: CustomerRemoveAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerRemoveBillingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerRemoveShippingAddressIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerRemoveStoreAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: CustomerResetPassword

Fields

tokenValue? string -

newPassword? string -

'version? int -

commercetools.cartsordershoppinglists: CustomerResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: CustomerSetAddressCustomFieldAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CustomerSetAddressCustomTypeAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

addressId? string -

commercetools.cartsordershoppinglists: CustomerSetCompanyNameAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

companyName? string -

commercetools.cartsordershoppinglists: CustomerSetCustomerGroupAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

customerGroup? CustomerGroupResourceIdentifier -

commercetools.cartsordershoppinglists: CustomerSetCustomerNumberAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

customerNumber? string -

commercetools.cartsordershoppinglists: CustomerSetCustomFieldAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CustomerSetCustomTypeAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CustomerSetDateOfBirthAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

dateOfBirth? string -

commercetools.cartsordershoppinglists: CustomerSetDefaultBillingAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerSetDefaultShippingAddressAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: CustomerSetExternalIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

externalId? string -

commercetools.cartsordershoppinglists: CustomerSetFirstNameAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

firstName? string -

commercetools.cartsordershoppinglists: CustomerSetKeyAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: CustomerSetLastNameAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

lastName? string -

commercetools.cartsordershoppinglists: CustomerSetLocaleAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: CustomerSetMiddleNameAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

middleName? string -

commercetools.cartsordershoppinglists: CustomerSetSalutationAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

salutation? string -

commercetools.cartsordershoppinglists: CustomerSetStoresAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

stores? StoreResourceIdentifier[] -

commercetools.cartsordershoppinglists: CustomerSetTitleAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

title? string -

commercetools.cartsordershoppinglists: CustomerSetVatIdAction

Fields

Fields Included from *CustomerUpdateAction

action string
anydata...

action? string -

vatId? string -

commercetools.cartsordershoppinglists: CustomerSignin

Fields

email? string -

password? string -

anonymousCartId? string -

anonymousCart? CartResourceIdentifier -

anonymousCartSignInMode? AnonymousCartSignInMode -

anonymousId? string -

updateProductData? boolean -

commercetools.cartsordershoppinglists: CustomerSignInResult

Fields

customer? Customer -

cart? Cart -

commercetools.cartsordershoppinglists: CustomerTitleSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

title? string -

commercetools.cartsordershoppinglists: CustomerTitleSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

title? string -

commercetools.cartsordershoppinglists: CustomerToken

Fields

id? string -

createdAt? string -

lastModifiedAt? string -

customerId? string -

expiresAt? string -

value? string -

commercetools.cartsordershoppinglists: CustomerUpdate

Fields

'version? int -

actions? CustomerUpdateAction[] -

commercetools.cartsordershoppinglists: CustomerUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: CustomFieldBooleanType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldDateTimeType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldDateType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldEnumType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

values? CustomFieldEnumValue[] -

commercetools.cartsordershoppinglists: CustomFieldEnumValue

Fields

'key? string -

label? string -

commercetools.cartsordershoppinglists: CustomFieldLocalizedEnumType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

values? CustomFieldLocalizedEnumValue[] -

commercetools.cartsordershoppinglists: CustomFieldLocalizedEnumValue

Fields

'key? string -

label? LocalizedString -

commercetools.cartsordershoppinglists: CustomFieldLocalizedStringType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldMoneyType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldNumberType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldReferenceType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

referenceTypeId? ReferenceTypeId -

commercetools.cartsordershoppinglists: CustomFields

Fields

'type? TypeReference -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CustomFieldsDraft

Fields

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: CustomFieldSetType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

elementType? FieldType -

commercetools.cartsordershoppinglists: CustomFieldStringType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomFieldTimeType

Fields

Fields Included from *FieldType

name string
anydata...

name? string -

commercetools.cartsordershoppinglists: CustomLineItem

Fields

id? string -

name? LocalizedString -

money? TypedMoney -

taxedPrice? TaxedItemPrice -

totalPrice? TypedMoney -

slug? string -

quantity? int -

state? ItemState[] -

taxCategory? TaxCategoryReference -

taxRate? TaxRate -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

custom? CustomFields -

shippingDetails? ItemShippingDetails -

commercetools.cartsordershoppinglists: CustomLineItemDraft

Fields

name? LocalizedString -

quantity? int -

money? Money -

slug? string -

taxCategory? TaxCategoryResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

custom? CustomFieldsDraft -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CustomLineItemImportDraft

Fields

name? LocalizedString -

quantity? int -

money? Money -

slug? string -

state? ItemState[] -

taxRate? TaxRate -

taxCategory? TaxCategoryResourceIdentifier -

custom? CustomFieldsDraft -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: CustomLineItemReturnItem

Fields

Fields Included from *ReturnItem

id string
quantity int
type string
comment string
shipmentState ReturnShipmentState
paymentState ReturnPaymentState
custom CustomFields
lastModifiedAt string
createdAt string
anydata...

id? string -

quantity? int -

'type? string -

comment? string -

shipmentState? ReturnShipmentState -

paymentState? ReturnPaymentState -

custom? CustomFields -

lastModifiedAt? string -

createdAt? string -

customLineItemId? string -

commercetools.cartsordershoppinglists: CustomLineItemStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customLineItemId? string -

transitionDate? string -

quantity? int -

fromState? StateReference -

toState? StateReference -

commercetools.cartsordershoppinglists: CustomLineItemStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customLineItemId? string -

transitionDate? string -

quantity? int -

fromState? StateReference -

toState? StateReference -

commercetools.cartsordershoppinglists: CustomObject

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

container? string -

'key? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: CustomObjectDraft

Fields

container? string -

'key? string -

value? string|record {}|string[]|decimal|int|boolean -

'version? int -

commercetools.cartsordershoppinglists: CustomObjectPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? CustomObject[] -

commercetools.cartsordershoppinglists: CustomObjectReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? CustomObject -

commercetools.cartsordershoppinglists: CustomTokenizer

Fields

Fields Included from *SuggestTokenizer

type string
anydata...

'type? string -

inputs? string[] -

commercetools.cartsordershoppinglists: Delivery

Fields

id? string -

createdAt? string -

items? DeliveryItem[] -

parcels? Parcel[] -

address? Address -

custom? CustomFields -

commercetools.cartsordershoppinglists: DeliveryAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

delivery? Delivery -

commercetools.cartsordershoppinglists: DeliveryAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

delivery? Delivery -

commercetools.cartsordershoppinglists: DeliveryAddressSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

deliveryId? string -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: DeliveryAddressSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

deliveryId? string -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: DeliveryCloudEventsFormat

Fields

Fields Included from *DeliveryFormat

type string
anydata...

'type? string -

cloudEventsVersion? string -

commercetools.cartsordershoppinglists: DeliveryFormat

Fields

'type? string -

commercetools.cartsordershoppinglists: DeliveryItem

Fields

id? string -

quantity? int -

commercetools.cartsordershoppinglists: DeliveryItemsUpdatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

deliveryId? string -

items? DeliveryItem[] -

oldItems? DeliveryItem[] -

commercetools.cartsordershoppinglists: DeliveryItemsUpdatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

deliveryId? string -

items? DeliveryItem[] -

oldItems? DeliveryItem[] -

commercetools.cartsordershoppinglists: DeliveryPlatformFormat

Fields

Fields Included from *DeliveryFormat

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: DeliveryRemovedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

delivery? Delivery -

commercetools.cartsordershoppinglists: DeliveryRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

delivery? Delivery -

commercetools.cartsordershoppinglists: Destination

Fields

'type? string -

commercetools.cartsordershoppinglists: DiscountCode

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

name? LocalizedString -

description? LocalizedString -

code? string -

cartDiscounts? CartDiscountReference[] -

cartPredicate? string -

isActive? boolean -

references? Reference[] -

maxApplications? int -

maxApplicationsPerCustomer? int -

custom? CustomFields -

groups? string[] -

validFrom? string -

validUntil? string -

applicationVersion? int -

commercetools.cartsordershoppinglists: DiscountCodeChangeCartDiscountsAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

cartDiscounts? CartDiscountResourceIdentifier[] -

commercetools.cartsordershoppinglists: DiscountCodeChangeGroupsAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

groups? string[] -

commercetools.cartsordershoppinglists: DiscountCodeChangeIsActiveAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

isActive? boolean -

commercetools.cartsordershoppinglists: DiscountCodeDraft

Fields

name? LocalizedString -

description? LocalizedString -

code? string -

cartDiscounts? CartDiscountResourceIdentifier[] -

cartPredicate? string -

isActive? boolean -

maxApplications? int -

maxApplicationsPerCustomer? int -

custom? CustomFieldsDraft -

groups? string[] -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: DiscountCodeInfo

Fields

discountCode? DiscountCodeReference -

state? DiscountCodeState -

commercetools.cartsordershoppinglists: DiscountCodeNonApplicableError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

discountCode? string -

reason? string -

dicountCodeId? string -

validFrom? string -

validUntil? string -

validityCheckTime? string -

commercetools.cartsordershoppinglists: DiscountCodePagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? DiscountCode[] -

commercetools.cartsordershoppinglists: DiscountCodeReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? DiscountCode -

commercetools.cartsordershoppinglists: DiscountCodeResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: DiscountCodeSetCartPredicateAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

cartPredicate? string -

commercetools.cartsordershoppinglists: DiscountCodeSetCustomFieldAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: DiscountCodeSetCustomTypeAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: DiscountCodeSetDescriptionAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: DiscountCodeSetMaxApplicationsAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

maxApplications? int -

commercetools.cartsordershoppinglists: DiscountCodeSetMaxApplicationsPerCustomerAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

maxApplicationsPerCustomer? int -

commercetools.cartsordershoppinglists: DiscountCodeSetNameAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: DiscountCodeSetValidFromAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

validFrom? string -

commercetools.cartsordershoppinglists: DiscountCodeSetValidFromAndUntilAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: DiscountCodeSetValidUntilAction

Fields

Fields Included from *DiscountCodeUpdateAction

action string
anydata...

action? string -

validUntil? string -

commercetools.cartsordershoppinglists: DiscountCodeUpdate

Fields

'version? int -

actions? DiscountCodeUpdateAction[] -

commercetools.cartsordershoppinglists: DiscountCodeUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: DiscountedLineItemPortion

Fields

discount? CartDiscountReference -

discountedAmount? TypedMoney -

commercetools.cartsordershoppinglists: DiscountedLineItemPrice

Fields

value? TypedMoney -

includedDiscounts? DiscountedLineItemPortion[] -

commercetools.cartsordershoppinglists: DiscountedLineItemPriceDraft

Fields

value? Money -

includedDiscounts? DiscountedLineItemPortion[] -

commercetools.cartsordershoppinglists: DiscountedLineItemPriceForQuantity

Fields

quantity? decimal -

discountedPrice? DiscountedLineItemPrice -

commercetools.cartsordershoppinglists: DiscountedPrice

Fields

value? TypedMoney -

discount? ProductDiscountReference -

commercetools.cartsordershoppinglists: DiscountedPriceDraft

Fields

value? Money -

discount? ProductDiscountReference -

commercetools.cartsordershoppinglists: DuplicateAttributeValueError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

attribute? Attribute -

commercetools.cartsordershoppinglists: DuplicateAttributeValuesError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

attributes? Attribute[] -

commercetools.cartsordershoppinglists: DuplicateEnumValuesError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

duplicates? string[] -

commercetools.cartsordershoppinglists: DuplicateFieldError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

'field? string -

duplicateValue? string|record {}|string[]|decimal|int|boolean -

conflictingResource? Reference -

commercetools.cartsordershoppinglists: DuplicateFieldWithConflictingResourceError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

'field? string -

duplicateValue? string|record {}|string[]|decimal|int|boolean -

conflictingResource? Reference -

commercetools.cartsordershoppinglists: DuplicatePriceScopeError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

conflictingPrices? Price[] -

commercetools.cartsordershoppinglists: DuplicateVariantValuesError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

variantValues? VariantValues -

commercetools.cartsordershoppinglists: EditPreviewFailedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

result? OrderEditPreviewFailure -

commercetools.cartsordershoppinglists: EnumKeyAlreadyExistsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

conflictingEnumKey? string -

conflictingAttributeName? string -

commercetools.cartsordershoppinglists: EnumKeyDoesNotExistError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

conflictingEnumKey? string -

conflictingAttributeName? string -

commercetools.cartsordershoppinglists: EnumValueIsUsedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: EnumValuesMustMatchError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ErrorByExtension

Fields

id? string -

'key? string -

commercetools.cartsordershoppinglists: ErrorObject

Fields

code? string -

message? string -

commercetools.cartsordershoppinglists: ErrorResponse

Fields

statusCode? int -

message? string -

'error? string -

error_description? string -

errors? ErrorObject[] -

commercetools.cartsordershoppinglists: EventBridgeDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

region? string -

accountId? string -

commercetools.cartsordershoppinglists: Extension

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

destination? ExtensionDestination -

triggers? ExtensionTrigger[] -

timeoutInMs? int -

commercetools.cartsordershoppinglists: ExtensionAuthorizationHeaderAuthentication

Fields

Fields Included from *ExtensionHttpDestinationAuthentication

type string
anydata...

'type? string -

headerValue? string -

commercetools.cartsordershoppinglists: ExtensionAWSLambdaDestination

Fields

Fields Included from *ExtensionDestination

type string
anydata...

'type? string -

arn? string -

accessKey? string -

accessSecret? string -

commercetools.cartsordershoppinglists: ExtensionAzureFunctionsAuthentication

Fields

Fields Included from *ExtensionHttpDestinationAuthentication

type string
anydata...

'type? string -

'key? string -

commercetools.cartsordershoppinglists: ExtensionBadResponseError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

localizedMessage? LocalizedString -

extensionExtraInfo? record {} -

errorByExtension? ErrorByExtension -

commercetools.cartsordershoppinglists: ExtensionChangeDestinationAction

Fields

Fields Included from *ExtensionUpdateAction

action string
anydata...

action? string -

destination? ExtensionDestination -

commercetools.cartsordershoppinglists: ExtensionChangeTriggersAction

Fields

Fields Included from *ExtensionUpdateAction

action string
anydata...

action? string -

triggers? ExtensionTrigger[] -

commercetools.cartsordershoppinglists: ExtensionDestination

Fields

'type? string -

commercetools.cartsordershoppinglists: ExtensionDraft

Fields

'key? string -

destination? ExtensionDestination -

triggers? ExtensionTrigger[] -

timeoutInMs? int -

commercetools.cartsordershoppinglists: ExtensionHttpDestination

Fields

Fields Included from *ExtensionDestination

type string
anydata...

'type? string -

url? string -

authentication? ExtensionHttpDestinationAuthentication -

commercetools.cartsordershoppinglists: ExtensionHttpDestinationAuthentication

Fields

'type? string -

commercetools.cartsordershoppinglists: ExtensionInput

Fields

action? ExtensionAction -

'resource? Reference -

commercetools.cartsordershoppinglists: ExtensionNoResponseError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

extensionId? string -

extensionKey? string -

commercetools.cartsordershoppinglists: ExtensionPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Extension[] -

commercetools.cartsordershoppinglists: ExtensionSetKeyAction

Fields

Fields Included from *ExtensionUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ExtensionSetTimeoutInMsAction

Fields

Fields Included from *ExtensionUpdateAction

action string
anydata...

action? string -

timeoutInMs? int -

commercetools.cartsordershoppinglists: ExtensionTrigger

Fields

resourceTypeId? ExtensionResourceTypeId -

actions? ExtensionAction[] -

commercetools.cartsordershoppinglists: ExtensionUpdate

Fields

'version? int -

actions? ExtensionUpdateAction[] -

commercetools.cartsordershoppinglists: ExtensionUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ExtensionUpdateActionsFailedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

localizedMessage? LocalizedString -

extensionExtraInfo? record {} -

errorByExtension? ErrorByExtension -

commercetools.cartsordershoppinglists: ExternalLineItemTotalPrice

Fields

price? Money -

totalPrice? Money -

commercetools.cartsordershoppinglists: ExternalOAuth

Fields

url? string -

authorizationHeader? string -

commercetools.cartsordershoppinglists: ExternalOAuthFailedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ExternalTaxAmountDraft

Fields

totalGross? Money -

taxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: ExternalTaxRateDraft

Fields

name? string -

amount? decimal -

country? string -

state? string -

subRates? SubRate[] -

includedInPrice? boolean -

commercetools.cartsordershoppinglists: FacetResult

Fields

'type? FacetTypes -

commercetools.cartsordershoppinglists: FacetResultRange

Fields

'from? decimal -

fromStr? string -

to? decimal -

toStr? string -

count? int -

productCount? int -

total? decimal -

min? decimal -

max? decimal -

mean? decimal -

commercetools.cartsordershoppinglists: FacetResults

commercetools.cartsordershoppinglists: FacetResultTerm

Fields

term? string|record {}|string[]|decimal|int|boolean -

count? int -

productCount? int -

commercetools.cartsordershoppinglists: FeatureRemovedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: FieldContainer

commercetools.cartsordershoppinglists: FieldDefinition

Fields

'type? FieldType -

name? string -

label? LocalizedString -

required? boolean -

inputHint? TypeTextInputHint -

commercetools.cartsordershoppinglists: FieldType

Fields

name? string -

commercetools.cartsordershoppinglists: FilteredFacetResult

Fields

Fields Included from *FacetResult

type FacetTypes
anydata...

'type? FacetTypes -

count? int -

productCount? int -

commercetools.cartsordershoppinglists: GeneralError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: GeoJson

Fields

'type? string -

commercetools.cartsordershoppinglists: GeoJsonPoint

Fields

Fields Included from *GeoJson

type string
anydata...

'type? string -

coordinates? decimal[] -

commercetools.cartsordershoppinglists: GoogleCloudPubSubDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

projectId? string -

topic? string -

commercetools.cartsordershoppinglists: GraphQLError

Fields

message? string -

locations? GraphQLErrorLocation[] -

path? (string|record {}|string[]|decimal|int|boolean)[] -

commercetools.cartsordershoppinglists: GraphQLErrorLocation

Fields

line? int -

column? int -

commercetools.cartsordershoppinglists: GraphQLRequest

Fields

query? string -

operationName? string -

variables? GraphQLVariablesMap -

commercetools.cartsordershoppinglists: GraphQLResponse

Fields

data? string|record {}|string[]|decimal|int|boolean -

errors? GraphQLError[] -

commercetools.cartsordershoppinglists: GraphQLVariablesMap

commercetools.cartsordershoppinglists: HighPrecisionMoney

Fields

Fields Included from *TypedMoney

type MoneyType
fractionDigits int
centAmount int
currencyCode CurrencyCode
anydata...

'type? MoneyType -

fractionDigits? int -

centAmount? int -

currencyCode? CurrencyCode -

preciseAmount? int -

commercetools.cartsordershoppinglists: HighPrecisionMoneyDraft

Fields

Fields Included from *TypedMoneyDraft

centAmount int
currencyCode CurrencyCode
type MoneyType
fractionDigits int
anydata...

centAmount? int -

currencyCode? CurrencyCode -

'type? MoneyType -

fractionDigits? int -

preciseAmount? int -

commercetools.cartsordershoppinglists: Hit

Fields

id? string -

'version? int -

relevance? decimal -

commercetools.cartsordershoppinglists: Image

Fields

url? string -

dimensions? ImageDimensions -

label? string -

commercetools.cartsordershoppinglists: ImageDimensions

Fields

w? int -

h? int -

commercetools.cartsordershoppinglists: IndividualProductSelectionType

Fields

Fields Included from *ProductSelectionType

type ProductSelectionTypeEnum
anydata...

'type? ProductSelectionTypeEnum -

name? LocalizedString -

commercetools.cartsordershoppinglists: InsufficientScopeError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InternalConstraintViolatedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidCredentialsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidCurrentPasswordError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidFieldError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

'field? string -

invalidValue? string|record {}|string[]|decimal|int|boolean -

allowedValues? (string|record {}|string[]|decimal|int|boolean)[] -

commercetools.cartsordershoppinglists: InvalidInputError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidItemShippingDetailsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

subject? string -

itemId? string -

commercetools.cartsordershoppinglists: InvalidJsonInputError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidOperationError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidSubjectError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InvalidTokenError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: InventoryEntry

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sku? string -

supplyChannel? ChannelReference -

quantityOnStock? int -

availableQuantity? int -

restockableInDays? int -

expectedDelivery? string -

custom? CustomFields -

commercetools.cartsordershoppinglists: InventoryEntryAddQuantityAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

quantity? int -

commercetools.cartsordershoppinglists: InventoryEntryChangeQuantityAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

quantity? int -

commercetools.cartsordershoppinglists: InventoryEntryCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

inventoryEntry? InventoryEntry -

commercetools.cartsordershoppinglists: InventoryEntryCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

inventoryEntry? InventoryEntry -

commercetools.cartsordershoppinglists: InventoryEntryDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

sku? string -

supplyChannel? ChannelReference -

commercetools.cartsordershoppinglists: InventoryEntryDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

sku? string -

supplyChannel? ChannelReference -

commercetools.cartsordershoppinglists: InventoryEntryDraft

Fields

sku? string -

supplyChannel? ChannelResourceIdentifier -

quantityOnStock? int -

restockableInDays? int -

expectedDelivery? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: InventoryEntryQuantitySetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

oldQuantityOnStock? int -

newQuantityOnStock? int -

oldAvailableQuantity? int -

newAvailableQuantity? int -

supplyChannel? ChannelReference -

commercetools.cartsordershoppinglists: InventoryEntryQuantitySetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

oldQuantityOnStock? int -

newQuantityOnStock? int -

oldAvailableQuantity? int -

newAvailableQuantity? int -

supplyChannel? ChannelReference -

commercetools.cartsordershoppinglists: InventoryEntryReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? InventoryEntry -

commercetools.cartsordershoppinglists: InventoryEntryRemoveQuantityAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

quantity? int -

commercetools.cartsordershoppinglists: InventoryEntryResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: InventoryEntrySetCustomFieldAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: InventoryEntrySetCustomTypeAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: InventoryEntrySetExpectedDeliveryAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

expectedDelivery? string -

commercetools.cartsordershoppinglists: InventoryEntrySetRestockableInDaysAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

restockableInDays? int -

commercetools.cartsordershoppinglists: InventoryEntrySetSupplyChannelAction

Fields

Fields Included from *InventoryEntryUpdateAction

action string
anydata...

action? string -

supplyChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: InventoryEntryUpdate

Fields

'version? int -

actions? InventoryEntryUpdateAction[] -

commercetools.cartsordershoppinglists: InventoryEntryUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: InventoryPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? InventoryEntry[] -

commercetools.cartsordershoppinglists: IronMqDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

uri? string -

commercetools.cartsordershoppinglists: ItemShippingDetails

Fields

targets? ItemShippingTarget[] -

valid? boolean -

commercetools.cartsordershoppinglists: ItemShippingDetailsDraft

Fields

targets? ItemShippingTarget[] -

commercetools.cartsordershoppinglists: ItemShippingTarget

Fields

addressKey? string -

quantity? decimal -

commercetools.cartsordershoppinglists: ItemState

Fields

quantity? decimal -

state? StateReference -

commercetools.cartsordershoppinglists: KeyReference

Fields

typeId? ReferenceTypeId -

'key? string -

commercetools.cartsordershoppinglists: LanguageUsedInStoresError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: LastModifiedBy

Fields

Fields Included from *ClientLogging

clientId string
externalUserId string
customer CustomerReference
anonymousId string
anydata...

clientId? string -

externalUserId? string -

customer? CustomerReference -

anonymousId? string -

commercetools.cartsordershoppinglists: LineItem

Fields

id? string -

productId? string -

productKey? string -

name? LocalizedString -

productSlug? LocalizedString -

productType? ProductTypeReference -

variant? ProductVariant -

price? Price -

taxedPrice? TaxedItemPrice -

totalPrice? TypedMoney -

quantity? int -

addedAt? string -

state? ItemState[] -

taxRate? TaxRate -

supplyChannel? ChannelReference -

distributionChannel? ChannelReference -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

priceMode? LineItemPriceMode -

lineItemMode? LineItemMode -

custom? CustomFields -

shippingDetails? ItemShippingDetails -

lastModifiedAt? string -

commercetools.cartsordershoppinglists: LineItemDraft

Fields

productId? string -

variantId? int -

sku? string -

quantity? int -

addedAt? string -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

custom? CustomFieldsDraft -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: LineItemImportDraft

Fields

productId? string -

name? LocalizedString -

variant? ProductVariantImportDraft -

price? PriceDraft -

quantity? int -

state? ItemState[] -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

taxRate? TaxRate -

custom? CustomFieldsDraft -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: LineItemReturnItem

Fields

Fields Included from *ReturnItem

id string
quantity int
type string
comment string
shipmentState ReturnShipmentState
paymentState ReturnPaymentState
custom CustomFields
lastModifiedAt string
createdAt string
anydata...

id? string -

quantity? int -

'type? string -

comment? string -

shipmentState? ReturnShipmentState -

paymentState? ReturnPaymentState -

custom? CustomFields -

lastModifiedAt? string -

createdAt? string -

lineItemId? string -

commercetools.cartsordershoppinglists: LineItemStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lineItemId? string -

transitionDate? string -

quantity? int -

fromState? StateReference -

toState? StateReference -

commercetools.cartsordershoppinglists: LineItemStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lineItemId? string -

transitionDate? string -

quantity? int -

fromState? StateReference -

toState? StateReference -

commercetools.cartsordershoppinglists: LocalizedString

commercetools.cartsordershoppinglists: Location

Fields

country? CountryCode -

state? string -

commercetools.cartsordershoppinglists: MatchingPriceNotFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

productId? string -

variantId? int -

currency? string -

country? string -

customerGroup? CustomerGroupReference -

channel? ChannelReference -

commercetools.cartsordershoppinglists: MaxResourceLimitExceededError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

exceededResource? ReferenceTypeId -

commercetools.cartsordershoppinglists: Message

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: MessageConfiguration

Fields

enabled? boolean -

deleteDaysAfterCreation? int -

commercetools.cartsordershoppinglists: MessageConfigurationDraft

Fields

enabled? boolean -

deleteDaysAfterCreation? int -

commercetools.cartsordershoppinglists: MessageDelivery

Fields

Fields Included from *SubscriptionDelivery

projectKey string
notificationType string
resource Reference
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

projectKey? string -

notificationType? string -

'resource? Reference -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

sequenceNumber? int -

resourceVersion? int -

payloadNotIncluded? PayloadNotIncluded -

commercetools.cartsordershoppinglists: MessagePagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Message[] -

commercetools.cartsordershoppinglists: MessagePayload

Fields

'type? string -

commercetools.cartsordershoppinglists: MessageSubscription

Fields

resourceTypeId? string -

types? string[] -

commercetools.cartsordershoppinglists: MissingRoleOnChannelError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

channel? ChannelResourceIdentifier -

missingRole? ChannelRoleEnum -

commercetools.cartsordershoppinglists: MissingTaxRateForCountryError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

taxCategoryId? string -

country? string -

state? string -

commercetools.cartsordershoppinglists: Money

Fields

centAmount? int -

currencyCode? CurrencyCode -

commercetools.cartsordershoppinglists: MultiBuyCustomLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type? string -

predicate? string -

triggerQuantity? int -

discountedQuantity? int -

maxOccurrence? int -

selectionMode? SelectionMode -

commercetools.cartsordershoppinglists: MultiBuyLineItemsTarget

Fields

Fields Included from *CartDiscountTarget

type string
anydata...

'type? string -

predicate? string -

triggerQuantity? int -

discountedQuantity? int -

maxOccurrence? int -

selectionMode? SelectionMode -

commercetools.cartsordershoppinglists: MyCartAddDiscountCodeAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

code? string -

commercetools.cartsordershoppinglists: MyCartAddItemShippingAddressAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCartAddLineItemAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

custom? CustomFieldsDraft -

distributionChannel? ChannelResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

productId? string -

variantId? int -

sku? string -

quantity? int -

supplyChannel? ChannelResourceIdentifier -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetails? ItemShippingDetailsDraft -

addedAt? string -

commercetools.cartsordershoppinglists: MyCartAddPaymentAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: MyCartApplyDeltaToLineItemShippingDetailsTargetsAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

targetsDelta? ItemShippingTarget[] -

commercetools.cartsordershoppinglists: MyCartChangeLineItemQuantityAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

commercetools.cartsordershoppinglists: MyCartChangeTaxModeAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

taxMode? TaxMode -

commercetools.cartsordershoppinglists: MyCartDraft

Fields

currency? CurrencyCode -

customerEmail? string -

country? string -

inventoryMode? InventoryMode -

lineItems? MyLineItemDraft[] -

shippingAddress? BaseAddress -

billingAddress? BaseAddress -

shippingMethod? ShippingMethodResourceIdentifier -

custom? CustomFieldsDraft -

locale? string -

taxMode? TaxMode -

deleteDaysAfterLastModification? int -

itemShippingAddresses? BaseAddress[] -

store? StoreKeyReference -

discountCodes? DiscountCodeInfo[] -

commercetools.cartsordershoppinglists: MyCartRecalculateAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

updateProductData? boolean -

commercetools.cartsordershoppinglists: MyCartRemoveDiscountCodeAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: MyCartRemoveItemShippingAddressAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCartRemoveLineItemAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetailsToRemove? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: MyCartRemovePaymentAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: MyCartSetBillingAddressAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCartSetCountryAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

country? CountryCode -

commercetools.cartsordershoppinglists: MyCartSetCustomerEmailAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: MyCartSetCustomFieldAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyCartSetCustomTypeAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyCartSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: MyCartSetLineItemCustomFieldAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyCartSetLineItemCustomTypeAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyCartSetLineItemDistributionChannelAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: MyCartSetLineItemShippingDetailsAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: MyCartSetLineItemSupplyChannelAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

lineItemId? string -

supplyChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: MyCartSetLocaleAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: MyCartSetShippingAddressAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCartSetShippingMethodAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

shippingMethod? ShippingMethodResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: MyCartUpdate

Fields

'version? int -

actions? MyCartUpdateAction[] -

commercetools.cartsordershoppinglists: MyCartUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: MyCartUpdateItemShippingAddressAction

Fields

Fields Included from *MyCartUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCustomerAddAddressAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCustomerAddBillingAddressIdAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerAddShippingAddressIdAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerChangeAddressAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: MyCustomerChangeEmailAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: MyCustomerChangePassword

Fields

'version? int -

currentPassword? string -

newPassword? string -

commercetools.cartsordershoppinglists: MyCustomerDraft

Fields

email? string -

password? string -

firstName? string -

lastName? string -

middleName? string -

title? string -

dateOfBirth? string -

companyName? string -

vatId? string -

addresses? BaseAddress[] -

defaultShippingAddress? int -

defaultBillingAddress? int -

custom? CustomFields -

locale? string -

stores? StoreResourceIdentifier[] -

commercetools.cartsordershoppinglists: MyCustomerRemoveAddressAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerRemoveBillingAddressIdAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerRemoveShippingAddressIdAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerSetCompanyNameAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

companyName? string -

commercetools.cartsordershoppinglists: MyCustomerSetCustomFieldAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyCustomerSetCustomTypeAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyCustomerSetDateOfBirthAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

dateOfBirth? string -

commercetools.cartsordershoppinglists: MyCustomerSetDefaultBillingAddressAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerSetDefaultShippingAddressAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

addressId? string -

addressKey? string -

commercetools.cartsordershoppinglists: MyCustomerSetFirstNameAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

firstName? string -

commercetools.cartsordershoppinglists: MyCustomerSetLastNameAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

lastName? string -

commercetools.cartsordershoppinglists: MyCustomerSetLocaleAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: MyCustomerSetMiddleNameAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

middleName? string -

commercetools.cartsordershoppinglists: MyCustomerSetSalutationAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

salutation? string -

commercetools.cartsordershoppinglists: MyCustomerSetTitleAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

title? string -

commercetools.cartsordershoppinglists: MyCustomerSetVatIdAction

Fields

Fields Included from *MyCustomerUpdateAction

action string
anydata...

action? string -

vatId? string -

commercetools.cartsordershoppinglists: MyCustomerUpdate

Fields

'version? int -

actions? MyCustomerUpdateAction[] -

commercetools.cartsordershoppinglists: MyCustomerUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: MyLineItemDraft

Fields

productId? string -

variantId? int -

quantity? int -

addedAt? string -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

custom? CustomFieldsDraft -

shippingDetails? ItemShippingDetailsDraft -

sku? string -

commercetools.cartsordershoppinglists: MyOrderFromCartDraft

Fields

id? string -

'version? int -

commercetools.cartsordershoppinglists: MyPayment

Fields

id? string -

'version? int -

customer? CustomerReference -

anonymousId? string -

amountPlanned? TypedMoney -

paymentMethodInfo? PaymentMethodInfo -

transactions? Transaction[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: MyPaymentAddTransactionAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

'transaction? TransactionDraft -

commercetools.cartsordershoppinglists: MyPaymentChangeAmountPlannedAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

amount? Money -

commercetools.cartsordershoppinglists: MyPaymentDraft

Fields

amountPlanned? Money -

paymentMethodInfo? PaymentMethodInfo -

custom? CustomFieldsDraft -

'transaction? MyTransactionDraft -

commercetools.cartsordershoppinglists: MyPaymentPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? MyPayment[] -

commercetools.cartsordershoppinglists: MyPaymentSetCustomFieldAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyPaymentSetMethodInfoInterfaceAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

interface? string -

commercetools.cartsordershoppinglists: MyPaymentSetMethodInfoMethodAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

method? string -

commercetools.cartsordershoppinglists: MyPaymentSetMethodInfoNameAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: MyPaymentSetTransactionCustomFieldAction

Fields

Fields Included from *MyPaymentUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyPaymentUpdate

Fields

'version? int -

actions? MyPaymentUpdateAction[] -

commercetools.cartsordershoppinglists: MyPaymentUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: MyShoppingListAddLineItemAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

sku? string -

productId? string -

variantId? int -

quantity? int -

addedAt? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: MyShoppingListAddTextLineItemAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

description? LocalizedString -

quantity? int -

addedAt? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: MyShoppingListChangeLineItemQuantityAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: MyShoppingListChangeLineItemsOrderAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

lineItemOrder? string[] -

commercetools.cartsordershoppinglists: MyShoppingListChangeNameAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: MyShoppingListChangeTextLineItemNameAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: MyShoppingListChangeTextLineItemQuantityAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: MyShoppingListChangeTextLineItemsOrderAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemOrder? string[] -

commercetools.cartsordershoppinglists: MyShoppingListDraft

Fields

name? LocalizedString -

description? LocalizedString -

lineItems? ShoppingListLineItemDraft[] -

textLineItems? TextLineItemDraft[] -

custom? CustomFieldsDraft -

deleteDaysAfterLastModification? int -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: MyShoppingListRemoveLineItemAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: MyShoppingListRemoveTextLineItemAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: MyShoppingListSetCustomFieldAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyShoppingListSetCustomTypeAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyShoppingListSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: MyShoppingListSetDescriptionAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: MyShoppingListSetLineItemCustomFieldAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyShoppingListSetLineItemCustomTypeAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyShoppingListSetTextLineItemCustomFieldAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: MyShoppingListSetTextLineItemCustomTypeAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: MyShoppingListSetTextLineItemDescriptionAction

Fields

Fields Included from *MyShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: MyShoppingListUpdate

Fields

'version? int -

actions? MyShoppingListUpdateAction[] -

commercetools.cartsordershoppinglists: MyShoppingListUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: MyTransactionDraft

Fields

timestamp? string -

'type? TransactionType -

amount? Money -

interactionId? string -

custom? CustomFields -

commercetools.cartsordershoppinglists: NoMatchingProductDiscountFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: NotEnabledError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: OAuth2ClientCredentialsGrantConfig

Closed record

OAuth2 Client Credentials Grant Configs

Fields

Fields Included from *OAuth2ClientCredentialsGrantConfig

tokenUrl string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

tokenUrl string(default " ") - Token URL

commercetools.cartsordershoppinglists: ObjectNotFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: Order

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

completedAt? string -

orderNumber? string -

customerId? string -

customerEmail? string -

anonymousId? string -

store? StoreKeyReference -

lineItems? LineItem[] -

customLineItems? CustomLineItem[] -

totalPrice? TypedMoney -

taxedPrice? TaxedPrice -

shippingAddress? Address -

billingAddress? Address -

taxMode? TaxMode -

taxRoundingMode? RoundingMode -

customerGroup? CustomerGroupReference -

country? string -

orderState? OrderState -

state? StateReference -

shipmentState? ShipmentState -

paymentState? PaymentState -

shippingInfo? ShippingInfo -

syncInfo? SyncInfo[] -

returnInfo? ReturnInfo[] -

discountCodes? DiscountCodeInfo[] -

lastMessageSequenceNumber? int -

cart? CartReference -

custom? CustomFields -

paymentInfo? PaymentInfo -

locale? string -

inventoryMode? InventoryMode -

origin? CartOrigin -

taxCalculationMode? TaxCalculationMode -

shippingRateInput? ShippingRateInput -

itemShippingAddresses? Address[] -

refusedGifts? CartDiscountReference[] -

commercetools.cartsordershoppinglists: OrderAddDeliveryAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

items? DeliveryItem[] -

address? BaseAddress -

parcels? ParcelDraft[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: OrderAddItemShippingAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: OrderAddParcelToDeliveryAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

measurements? ParcelMeasurements -

trackingData? TrackingData -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: OrderAddPaymentAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: OrderAddReturnInfoAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

returnTrackingId? string -

items? ReturnItemDraft[] -

returnDate? string -

commercetools.cartsordershoppinglists: OrderBillingAddressSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: OrderBillingAddressSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: OrderChangeOrderStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

orderState? OrderState -

commercetools.cartsordershoppinglists: OrderChangePaymentStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

paymentState? PaymentState -

commercetools.cartsordershoppinglists: OrderChangeShipmentStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

shipmentState? ShipmentState -

commercetools.cartsordershoppinglists: OrderCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'order? Order -

commercetools.cartsordershoppinglists: OrderCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

'order? Order -

commercetools.cartsordershoppinglists: OrderCustomerEmailSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

email? string -

oldEmail? string -

commercetools.cartsordershoppinglists: OrderCustomerEmailSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

email? string -

oldEmail? string -

commercetools.cartsordershoppinglists: OrderCustomerGroupSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customerGroup? CustomerGroupReference -

oldCustomerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: OrderCustomerGroupSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customerGroup? CustomerGroupReference -

oldCustomerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: OrderCustomerSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customer? CustomerReference -

customerGroup? CustomerGroupReference -

oldCustomer? CustomerReference -

oldCustomerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: OrderCustomerSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customer? CustomerReference -

customerGroup? CustomerGroupReference -

oldCustomer? CustomerReference -

oldCustomerGroup? CustomerGroupReference -

commercetools.cartsordershoppinglists: OrderCustomLineItemDiscountSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

customLineItemId? string -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

taxedPrice? TaxedItemPrice -

commercetools.cartsordershoppinglists: OrderCustomLineItemDiscountSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

customLineItemId? string -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

taxedPrice? TaxedItemPrice -

commercetools.cartsordershoppinglists: OrderDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'order? Order -

commercetools.cartsordershoppinglists: OrderDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

'order? Order -

commercetools.cartsordershoppinglists: OrderDiscountCodeAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: OrderDiscountCodeAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: OrderDiscountCodeRemovedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: OrderDiscountCodeRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: OrderDiscountCodeStateSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

discountCode? DiscountCodeReference -

state? DiscountCodeState -

oldState? DiscountCodeState -

commercetools.cartsordershoppinglists: OrderDiscountCodeStateSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

discountCode? DiscountCodeReference -

state? DiscountCodeState -

oldState? DiscountCodeState -

commercetools.cartsordershoppinglists: OrderEdit

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

'resource? OrderReference -

stagedActions? StagedOrderUpdateAction[] -

custom? CustomFields -

result? OrderEditResult -

comment? string -

commercetools.cartsordershoppinglists: OrderEditAddStagedActionAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

stagedAction? StagedOrderUpdateAction -

commercetools.cartsordershoppinglists: OrderEditApplied

Fields

Fields Included from *OrderEditResult

type string
anydata...

'type? string -

appliedAt? string -

excerptBeforeEdit? OrderExcerpt -

excerptAfterEdit? OrderExcerpt -

commercetools.cartsordershoppinglists: OrderEditAppliedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

edit? OrderEditReference -

result? OrderEditApplied -

commercetools.cartsordershoppinglists: OrderEditAppliedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

edit? OrderEditReference -

result? OrderEditApplied -

commercetools.cartsordershoppinglists: OrderEditApply

Fields

editVersion? int -

resourceVersion? int -

commercetools.cartsordershoppinglists: OrderEditDraft

Fields

'key? string -

'resource? OrderReference -

stagedActions? StagedOrderUpdateAction[] -

custom? CustomFieldsDraft -

comment? string -

dryRun? boolean -

commercetools.cartsordershoppinglists: OrderEditNotProcessed

Fields

Fields Included from *OrderEditResult

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: OrderEditPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? OrderEdit[] -

commercetools.cartsordershoppinglists: OrderEditPreviewFailure

Fields

Fields Included from *OrderEditResult

type string
anydata...

'type? string -

errors? ErrorObject[] -

commercetools.cartsordershoppinglists: OrderEditPreviewSuccess

Fields

Fields Included from *OrderEditResult

type string
anydata...

'type? string -

preview? StagedOrder -

messagePayloads? MessagePayload[] -

commercetools.cartsordershoppinglists: OrderEditReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? OrderEdit -

commercetools.cartsordershoppinglists: OrderEditResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: OrderEditResult

Fields

'type? string -

commercetools.cartsordershoppinglists: OrderEditSetCommentAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

comment? string -

commercetools.cartsordershoppinglists: OrderEditSetCustomFieldAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderEditSetCustomTypeAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: OrderEditSetKeyAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: OrderEditSetStagedActionsAction

Fields

Fields Included from *OrderEditUpdateAction

action string
anydata...

action? string -

stagedActions? StagedOrderUpdateAction[] -

commercetools.cartsordershoppinglists: OrderEditUpdate

Fields

'version? int -

actions? OrderEditUpdateAction[] -

dryRun? boolean -

commercetools.cartsordershoppinglists: OrderEditUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: OrderExcerpt

Fields

totalPrice? TypedMoney -

taxedPrice? TaxedPrice -

'version? int -

commercetools.cartsordershoppinglists: OrderFromCartDraft

Fields

id? string -

cart? CartResourceIdentifier -

'version? int -

orderNumber? string -

paymentState? PaymentState -

shipmentState? ShipmentState -

orderState? OrderState -

state? StateResourceIdentifier -

commercetools.cartsordershoppinglists: OrderImportCustomLineItemStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

state? ItemState[] -

commercetools.cartsordershoppinglists: OrderImportDraft

Fields

orderNumber? string -

customerId? string -

customerEmail? string -

lineItems? LineItemImportDraft[] -

customLineItems? CustomLineItemImportDraft[] -

totalPrice? Money -

taxedPrice? TaxedPriceDraft -

shippingAddress? BaseAddress -

billingAddress? BaseAddress -

customerGroup? CustomerGroupResourceIdentifier -

country? string -

orderState? OrderState -

shipmentState? ShipmentState -

paymentState? PaymentState -

shippingInfo? ShippingInfoImportDraft -

completedAt? string -

custom? CustomFieldsDraft -

inventoryMode? InventoryMode -

taxRoundingMode? RoundingMode -

itemShippingAddresses? BaseAddress[] -

store? StoreResourceIdentifier -

origin? CartOrigin -

commercetools.cartsordershoppinglists: OrderImportedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'order? Order -

commercetools.cartsordershoppinglists: OrderImportedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

'order? Order -

commercetools.cartsordershoppinglists: OrderImportLineItemStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

state? ItemState[] -

commercetools.cartsordershoppinglists: OrderLineItemAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lineItem? LineItem -

addedQuantity? int -

commercetools.cartsordershoppinglists: OrderLineItemAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lineItem? LineItem -

addedQuantity? int -

commercetools.cartsordershoppinglists: OrderLineItemDiscountSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lineItemId? string -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

totalPrice? Money -

taxedPrice? TaxedItemPrice -

commercetools.cartsordershoppinglists: OrderLineItemDiscountSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lineItemId? string -

discountedPricePerQuantity? DiscountedLineItemPriceForQuantity[] -

totalPrice? Money -

taxedPrice? TaxedItemPrice -

commercetools.cartsordershoppinglists: OrderLineItemDistributionChannelSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lineItemId? string -

distributionChannel? ChannelReference -

commercetools.cartsordershoppinglists: OrderLineItemDistributionChannelSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lineItemId? string -

distributionChannel? ChannelReference -

commercetools.cartsordershoppinglists: OrderLineItemRemovedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

lineItemId? string -

removedQuantity? int -

newQuantity? int -

newState? ItemState[] -

newTotalPrice? TypedMoney -

newTaxedPrice? TaxedItemPrice -

newPrice? Price -

newShippingDetail? ItemShippingDetails -

commercetools.cartsordershoppinglists: OrderLineItemRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

lineItemId? string -

removedQuantity? int -

newQuantity? int -

newState? ItemState[] -

newTotalPrice? TypedMoney -

newTaxedPrice? TaxedItemPrice -

newPrice? Price -

newShippingDetail? ItemShippingDetails -

commercetools.cartsordershoppinglists: OrderPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Order[] -

commercetools.cartsordershoppinglists: OrderPagedSearchResponse

Fields

total? int -

offset? int -

'limit? int -

hits? Hit[] -

commercetools.cartsordershoppinglists: OrderPaymentAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

payment? PaymentReference -

commercetools.cartsordershoppinglists: OrderPaymentAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

payment? PaymentReference -

commercetools.cartsordershoppinglists: OrderPaymentStateChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

paymentState? PaymentState -

oldPaymentState? PaymentState -

commercetools.cartsordershoppinglists: OrderPaymentStateChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

paymentState? PaymentState -

oldPaymentState? PaymentState -

commercetools.cartsordershoppinglists: OrderReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Order -

commercetools.cartsordershoppinglists: OrderRemoveDeliveryAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

commercetools.cartsordershoppinglists: OrderRemoveItemShippingAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

commercetools.cartsordershoppinglists: OrderRemoveParcelFromDeliveryAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

commercetools.cartsordershoppinglists: OrderRemovePaymentAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: OrderResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: OrderReturnInfoAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

returnInfo? ReturnInfo -

commercetools.cartsordershoppinglists: OrderReturnInfoAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

returnInfo? ReturnInfo -

commercetools.cartsordershoppinglists: OrderReturnInfoSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

returnInfo? ReturnInfo[] -

commercetools.cartsordershoppinglists: OrderReturnInfoSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

returnInfo? ReturnInfo[] -

commercetools.cartsordershoppinglists: OrderReturnShipmentStateChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

returnItemId? string -

returnShipmentState? ReturnShipmentState -

commercetools.cartsordershoppinglists: OrderReturnShipmentStateChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

returnItemId? string -

returnShipmentState? ReturnShipmentState -

commercetools.cartsordershoppinglists: OrderSearchRequest

Fields

query? OrderSearchQuery -

sort? OrderSearchSorting -

'limit? int -

offset? int -

commercetools.cartsordershoppinglists: OrderSetBillingAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: OrderSetBillingAddressCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetBillingAddressCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetCustomerEmailAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: OrderSetCustomerIdAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customerId? string -

commercetools.cartsordershoppinglists: OrderSetCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetCustomLineItemCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetCustomLineItemCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetCustomLineItemShippingDetailsAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: OrderSetCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetDeliveryAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: OrderSetDeliveryAddressCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetDeliveryAddressCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetDeliveryCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetDeliveryCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetDeliveryItemsAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: OrderSetItemShippingAddressCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetItemShippingAddressCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetLineItemCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetLineItemCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetLineItemShippingDetailsAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: OrderSetLocaleAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: OrderSetOrderNumberAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

orderNumber? string -

commercetools.cartsordershoppinglists: OrderSetParcelCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetParcelCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetParcelItemsAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: OrderSetParcelMeasurementsAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

measurements? ParcelMeasurements -

commercetools.cartsordershoppinglists: OrderSetParcelTrackingDataAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

trackingData? TrackingData -

commercetools.cartsordershoppinglists: OrderSetReturnInfoAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

items? ReturnInfoDraft[] -

commercetools.cartsordershoppinglists: OrderSetReturnItemCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetReturnItemCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetReturnPaymentStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

paymentState? ReturnPaymentState -

commercetools.cartsordershoppinglists: OrderSetReturnShipmentStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

shipmentState? ReturnShipmentState -

commercetools.cartsordershoppinglists: OrderSetShippingAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: OrderSetShippingAddressCustomFieldAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: OrderSetShippingAddressCustomTypeAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: OrderSetStoreAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: OrderShipmentStateChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

shipmentState? ShipmentState -

oldShipmentState? ShipmentState -

commercetools.cartsordershoppinglists: OrderShipmentStateChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

shipmentState? ShipmentState -

oldShipmentState? ShipmentState -

commercetools.cartsordershoppinglists: OrderShippingAddressSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: OrderShippingAddressSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

address? Address -

oldAddress? Address -

commercetools.cartsordershoppinglists: OrderShippingInfoSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

shippingInfo? ShippingInfo -

oldShippingInfo? ShippingInfo -

commercetools.cartsordershoppinglists: OrderShippingInfoSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

shippingInfo? ShippingInfo -

oldShippingInfo? ShippingInfo -

commercetools.cartsordershoppinglists: OrderShippingRateInputSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

shippingRateInput? ShippingRateInput -

oldShippingRateInput? ShippingRateInput -

commercetools.cartsordershoppinglists: OrderShippingRateInputSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

shippingRateInput? ShippingRateInput -

oldShippingRateInput? ShippingRateInput -

commercetools.cartsordershoppinglists: OrderStateChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

orderState? OrderState -

oldOrderState? OrderState -

commercetools.cartsordershoppinglists: OrderStateChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

orderState? OrderState -

oldOrderState? OrderState -

commercetools.cartsordershoppinglists: OrderStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

state? StateReference -

oldState? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: OrderStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

state? StateReference -

oldState? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: OrderStoreSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

store? StoreKeyReference -

commercetools.cartsordershoppinglists: OrderStoreSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

store? StoreKeyReference -

commercetools.cartsordershoppinglists: OrderTransitionCustomLineItemStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

quantity? int -

fromState? StateResourceIdentifier -

toState? StateResourceIdentifier -

actualTransitionDate? string -

commercetools.cartsordershoppinglists: OrderTransitionLineItemStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

fromState? StateResourceIdentifier -

toState? StateResourceIdentifier -

actualTransitionDate? string -

commercetools.cartsordershoppinglists: OrderTransitionStateAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

state? StateResourceIdentifier -

force? boolean -

commercetools.cartsordershoppinglists: OrderUpdate

Fields

'version? int -

actions? OrderUpdateAction[] -

commercetools.cartsordershoppinglists: OrderUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: OrderUpdateItemShippingAddressAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: OrderUpdateSyncInfoAction

Fields

Fields Included from *OrderUpdateAction

action string
anydata...

action? string -

channel? ChannelResourceIdentifier -

externalId? string -

syncedAt? string -

commercetools.cartsordershoppinglists: OutOfStockError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

lineItems? string[] -

skus? string[] -

commercetools.cartsordershoppinglists: OverCapacityError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: PagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? BaseResource[] -

meta? record {} -

commercetools.cartsordershoppinglists: Parcel

Fields

id? string -

createdAt? string -

measurements? ParcelMeasurements -

trackingData? TrackingData -

items? DeliveryItem[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: ParcelAddedToDeliveryMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

delivery? Delivery -

parcel? Parcel -

commercetools.cartsordershoppinglists: ParcelAddedToDeliveryMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

delivery? Delivery -

parcel? Parcel -

commercetools.cartsordershoppinglists: ParcelDraft

Fields

measurements? ParcelMeasurements -

trackingData? TrackingData -

items? DeliveryItem[] -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: ParcelItemsUpdatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

parcelId? string -

deliveryId? string -

items? DeliveryItem[] -

oldItems? DeliveryItem[] -

commercetools.cartsordershoppinglists: ParcelItemsUpdatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

parcelId? string -

deliveryId? string -

items? DeliveryItem[] -

oldItems? DeliveryItem[] -

commercetools.cartsordershoppinglists: ParcelMeasurements

Fields

heightInMillimeter? decimal -

lengthInMillimeter? decimal -

widthInMillimeter? decimal -

weightInGram? decimal -

commercetools.cartsordershoppinglists: ParcelMeasurementsUpdatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

deliveryId? string -

parcelId? string -

measurements? ParcelMeasurements -

commercetools.cartsordershoppinglists: ParcelMeasurementsUpdatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

deliveryId? string -

parcelId? string -

measurements? ParcelMeasurements -

commercetools.cartsordershoppinglists: ParcelRemovedFromDeliveryMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

deliveryId? string -

parcel? Parcel -

commercetools.cartsordershoppinglists: ParcelRemovedFromDeliveryMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

deliveryId? string -

parcel? Parcel -

commercetools.cartsordershoppinglists: ParcelTrackingDataUpdatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

deliveryId? string -

parcelId? string -

trackingData? TrackingData -

commercetools.cartsordershoppinglists: ParcelTrackingDataUpdatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

deliveryId? string -

parcelId? string -

trackingData? TrackingData -

commercetools.cartsordershoppinglists: PayloadNotIncluded

Fields

reason? string -

payloadType? string -

commercetools.cartsordershoppinglists: Payment

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

customer? CustomerReference -

anonymousId? string -

externalId? string -

interfaceId? string -

amountPlanned? TypedMoney -

amountAuthorized? TypedMoney -

authorizedUntil? string -

amountPaid? TypedMoney -

amountRefunded? TypedMoney -

paymentMethodInfo? PaymentMethodInfo -

paymentStatus? PaymentStatus -

transactions? Transaction[] -

interfaceInteractions? CustomFields[] -

custom? CustomFields -

'key? string -

commercetools.cartsordershoppinglists: PaymentAddInterfaceInteractionAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: PaymentAddTransactionAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

'transaction? TransactionDraft -

commercetools.cartsordershoppinglists: PaymentChangeAmountPlannedAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

amount? Money -

commercetools.cartsordershoppinglists: PaymentChangeTransactionInteractionIdAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

transactionId? string -

interactionId? string -

commercetools.cartsordershoppinglists: PaymentChangeTransactionStateAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

transactionId? string -

state? TransactionState -

commercetools.cartsordershoppinglists: PaymentChangeTransactionTimestampAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

transactionId? string -

timestamp? string -

commercetools.cartsordershoppinglists: PaymentCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

payment? Payment -

commercetools.cartsordershoppinglists: PaymentCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

payment? Payment -

commercetools.cartsordershoppinglists: PaymentDraft

Fields

customer? CustomerResourceIdentifier -

anonymousId? string -

externalId? string -

interfaceId? string -

amountPlanned? Money -

amountAuthorized? Money -

authorizedUntil? string -

amountPaid? Money -

amountRefunded? Money -

paymentMethodInfo? PaymentMethodInfo -

paymentStatus? PaymentStatusDraft -

transactions? TransactionDraft[] -

interfaceInteractions? CustomFieldsDraft[] -

custom? CustomFieldsDraft -

'key? string -

commercetools.cartsordershoppinglists: PaymentInfo

Fields

payments? PaymentReference[] -

commercetools.cartsordershoppinglists: PaymentInteractionAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

interaction? CustomFields -

commercetools.cartsordershoppinglists: PaymentInteractionAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

interaction? CustomFields -

commercetools.cartsordershoppinglists: PaymentMethodInfo

Fields

paymentInterface? string -

method? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: PaymentPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Payment[] -

commercetools.cartsordershoppinglists: PaymentReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Payment -

commercetools.cartsordershoppinglists: PaymentResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: PaymentSetAmountPaidAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

amount? Money -

commercetools.cartsordershoppinglists: PaymentSetAmountRefundedAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

amount? Money -

commercetools.cartsordershoppinglists: PaymentSetAnonymousIdAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

anonymousId? string -

commercetools.cartsordershoppinglists: PaymentSetAuthorizationAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

amount? Money -

until? string -

commercetools.cartsordershoppinglists: PaymentSetCustomerAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

customer? CustomerResourceIdentifier -

commercetools.cartsordershoppinglists: PaymentSetCustomFieldAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: PaymentSetCustomTypeAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: PaymentSetExternalIdAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

externalId? string -

commercetools.cartsordershoppinglists: PaymentSetInterfaceIdAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

interfaceId? string -

commercetools.cartsordershoppinglists: PaymentSetKeyAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: PaymentSetMethodInfoInterfaceAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

interface? string -

commercetools.cartsordershoppinglists: PaymentSetMethodInfoMethodAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

method? string -

commercetools.cartsordershoppinglists: PaymentSetMethodInfoNameAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: PaymentSetStatusInterfaceCodeAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

interfaceCode? string -

commercetools.cartsordershoppinglists: PaymentSetStatusInterfaceTextAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

interfaceText? string -

commercetools.cartsordershoppinglists: PaymentSetTransactionCustomFieldAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

transactionId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: PaymentSetTransactionCustomTypeAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

transactionId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: PaymentStatus

Fields

interfaceCode? string -

interfaceText? string -

state? StateReference -

commercetools.cartsordershoppinglists: PaymentStatusDraft

Fields

interfaceCode? string -

interfaceText? string -

state? StateResourceIdentifier -

commercetools.cartsordershoppinglists: PaymentStatusInterfaceCodeSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

paymentId? string -

interfaceCode? string -

commercetools.cartsordershoppinglists: PaymentStatusInterfaceCodeSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

paymentId? string -

interfaceCode? string -

commercetools.cartsordershoppinglists: PaymentStatusStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

state? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: PaymentStatusStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

state? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: PaymentTransactionAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'transaction? Transaction -

commercetools.cartsordershoppinglists: PaymentTransactionAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

'transaction? Transaction -

commercetools.cartsordershoppinglists: PaymentTransactionStateChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

transactionId? string -

state? TransactionState -

commercetools.cartsordershoppinglists: PaymentTransactionStateChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

transactionId? string -

state? TransactionState -

commercetools.cartsordershoppinglists: PaymentTransitionStateAction

Fields

Fields Included from *PaymentUpdateAction

action string
anydata...

action? string -

state? StateResourceIdentifier -

force? boolean -

commercetools.cartsordershoppinglists: PaymentUpdate

Fields

'version? int -

actions? PaymentUpdateAction[] -

commercetools.cartsordershoppinglists: PaymentUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: PendingOperationError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: Price

Fields

id? string -

value? TypedMoney -

country? CountryCode -

customerGroup? CustomerGroupReference -

channel? ChannelReference -

validFrom? string -

validUntil? string -

discounted? DiscountedPrice -

custom? CustomFields -

tiers? PriceTier[] -

commercetools.cartsordershoppinglists: PriceChangedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

lineItems? string[] -

shipping? boolean -

commercetools.cartsordershoppinglists: PriceDraft

Fields

value? Money -

country? CountryCode -

customerGroup? CustomerGroupResourceIdentifier -

channel? ChannelResourceIdentifier -

validFrom? string -

validUntil? string -

custom? CustomFieldsDraft -

tiers? PriceTierDraft[] -

discounted? DiscountedPriceDraft -

commercetools.cartsordershoppinglists: PriceFunction

Fields

currencyCode? CurrencyCode -

'function? string -

commercetools.cartsordershoppinglists: PriceTier

Fields

minimumQuantity? int -

value? TypedMoney -

commercetools.cartsordershoppinglists: PriceTierDraft

Fields

minimumQuantity? int -

value? Money -

commercetools.cartsordershoppinglists: Product

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

productType? ProductTypeReference -

masterData? ProductCatalogData -

taxCategory? TaxCategoryReference -

state? StateReference -

reviewRatingStatistics? ReviewRatingStatistics -

commercetools.cartsordershoppinglists: ProductAddAssetAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

asset? AssetDraft -

position? int -

commercetools.cartsordershoppinglists: ProductAddedToCategoryMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

category? CategoryReference -

staged? boolean -

commercetools.cartsordershoppinglists: ProductAddedToCategoryMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

category? CategoryReference -

staged? boolean -

commercetools.cartsordershoppinglists: ProductAddExternalImageAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

image? Image -

staged? boolean -

commercetools.cartsordershoppinglists: ProductAddPriceAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

price? PriceDraft -

staged? boolean -

commercetools.cartsordershoppinglists: ProductAddToCategoryAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

category? CategoryResourceIdentifier -

orderHint? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductAddVariantAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

sku? string -

'key? string -

prices? PriceDraft[] -

images? Image[] -

attributes? Attribute[] -

staged? boolean -

assets? Asset[] -

commercetools.cartsordershoppinglists: ProductCatalogData

Fields

published? boolean -

current? ProductData -

staged? ProductData -

hasStagedChanges? boolean -

commercetools.cartsordershoppinglists: ProductChangeAssetNameAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductChangeAssetOrderAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetOrder? string[] -

commercetools.cartsordershoppinglists: ProductChangeMasterVariantAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductChangeNameAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductChangePriceAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

priceId? string -

price? PriceDraft -

staged? boolean -

commercetools.cartsordershoppinglists: ProductChangeSlugAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

slug? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

productProjection? ProductProjection -

commercetools.cartsordershoppinglists: ProductCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

productProjection? ProductProjection -

commercetools.cartsordershoppinglists: ProductData

Fields

name? LocalizedString -

categories? CategoryReference[] -

categoryOrderHints? CategoryOrderHints -

description? LocalizedString -

slug? LocalizedString -

metaTitle? LocalizedString -

metaDescription? LocalizedString -

metaKeywords? LocalizedString -

masterVariant? ProductVariant -

variants? ProductVariant[] -

searchKeywords? SearchKeywords -

commercetools.cartsordershoppinglists: ProductDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

removedImageUrls? string[] -

currentProjection? ProductProjection -

commercetools.cartsordershoppinglists: ProductDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

removedImageUrls? string[] -

currentProjection? ProductProjection -

commercetools.cartsordershoppinglists: ProductDiscount

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

name? LocalizedString -

'key? string -

description? LocalizedString -

value? ProductDiscountValue -

predicate? string -

sortOrder? string -

isActive? boolean -

references? Reference[] -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: ProductDiscountChangeIsActiveAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

isActive? boolean -

commercetools.cartsordershoppinglists: ProductDiscountChangeNameAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductDiscountChangePredicateAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

predicate? string -

commercetools.cartsordershoppinglists: ProductDiscountChangeSortOrderAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

sortOrder? string -

commercetools.cartsordershoppinglists: ProductDiscountChangeValueAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

value? ProductDiscountValueDraft -

commercetools.cartsordershoppinglists: ProductDiscountDraft

Fields

name? LocalizedString -

'key? string -

description? LocalizedString -

value? ProductDiscountValueDraft -

predicate? string -

sortOrder? string -

isActive? boolean -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: ProductDiscountMatchQuery

Fields

productId? string -

variantId? int -

staged? boolean -

price? QueryPrice -

commercetools.cartsordershoppinglists: ProductDiscountPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ProductDiscount[] -

commercetools.cartsordershoppinglists: ProductDiscountReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? ProductDiscount -

commercetools.cartsordershoppinglists: ProductDiscountResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ProductDiscountSetDescriptionAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: ProductDiscountSetKeyAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ProductDiscountSetValidFromAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

validFrom? string -

commercetools.cartsordershoppinglists: ProductDiscountSetValidFromAndUntilAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

validFrom? string -

validUntil? string -

commercetools.cartsordershoppinglists: ProductDiscountSetValidUntilAction

Fields

Fields Included from *ProductDiscountUpdateAction

action string
anydata...

action? string -

validUntil? string -

commercetools.cartsordershoppinglists: ProductDiscountUpdate

Fields

'version? int -

actions? ProductDiscountUpdateAction[] -

commercetools.cartsordershoppinglists: ProductDiscountUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ProductDiscountValue

Fields

'type? string -

commercetools.cartsordershoppinglists: ProductDiscountValueAbsolute

Fields

Fields Included from *ProductDiscountValue

type string
anydata...

'type? string -

money? TypedMoney[] -

commercetools.cartsordershoppinglists: ProductDiscountValueAbsoluteDraft

Fields

Fields Included from *ProductDiscountValueDraft

type string
anydata...

'type? string -

money? Money[] -

commercetools.cartsordershoppinglists: ProductDiscountValueDraft

Fields

'type? string -

commercetools.cartsordershoppinglists: ProductDiscountValueExternal

Fields

Fields Included from *ProductDiscountValue

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: ProductDiscountValueExternalDraft

Fields

Fields Included from *ProductDiscountValueDraft

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: ProductDiscountValueRelative

Fields

Fields Included from *ProductDiscountValue

type string
anydata...

'type? string -

permyriad? int -

commercetools.cartsordershoppinglists: ProductDiscountValueRelativeDraft

Fields

Fields Included from *ProductDiscountValueDraft

type string
anydata...

'type? string -

permyriad? int -

commercetools.cartsordershoppinglists: ProductDraft

Fields

productType? ProductTypeResourceIdentifier -

name? LocalizedString -

slug? LocalizedString -

'key? string -

description? LocalizedString -

categories? CategoryResourceIdentifier[] -

categoryOrderHints? CategoryOrderHints -

metaTitle? LocalizedString -

metaDescription? LocalizedString -

metaKeywords? LocalizedString -

masterVariant? ProductVariantDraft -

variants? ProductVariantDraft[] -

taxCategory? TaxCategoryResourceIdentifier -

searchKeywords? SearchKeywords -

state? StateResourceIdentifier -

publish? boolean -

commercetools.cartsordershoppinglists: ProductImageAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

variantId? int -

image? Image -

staged? boolean -

commercetools.cartsordershoppinglists: ProductImageAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

variantId? int -

image? Image -

staged? boolean -

commercetools.cartsordershoppinglists: ProductLegacySetSkuAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

sku? string -

variantId? int -

commercetools.cartsordershoppinglists: ProductMoveImageToPositionAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

imageUrl? string -

position? int -

staged? boolean -

commercetools.cartsordershoppinglists: ProductPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Product[] -

commercetools.cartsordershoppinglists: ProductPriceDiscountsSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

updatedPrices? ProductPriceDiscountsSetUpdatedPrice[] -

commercetools.cartsordershoppinglists: ProductPriceDiscountsSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

updatedPrices? ProductPriceDiscountsSetUpdatedPrice[] -

commercetools.cartsordershoppinglists: ProductPriceDiscountsSetUpdatedPrice

Fields

variantId? int -

variantKey? string -

sku? string -

priceId? string -

discounted? DiscountedPrice -

staged? boolean -

commercetools.cartsordershoppinglists: ProductPriceExternalDiscountSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

variantId? int -

variantKey? string -

sku? string -

priceId? string -

discounted? DiscountedPrice -

staged? boolean -

commercetools.cartsordershoppinglists: ProductPriceExternalDiscountSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

variantId? int -

variantKey? string -

sku? string -

priceId? string -

discounted? DiscountedPrice -

staged? boolean -

commercetools.cartsordershoppinglists: ProductProjection

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

'key? string -

productType? ProductTypeReference -

name? LocalizedString -

description? LocalizedString -

slug? LocalizedString -

categories? CategoryReference[] -

categoryOrderHints? CategoryOrderHints -

metaTitle? LocalizedString -

metaDescription? LocalizedString -

metaKeywords? LocalizedString -

searchKeywords? SearchKeywords -

hasStagedChanges? boolean -

published? boolean -

masterVariant? ProductVariant -

variants? ProductVariant[] -

taxCategory? TaxCategoryReference -

state? StateReference -

reviewRatingStatistics? ReviewRatingStatistics -

commercetools.cartsordershoppinglists: ProductProjectionPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ProductProjection[] -

commercetools.cartsordershoppinglists: ProductProjectionPagedSearchResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ProductProjection[] -

commercetools.cartsordershoppinglists: ProductPublishAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

scope? ProductPublishScope -

commercetools.cartsordershoppinglists: ProductPublishedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

removedImageUrls? string[] -

productProjection? ProductProjection -

scope? ProductPublishScope -

commercetools.cartsordershoppinglists: ProductPublishedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

removedImageUrls? string[] -

productProjection? ProductProjection -

scope? ProductPublishScope -

commercetools.cartsordershoppinglists: ProductReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Product -

commercetools.cartsordershoppinglists: ProductRemoveAssetAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

commercetools.cartsordershoppinglists: ProductRemovedFromCategoryMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

category? CategoryReference -

staged? boolean -

commercetools.cartsordershoppinglists: ProductRemovedFromCategoryMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

category? CategoryReference -

staged? boolean -

commercetools.cartsordershoppinglists: ProductRemoveFromCategoryAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

category? CategoryResourceIdentifier -

staged? boolean -

commercetools.cartsordershoppinglists: ProductRemoveImageAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

imageUrl? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductRemovePriceAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

priceId? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductRemoveVariantAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

id? int -

sku? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ProductRevertedStagedChangesMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

removedImageUrls? string[] -

commercetools.cartsordershoppinglists: ProductRevertedStagedChangesMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

removedImageUrls? string[] -

commercetools.cartsordershoppinglists: ProductRevertStagedChangesAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

commercetools.cartsordershoppinglists: ProductRevertStagedVariantChangesAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

commercetools.cartsordershoppinglists: ProductSelection

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? LocalizedString -

productCount? int -

'type? ProductSelectionTypeEnum -

commercetools.cartsordershoppinglists: ProductSelectionAddProductAction

Fields

Fields Included from *ProductSelectionUpdateAction

action string
anydata...

action? string -

product? ProductResourceIdentifier -

commercetools.cartsordershoppinglists: ProductSelectionAssignment

Fields

product? ProductReference -

productSelection? ProductSelectionReference -

commercetools.cartsordershoppinglists: ProductSelectionChangeNameAction

Fields

Fields Included from *ProductSelectionUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductSelectionCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

productSelection? ProductSelectionType -

commercetools.cartsordershoppinglists: ProductSelectionCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

productSelection? ProductSelectionType -

commercetools.cartsordershoppinglists: ProductSelectionDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductSelectionDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductSelectionDraft

Fields

'key? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ProductSelectionPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? ProductSelection[] -

commercetools.cartsordershoppinglists: ProductSelectionProductAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

product? ProductReference -

commercetools.cartsordershoppinglists: ProductSelectionProductAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

product? ProductReference -

commercetools.cartsordershoppinglists: ProductSelectionProductPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? AssignedProductReference[] -

commercetools.cartsordershoppinglists: ProductSelectionProductRemovedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

product? ProductReference -

commercetools.cartsordershoppinglists: ProductSelectionProductRemovedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

product? ProductReference -

commercetools.cartsordershoppinglists: ProductSelectionReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? ProductSelection -

commercetools.cartsordershoppinglists: ProductSelectionRemoveProductAction

Fields

Fields Included from *ProductSelectionUpdateAction

action string
anydata...

action? string -

product? ProductResourceIdentifier -

commercetools.cartsordershoppinglists: ProductSelectionResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ProductSelectionSetKeyAction

Fields

Fields Included from *ProductSelectionUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ProductSelectionSetting

Fields

productSelection? ProductSelectionReference -

active? boolean -

commercetools.cartsordershoppinglists: ProductSelectionSettingDraft

Fields

productSelection? ProductSelectionResourceIdentifier -

active? boolean -

commercetools.cartsordershoppinglists: ProductSelectionType

Fields

'type? ProductSelectionTypeEnum -

commercetools.cartsordershoppinglists: ProductSelectionUpdate

Fields

'version? int -

actions? ProductSelectionUpdateAction[] -

commercetools.cartsordershoppinglists: ProductSelectionUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ProductSetAssetCustomFieldAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ProductSetAssetCustomTypeAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: ProductSetAssetDescriptionAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: ProductSetAssetKeyAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

commercetools.cartsordershoppinglists: ProductSetAssetSourcesAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

sources? AssetSource[] -

commercetools.cartsordershoppinglists: ProductSetAssetTagsAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

assetId? string -

assetKey? string -

tags? string[] -

commercetools.cartsordershoppinglists: ProductSetAttributeAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetAttributeInAllVariantsAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetCategoryOrderHintAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

categoryId? string -

orderHint? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetDescriptionAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetDiscountedPriceAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

priceId? string -

staged? boolean -

discounted? DiscountedPriceDraft -

commercetools.cartsordershoppinglists: ProductSetImageLabelAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

sku? string -

variantId? int -

imageUrl? string -

label? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetKeyAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ProductSetMetaDescriptionAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

metaDescription? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetMetaKeywordsAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

metaKeywords? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetMetaTitleAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

metaTitle? LocalizedString -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetPricesAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

prices? PriceDraft[] -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetProductPriceCustomFieldAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

priceId? string -

staged? boolean -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ProductSetProductPriceCustomTypeAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

priceId? string -

staged? boolean -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ProductSetProductVariantKeyAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

'key? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetSearchKeywordsAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

searchKeywords? SearchKeywords -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetSkuAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

variantId? int -

sku? string -

staged? boolean -

commercetools.cartsordershoppinglists: ProductSetTaxCategoryAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

taxCategory? TaxCategoryResourceIdentifier -

commercetools.cartsordershoppinglists: ProductsInStorePagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? ProductSelectionAssignment[] -

commercetools.cartsordershoppinglists: ProductSlugChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

slug? LocalizedString -

oldSlug? LocalizedString -

commercetools.cartsordershoppinglists: ProductSlugChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

slug? LocalizedString -

oldSlug? LocalizedString -

commercetools.cartsordershoppinglists: ProductStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

state? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: ProductStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

state? StateReference -

force? boolean -

commercetools.cartsordershoppinglists: ProductTransitionStateAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

state? StateResourceIdentifier -

force? boolean -

commercetools.cartsordershoppinglists: ProductType

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? string -

description? string -

attributes? AttributeDefinition[] -

commercetools.cartsordershoppinglists: ProductTypeAddAttributeDefinitionAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attribute? AttributeDefinitionDraft -

commercetools.cartsordershoppinglists: ProductTypeAddLocalizedEnumValueAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

value? AttributeLocalizedEnumValue -

commercetools.cartsordershoppinglists: ProductTypeAddPlainEnumValueAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

value? AttributePlainEnumValue -

commercetools.cartsordershoppinglists: ProductTypeChangeAttributeConstraintAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

newValue? AttributeConstraintEnumDraft -

commercetools.cartsordershoppinglists: ProductTypeChangeAttributeNameAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

newAttributeName? string -

commercetools.cartsordershoppinglists: ProductTypeChangeAttributeOrderAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributes? AttributeDefinition[] -

commercetools.cartsordershoppinglists: ProductTypeChangeAttributeOrderByNameAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeNames? string[] -

commercetools.cartsordershoppinglists: ProductTypeChangeDescriptionAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

description? string -

commercetools.cartsordershoppinglists: ProductTypeChangeEnumKeyAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

'key? string -

newKey? string -

commercetools.cartsordershoppinglists: ProductTypeChangeInputHintAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

newValue? TextInputHint -

commercetools.cartsordershoppinglists: ProductTypeChangeIsSearchableAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

isSearchable? boolean -

commercetools.cartsordershoppinglists: ProductTypeChangeLabelAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

label? LocalizedString -

commercetools.cartsordershoppinglists: ProductTypeChangeLocalizedEnumValueLabelAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

newValue? AttributeLocalizedEnumValue -

commercetools.cartsordershoppinglists: ProductTypeChangeLocalizedEnumValueOrderAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

values? AttributeLocalizedEnumValue[] -

commercetools.cartsordershoppinglists: ProductTypeChangeNameAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: ProductTypeChangePlainEnumValueLabelAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

newValue? AttributePlainEnumValue -

commercetools.cartsordershoppinglists: ProductTypeChangePlainEnumValueOrderAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

values? AttributePlainEnumValue[] -

commercetools.cartsordershoppinglists: ProductTypeDraft

Fields

'key? string -

name? string -

description? string -

attributes? AttributeDefinitionDraft[] -

commercetools.cartsordershoppinglists: ProductTypePagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ProductType[] -

commercetools.cartsordershoppinglists: ProductTypeReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? ProductType -

commercetools.cartsordershoppinglists: ProductTypeRemoveAttributeDefinitionAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: ProductTypeRemoveEnumValuesAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

keys? string[] -

commercetools.cartsordershoppinglists: ProductTypeResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ProductTypeSetInputTipAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

attributeName? string -

inputTip? LocalizedString -

commercetools.cartsordershoppinglists: ProductTypeSetKeyAction

Fields

Fields Included from *ProductTypeUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ProductTypeUpdate

Fields

'version? int -

actions? ProductTypeUpdateAction[] -

commercetools.cartsordershoppinglists: ProductTypeUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ProductUnpublishAction

Fields

Fields Included from *ProductUpdateAction

action string
anydata...

action? string -

commercetools.cartsordershoppinglists: ProductUnpublishedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: ProductUnpublishedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: ProductUpdate

Fields

'version? int -

actions? ProductUpdateAction[] -

commercetools.cartsordershoppinglists: ProductUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ProductVariant

Fields

id? int -

sku? string -

'key? string -

prices? Price[] -

attributes? Attribute[] -

price? Price -

images? Image[] -

assets? Asset[] -

availability? ProductVariantAvailability -

isMatchingVariant? boolean -

scopedPrice? ScopedPrice -

scopedPriceDiscounted? boolean -

commercetools.cartsordershoppinglists: ProductVariantAddedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

variant? ProductVariant -

staged? boolean -

commercetools.cartsordershoppinglists: ProductVariantAddedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

variant? ProductVariant -

staged? boolean -

commercetools.cartsordershoppinglists: ProductVariantAvailability

Fields

isOnStock? boolean -

restockableInDays? int -

availableQuantity? int -

channels? ProductVariantChannelAvailabilityMap -

commercetools.cartsordershoppinglists: ProductVariantChannelAvailability

Fields

isOnStock? boolean -

restockableInDays? int -

availableQuantity? int -

commercetools.cartsordershoppinglists: ProductVariantChannelAvailabilityMap

commercetools.cartsordershoppinglists: ProductVariantDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

variant? ProductVariant -

removedImageUrls? string[] -

commercetools.cartsordershoppinglists: ProductVariantDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

variant? ProductVariant -

removedImageUrls? string[] -

commercetools.cartsordershoppinglists: ProductVariantDraft

Fields

sku? string -

'key? string -

prices? PriceDraft[] -

attributes? Attribute[] -

images? Image[] -

assets? AssetDraft[] -

commercetools.cartsordershoppinglists: ProductVariantImportDraft

Fields

id? int -

sku? string -

prices? PriceDraft[] -

attributes? Attribute[] -

images? Image[] -

commercetools.cartsordershoppinglists: Project

Fields

'version? int -

'key? string -

name? string -

countries? CountryCode[] -

currencies? CurrencyCode[] -

languages? Locale[] -

createdAt? string -

trialUntil? string -

messages? MessageConfiguration -

shippingRateInputType? ShippingRateInputType -

externalOAuth? ExternalOAuth -

carts? CartsConfiguration -

searchIndexing? SearchIndexingConfiguration -

shoppingLists? ShoppingListsConfiguration -

commercetools.cartsordershoppinglists: ProjectChangeCartsConfigurationAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

cartsConfiguration? CartsConfiguration -

commercetools.cartsordershoppinglists: ProjectChangeCountriesAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

countries? CountryCode[] -

commercetools.cartsordershoppinglists: ProjectChangeCountryTaxRateFallbackEnabledAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

countryTaxRateFallbackEnabled? boolean -

commercetools.cartsordershoppinglists: ProjectChangeCurrenciesAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

currencies? CurrencyCode[] -

commercetools.cartsordershoppinglists: ProjectChangeLanguagesAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

languages? Locale[] -

commercetools.cartsordershoppinglists: ProjectChangeMessagesConfigurationAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

messagesConfiguration? MessageConfigurationDraft -

commercetools.cartsordershoppinglists: ProjectChangeMessagesEnabledAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

messagesEnabled? boolean -

commercetools.cartsordershoppinglists: ProjectChangeNameAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: ProjectChangeOrderSearchStatusAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

status? OrderSearchStatus -

commercetools.cartsordershoppinglists: ProjectChangeProductSearchIndexingEnabledAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

enabled? boolean -

commercetools.cartsordershoppinglists: ProjectChangeShoppingListsConfigurationAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

shoppingListsConfiguration? ShoppingListsConfiguration -

commercetools.cartsordershoppinglists: ProjectNotConfiguredForLanguagesError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

languages? string[] -

commercetools.cartsordershoppinglists: ProjectSetExternalOAuthAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

externalOAuth? ExternalOAuth -

commercetools.cartsordershoppinglists: ProjectSetShippingRateInputTypeAction

Fields

Fields Included from *ProjectUpdateAction

action string
anydata...

action? string -

shippingRateInputType? ShippingRateInputType -

commercetools.cartsordershoppinglists: ProjectUpdate

Fields

'version? int -

actions? ProjectUpdateAction[] -

commercetools.cartsordershoppinglists: ProjectUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

commercetools.cartsordershoppinglists: QueryComplexityLimitExceededError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: QueryPrice

Fields

id? string -

value? Money -

country? CountryCode -

customerGroup? CustomerGroupReference -

channel? ChannelReference -

validFrom? string -

validUntil? string -

discounted? DiscountedPriceDraft -

custom? CustomFields -

tiers? PriceTierDraft[] -

commercetools.cartsordershoppinglists: QueryTimedOutError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: RangeFacetResult

Fields

Fields Included from *FacetResult

type FacetTypes
anydata...

'type? FacetTypes -

ranges? FacetResultRange[] -

commercetools.cartsordershoppinglists: Reference

Fields

typeId? ReferenceTypeId -

id? string -

commercetools.cartsordershoppinglists: ReferencedResourceNotFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ReferenceExistsError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

referencedBy? ReferenceTypeId -

commercetools.cartsordershoppinglists: ReplicaCartDraft

Fields

reference? string|record {}|string[]|decimal|int|boolean -

'key? string -

commercetools.cartsordershoppinglists: RequiredFieldError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

'field? string -

commercetools.cartsordershoppinglists: ResourceCreatedDelivery

Fields

Fields Included from *SubscriptionDelivery

projectKey string
notificationType string
resource Reference
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

projectKey? string -

notificationType? string -

'resource? Reference -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'version? int -

modifiedAt? string -

commercetools.cartsordershoppinglists: ResourceDeletedDelivery

Fields

Fields Included from *SubscriptionDelivery

projectKey string
notificationType string
resource Reference
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

projectKey? string -

notificationType? string -

'resource? Reference -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'version? int -

modifiedAt? string -

dataErasure? boolean -

commercetools.cartsordershoppinglists: ResourceIdentifier

Fields

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ResourceNotFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ResourceSizeLimitExceededError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ResourceUpdatedDelivery

Fields

Fields Included from *SubscriptionDelivery

projectKey string
notificationType string
resource Reference
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

projectKey? string -

notificationType? string -

'resource? Reference -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

'version? int -

oldVersion? int -

modifiedAt? string -

commercetools.cartsordershoppinglists: ReturnInfo

Fields

items? ReturnItem[] -

returnTrackingId? string -

returnDate? string -

commercetools.cartsordershoppinglists: ReturnInfoDraft

Fields

items? ReturnItemDraft[] -

returnTrackingId? string -

returnDate? string -

commercetools.cartsordershoppinglists: ReturnItem

Fields

id? string -

quantity? int -

'type? string -

comment? string -

shipmentState? ReturnShipmentState -

paymentState? ReturnPaymentState -

custom? CustomFields -

lastModifiedAt? string -

createdAt? string -

commercetools.cartsordershoppinglists: ReturnItemDraft

Fields

quantity? int -

lineItemId? string -

customLineItemId? string -

comment? string -

shipmentState? ReturnShipmentState -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: Review

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

uniquenessValue? string -

locale? string -

authorName? string -

title? string -

text? string -

target? string|record {}|string[]|decimal|int|boolean -

includedInStatistics? boolean -

rating? int -

state? StateReference -

customer? CustomerReference -

custom? CustomFields -

commercetools.cartsordershoppinglists: ReviewCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

review? Review -

commercetools.cartsordershoppinglists: ReviewCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

review? Review -

commercetools.cartsordershoppinglists: ReviewDraft

Fields

'key? string -

uniquenessValue? string -

locale? string -

authorName? string -

title? string -

text? string -

target? string|record {}|string[]|decimal|int|boolean -

state? StateResourceIdentifier -

rating? int -

customer? CustomerResourceIdentifier -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: ReviewPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Review[] -

commercetools.cartsordershoppinglists: ReviewRatingSetMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

oldRating? decimal -

newRating? decimal -

includedInStatistics? boolean -

target? Reference -

commercetools.cartsordershoppinglists: ReviewRatingSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

oldRating? decimal -

newRating? decimal -

includedInStatistics? boolean -

target? Reference -

commercetools.cartsordershoppinglists: ReviewRatingStatistics

Fields

averageRating? decimal -

highestRating? decimal -

lowestRating? decimal -

count? int -

ratingsDistribution? record {} -

commercetools.cartsordershoppinglists: ReviewReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Review -

commercetools.cartsordershoppinglists: ReviewResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ReviewSetAuthorNameAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

authorName? string -

commercetools.cartsordershoppinglists: ReviewSetCustomerAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

customer? CustomerResourceIdentifier -

commercetools.cartsordershoppinglists: ReviewSetCustomFieldAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ReviewSetCustomTypeAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ReviewSetKeyAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ReviewSetLocaleAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: ReviewSetRatingAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

rating? int -

commercetools.cartsordershoppinglists: ReviewSetTargetAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

target? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ReviewSetTextAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

text? string -

commercetools.cartsordershoppinglists: ReviewSetTitleAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

title? string -

commercetools.cartsordershoppinglists: ReviewStateTransitionMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

oldState? StateReference -

newState? StateReference -

oldIncludedInStatistics? boolean -

newIncludedInStatistics? boolean -

target? Reference -

force? boolean -

commercetools.cartsordershoppinglists: ReviewStateTransitionMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

oldState? StateReference -

newState? StateReference -

oldIncludedInStatistics? boolean -

newIncludedInStatistics? boolean -

target? Reference -

force? boolean -

commercetools.cartsordershoppinglists: ReviewTransitionStateAction

Fields

Fields Included from *ReviewUpdateAction

action string
anydata...

action? string -

state? StateResourceIdentifier -

force? boolean -

commercetools.cartsordershoppinglists: ReviewUpdate

Fields

'version? int -

actions? ReviewUpdateAction[] -

commercetools.cartsordershoppinglists: ReviewUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ScopedPrice

Fields

id? string -

value? TypedMoney -

currentValue? TypedMoney -

country? CountryCode -

customerGroup? CustomerGroupReference -

channel? ChannelReference -

validFrom? string -

validUntil? string -

discounted? DiscountedPrice -

custom? CustomFields -

commercetools.cartsordershoppinglists: ScoreShippingRateInput

Fields

Fields Included from *ShippingRateInput

type string
anydata...

'type? string -

score? decimal -

commercetools.cartsordershoppinglists: ScoreShippingRateInputDraft

Fields

Fields Included from *ShippingRateInputDraft

type string
anydata...

'type? string -

score? decimal -

commercetools.cartsordershoppinglists: SearchDeactivatedError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: SearchExecutionFailureError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: SearchFacetPathNotFoundError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: SearchIndexingConfiguration

Fields

products? SearchIndexingConfigurationValues -

orders? SearchIndexingConfigurationValues -

commercetools.cartsordershoppinglists: SearchIndexingConfigurationValues

Fields

status? SearchIndexingConfigurationStatus -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

commercetools.cartsordershoppinglists: SearchIndexingInProgressError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: SearchKeyword

Fields

text? string -

suggestTokenizer? SuggestTokenizer -

commercetools.cartsordershoppinglists: SearchKeywords

commercetools.cartsordershoppinglists: SemanticErrorError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ShippingInfo

Fields

shippingMethodName? string -

price? TypedMoney -

shippingRate? ShippingRate -

taxedPrice? TaxedItemPrice -

taxRate? TaxRate -

taxCategory? TaxCategoryReference -

shippingMethod? ShippingMethodReference -

deliveries? Delivery[] -

discountedPrice? DiscountedLineItemPrice -

shippingMethodState? ShippingMethodState -

commercetools.cartsordershoppinglists: ShippingInfoImportDraft

Fields

shippingMethodName? string -

price? Money -

shippingRate? ShippingRateDraft -

taxRate? TaxRate -

taxCategory? TaxCategoryResourceIdentifier -

shippingMethod? ShippingMethodResourceIdentifier -

deliveries? Delivery[] -

discountedPrice? DiscountedLineItemPriceDraft -

shippingMethodState? ShippingMethodState -

commercetools.cartsordershoppinglists: ShippingMethod

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? string -

localizedName? LocalizedString -

description? string -

localizedDescription? LocalizedString -

taxCategory? TaxCategoryReference -

zoneRates? ZoneRate[] -

isDefault? boolean -

predicate? string -

custom? CustomFields -

commercetools.cartsordershoppinglists: ShippingMethodAddShippingRateAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

zone? ZoneResourceIdentifier -

shippingRate? ShippingRateDraft -

commercetools.cartsordershoppinglists: ShippingMethodAddZoneAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

zone? ZoneResourceIdentifier -

commercetools.cartsordershoppinglists: ShippingMethodChangeIsDefaultAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

isDefault? boolean -

commercetools.cartsordershoppinglists: ShippingMethodChangeNameAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: ShippingMethodChangeTaxCategoryAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

taxCategory? TaxCategoryResourceIdentifier -

commercetools.cartsordershoppinglists: ShippingMethodDoesNotMatchCartError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: ShippingMethodDraft

Fields

'key? string -

name? string -

localizedName? LocalizedString -

description? string -

localizedDescription? LocalizedString -

taxCategory? TaxCategoryResourceIdentifier -

zoneRates? ZoneRateDraft[] -

isDefault? boolean -

predicate? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: ShippingMethodPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ShippingMethod[] -

commercetools.cartsordershoppinglists: ShippingMethodReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? ShippingMethod -

commercetools.cartsordershoppinglists: ShippingMethodRemoveShippingRateAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

zone? ZoneResourceIdentifier -

shippingRate? ShippingRateDraft -

commercetools.cartsordershoppinglists: ShippingMethodRemoveZoneAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

zone? ZoneResourceIdentifier -

commercetools.cartsordershoppinglists: ShippingMethodResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ShippingMethodSetCustomFieldAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ShippingMethodSetCustomTypeAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ShippingMethodSetDescriptionAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

description? string -

commercetools.cartsordershoppinglists: ShippingMethodSetKeyAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ShippingMethodSetLocalizedDescriptionAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

localizedDescription? LocalizedString -

commercetools.cartsordershoppinglists: ShippingMethodSetLocalizedNameAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

localizedName? LocalizedString -

commercetools.cartsordershoppinglists: ShippingMethodSetPredicateAction

Fields

Fields Included from *ShippingMethodUpdateAction

action string
anydata...

action? string -

predicate? string -

commercetools.cartsordershoppinglists: ShippingMethodUpdate

Fields

'version? int -

actions? ShippingMethodUpdateAction[] -

commercetools.cartsordershoppinglists: ShippingMethodUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: ShippingRate

Fields

price? TypedMoney -

freeAbove? TypedMoney -

isMatching? boolean -

tiers? ShippingRatePriceTier[] -

commercetools.cartsordershoppinglists: ShippingRateDraft

Fields

price? Money -

freeAbove? Money -

tiers? ShippingRatePriceTier[] -

commercetools.cartsordershoppinglists: ShippingRateInput

Fields

'type? string -

commercetools.cartsordershoppinglists: ShippingRateInputDraft

Fields

'type? string -

commercetools.cartsordershoppinglists: ShippingRateInputType

Fields

'type? ShippingRateTierType -

commercetools.cartsordershoppinglists: ShippingRatePriceTier

Fields

'type? ShippingRateTierType -

commercetools.cartsordershoppinglists: ShoppingList

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

custom? CustomFields -

customer? CustomerReference -

deleteDaysAfterLastModification? int -

description? LocalizedString -

'key? string -

lineItems? ShoppingListLineItem[] -

name? LocalizedString -

slug? LocalizedString -

textLineItems? TextLineItem[] -

anonymousId? string -

store? StoreKeyReference -

commercetools.cartsordershoppinglists: ShoppingListAddLineItemAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

sku? string -

productId? string -

variantId? int -

quantity? int -

addedAt? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: ShoppingListAddTextLineItemAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

description? LocalizedString -

quantity? int -

addedAt? string -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: ShoppingListChangeLineItemQuantityAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: ShoppingListChangeLineItemsOrderAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

lineItemOrder? string[] -

commercetools.cartsordershoppinglists: ShoppingListChangeNameAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ShoppingListChangeTextLineItemNameAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: ShoppingListChangeTextLineItemQuantityAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: ShoppingListChangeTextLineItemsOrderAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemOrder? string[] -

commercetools.cartsordershoppinglists: ShoppingListDraft

Fields

custom? CustomFieldsDraft -

customer? CustomerResourceIdentifier -

deleteDaysAfterLastModification? int -

description? LocalizedString -

'key? string -

lineItems? ShoppingListLineItemDraft[] -

name? LocalizedString -

slug? LocalizedString -

textLineItems? TextLineItemDraft[] -

anonymousId? string -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: ShoppingListLineItem

Fields

addedAt? string -

custom? CustomFields -

deactivatedAt? string -

id? string -

name? LocalizedString -

productId? string -

productSlug? LocalizedString -

productType? ProductTypeReference -

quantity? int -

variant? ProductVariant -

variantId? int -

commercetools.cartsordershoppinglists: ShoppingListLineItemDraft

Fields

addedAt? string -

custom? CustomFieldsDraft -

sku? string -

productId? string -

quantity? int -

variantId? int -

commercetools.cartsordershoppinglists: ShoppingListPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? ShoppingList[] -

commercetools.cartsordershoppinglists: ShoppingListReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? ShoppingList -

commercetools.cartsordershoppinglists: ShoppingListRemoveLineItemAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: ShoppingListRemoveTextLineItemAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

quantity? int -

commercetools.cartsordershoppinglists: ShoppingListResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ShoppingListsConfiguration

Fields

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: ShoppingListSetAnonymousIdAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

anonymousId? string -

commercetools.cartsordershoppinglists: ShoppingListSetCustomerAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

customer? CustomerResourceIdentifier -

commercetools.cartsordershoppinglists: ShoppingListSetCustomFieldAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ShoppingListSetCustomTypeAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ShoppingListSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

deleteDaysAfterLastModification? int -

commercetools.cartsordershoppinglists: ShoppingListSetDescriptionAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: ShoppingListSetKeyAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ShoppingListSetLineItemCustomFieldAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ShoppingListSetLineItemCustomTypeAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ShoppingListSetSlugAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

slug? LocalizedString -

commercetools.cartsordershoppinglists: ShoppingListSetStoreAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

store? StoreResourceIdentifier -

commercetools.cartsordershoppinglists: ShoppingListSetTextLineItemCustomFieldAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: ShoppingListSetTextLineItemCustomTypeAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: ShoppingListSetTextLineItemDescriptionAction

Fields

Fields Included from *ShoppingListUpdateAction

action string
anydata...

action? string -

textLineItemId? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: ShoppingListStoreSetMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

store? StoreKeyReference -

commercetools.cartsordershoppinglists: ShoppingListUpdate

Fields

'version? int -

actions? ShoppingListUpdateAction[] -

commercetools.cartsordershoppinglists: ShoppingListUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: SnsDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

accessKey? string -

accessSecret? string -

topicArn? string -

commercetools.cartsordershoppinglists: SqsDestination

Fields

Fields Included from *Destination

type string
anydata...

'type? string -

accessKey? string -

accessSecret? string -

queueUrl? string -

region? string -

commercetools.cartsordershoppinglists: StagedOrder

Fields

Fields Included from *Order

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
completedAt string
orderNumber string
customerId string
customerEmail string
anonymousId string
store StoreKeyReference
lineItems LineItem[]
customLineItems CustomLineItem[]
totalPrice TypedMoney
taxedPrice TaxedPrice
shippingAddress Address
billingAddress Address
taxMode TaxMode
taxRoundingMode RoundingMode
customerGroup CustomerGroupReference
country string
orderState OrderState
state StateReference
shipmentState ShipmentState
paymentState PaymentState
shippingInfo ShippingInfo
syncInfo SyncInfo[]
returnInfo ReturnInfo[]
discountCodes DiscountCodeInfo[]
lastMessageSequenceNumber int
cart CartReference
custom CustomFields
paymentInfo PaymentInfo
locale string
inventoryMode InventoryMode
origin CartOrigin
taxCalculationMode TaxCalculationMode
shippingRateInput ShippingRateInput
itemShippingAddresses Address[]
refusedGifts CartDiscountReference[]
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

completedAt? string -

orderNumber? string -

customerId? string -

customerEmail? string -

anonymousId? string -

store? StoreKeyReference -

lineItems? LineItem[] -

customLineItems? CustomLineItem[] -

totalPrice? TypedMoney -

taxedPrice? TaxedPrice -

shippingAddress? Address -

billingAddress? Address -

taxMode? TaxMode -

taxRoundingMode? RoundingMode -

customerGroup? CustomerGroupReference -

country? string -

orderState? OrderState -

state? StateReference -

shipmentState? ShipmentState -

paymentState? PaymentState -

shippingInfo? ShippingInfo -

syncInfo? SyncInfo[] -

returnInfo? ReturnInfo[] -

discountCodes? DiscountCodeInfo[] -

lastMessageSequenceNumber? int -

cart? CartReference -

custom? CustomFields -

paymentInfo? PaymentInfo -

locale? string -

inventoryMode? InventoryMode -

origin? CartOrigin -

taxCalculationMode? TaxCalculationMode -

shippingRateInput? ShippingRateInput -

itemShippingAddresses? Address[] -

refusedGifts? CartDiscountReference[] -

commercetools.cartsordershoppinglists: StagedOrderAddCustomLineItemAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

money? Money -

name? LocalizedString -

quantity? decimal -

slug? string -

taxCategory? TaxCategoryResourceIdentifier -

custom? CustomFieldsDraft -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderAddDeliveryAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

items? DeliveryItem[] -

address? BaseAddress -

parcels? ParcelDraft[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: StagedOrderAddDiscountCodeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

code? string -

commercetools.cartsordershoppinglists: StagedOrderAddItemShippingAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: StagedOrderAddLineItemAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

custom? CustomFieldsDraft -

distributionChannel? ChannelResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

productId? string -

variantId? int -

sku? string -

quantity? decimal -

addedAt? string -

supplyChannel? ChannelResourceIdentifier -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: StagedOrderAddParcelToDeliveryAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

measurements? ParcelMeasurements -

trackingData? TrackingData -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: StagedOrderAddPaymentAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: StagedOrderAddReturnInfoAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

returnTrackingId? string -

items? ReturnItemDraft[] -

returnDate? string -

commercetools.cartsordershoppinglists: StagedOrderAddShoppingListAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

shoppingList? ShoppingListResourceIdentifier -

supplyChannel? ChannelResourceIdentifier -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StagedOrderChangeCustomLineItemMoneyAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

money? Money -

commercetools.cartsordershoppinglists: StagedOrderChangeCustomLineItemQuantityAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

quantity? decimal -

commercetools.cartsordershoppinglists: StagedOrderChangeLineItemQuantityAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? decimal -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

commercetools.cartsordershoppinglists: StagedOrderChangeOrderStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

orderState? OrderState -

commercetools.cartsordershoppinglists: StagedOrderChangePaymentStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

paymentState? PaymentState -

commercetools.cartsordershoppinglists: StagedOrderChangeShipmentStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

shipmentState? ShipmentState -

commercetools.cartsordershoppinglists: StagedOrderChangeTaxCalculationModeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

taxCalculationMode? TaxCalculationMode -

commercetools.cartsordershoppinglists: StagedOrderChangeTaxModeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

taxMode? TaxMode -

commercetools.cartsordershoppinglists: StagedOrderChangeTaxRoundingModeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

taxRoundingMode? RoundingMode -

commercetools.cartsordershoppinglists: StagedOrderImportCustomLineItemStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

state? ItemState[] -

commercetools.cartsordershoppinglists: StagedOrderImportLineItemStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

state? ItemState[] -

commercetools.cartsordershoppinglists: StagedOrderRemoveCustomLineItemAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

commercetools.cartsordershoppinglists: StagedOrderRemoveDeliveryAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

commercetools.cartsordershoppinglists: StagedOrderRemoveDiscountCodeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

discountCode? DiscountCodeReference -

commercetools.cartsordershoppinglists: StagedOrderRemoveItemShippingAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

commercetools.cartsordershoppinglists: StagedOrderRemoveLineItemAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? decimal -

externalPrice? Money -

externalTotalPrice? ExternalLineItemTotalPrice -

shippingDetailsToRemove? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: StagedOrderRemoveParcelFromDeliveryAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

commercetools.cartsordershoppinglists: StagedOrderRemovePaymentAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

payment? PaymentResourceIdentifier -

commercetools.cartsordershoppinglists: StagedOrderSetBillingAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: StagedOrderSetBillingAddressCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetBillingAddressCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetCountryAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

country? string -

commercetools.cartsordershoppinglists: StagedOrderSetCustomerEmailAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

email? string -

commercetools.cartsordershoppinglists: StagedOrderSetCustomerGroupAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customerGroup? CustomerGroupResourceIdentifier -

commercetools.cartsordershoppinglists: StagedOrderSetCustomerIdAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customerId? string -

commercetools.cartsordershoppinglists: StagedOrderSetCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetCustomLineItemCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetCustomLineItemCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetCustomLineItemShippingDetailsAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: StagedOrderSetCustomLineItemTaxAmountAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: StagedOrderSetCustomLineItemTaxRateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetCustomShippingMethodAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

shippingMethodName? string -

shippingRate? ShippingRateDraft -

taxCategory? TaxCategoryResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryAddressCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryAddressCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: StagedOrderSetDeliveryItemsAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

deliveryId? string -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: StagedOrderSetItemShippingAddressCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetItemShippingAddressCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

addressKey? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemDistributionChannelAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemPriceAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalPrice? Money -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemShippingDetailsAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

shippingDetails? ItemShippingDetailsDraft -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemTaxAmountAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemTaxRateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetLineItemTotalPriceAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

externalTotalPrice? ExternalLineItemTotalPrice -

commercetools.cartsordershoppinglists: StagedOrderSetLocaleAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

locale? string -

commercetools.cartsordershoppinglists: StagedOrderSetOrderNumberAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

orderNumber? string -

commercetools.cartsordershoppinglists: StagedOrderSetOrderTotalTaxAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

externalTotalGross? Money -

externalTaxPortions? TaxPortionDraft[] -

commercetools.cartsordershoppinglists: StagedOrderSetParcelCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetParcelCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: StagedOrderSetParcelItemsAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

items? DeliveryItem[] -

commercetools.cartsordershoppinglists: StagedOrderSetParcelMeasurementsAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

measurements? ParcelMeasurements -

commercetools.cartsordershoppinglists: StagedOrderSetParcelTrackingDataAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

parcelId? string -

trackingData? TrackingData -

commercetools.cartsordershoppinglists: StagedOrderSetReturnInfoAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

items? ReturnInfoDraft[] -

commercetools.cartsordershoppinglists: StagedOrderSetReturnItemCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetReturnItemCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: StagedOrderSetReturnPaymentStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

paymentState? ReturnPaymentState -

commercetools.cartsordershoppinglists: StagedOrderSetReturnShipmentStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

returnItemId? string -

shipmentState? ReturnShipmentState -

commercetools.cartsordershoppinglists: StagedOrderSetShippingAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: StagedOrderSetShippingAddressAndCustomShippingMethodAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

shippingMethodName? string -

shippingRate? ShippingRateDraft -

taxCategory? TaxCategoryResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetShippingAddressAndShippingMethodAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

shippingMethod? ShippingMethodResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetShippingAddressCustomFieldAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StagedOrderSetShippingAddressCustomTypeAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? FieldContainer -

commercetools.cartsordershoppinglists: StagedOrderSetShippingMethodAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

shippingMethod? ShippingMethodResourceIdentifier -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetShippingMethodTaxAmountAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

externalTaxAmount? ExternalTaxAmountDraft -

commercetools.cartsordershoppinglists: StagedOrderSetShippingMethodTaxRateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

externalTaxRate? ExternalTaxRateDraft -

commercetools.cartsordershoppinglists: StagedOrderSetShippingRateInputAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

shippingRateInput? ShippingRateInputDraft -

commercetools.cartsordershoppinglists: StagedOrderTransitionCustomLineItemStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

customLineItemId? string -

quantity? int -

fromState? StateResourceIdentifier -

toState? StateResourceIdentifier -

actualTransitionDate? string -

commercetools.cartsordershoppinglists: StagedOrderTransitionLineItemStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

lineItemId? string -

quantity? int -

fromState? StateResourceIdentifier -

toState? StateResourceIdentifier -

actualTransitionDate? string -

commercetools.cartsordershoppinglists: StagedOrderTransitionStateAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

state? StateResourceIdentifier -

force? boolean -

commercetools.cartsordershoppinglists: StagedOrderUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: StagedOrderUpdateItemShippingAddressAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

address? BaseAddress -

commercetools.cartsordershoppinglists: StagedOrderUpdateSyncInfoAction

Fields

Fields Included from *StagedOrderUpdateAction

action string
anydata...

action? string -

channel? ChannelResourceIdentifier -

externalId? string -

syncedAt? string -

commercetools.cartsordershoppinglists: State

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

'type? StateTypeEnum -

name? LocalizedString -

description? LocalizedString -

initial? boolean -

builtIn? boolean -

roles? StateRoleEnum[] -

transitions? StateReference[] -

commercetools.cartsordershoppinglists: StateAddRolesAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

roles? StateRoleEnum[] -

commercetools.cartsordershoppinglists: StateChangeInitialAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

initial? boolean -

commercetools.cartsordershoppinglists: StateChangeKeyAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: StateChangeTypeAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

'type? StateTypeEnum -

commercetools.cartsordershoppinglists: StateDraft

Fields

'key? string -

'type? StateTypeEnum -

name? LocalizedString -

description? LocalizedString -

initial? boolean -

roles? StateRoleEnum[] -

transitions? StateResourceIdentifier[] -

commercetools.cartsordershoppinglists: StatePagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? State[] -

commercetools.cartsordershoppinglists: StateReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? State -

commercetools.cartsordershoppinglists: StateRemoveRolesAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

roles? StateRoleEnum[] -

commercetools.cartsordershoppinglists: StateResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: StateSetDescriptionAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: StateSetNameAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: StateSetRolesAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

roles? StateRoleEnum[] -

commercetools.cartsordershoppinglists: StateSetTransitionsAction

Fields

Fields Included from *StateUpdateAction

action string
anydata...

action? string -

transitions? StateResourceIdentifier[] -

commercetools.cartsordershoppinglists: StateUpdate

Fields

'version? int -

actions? StateUpdateAction[] -

commercetools.cartsordershoppinglists: StateUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: Store

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? LocalizedString -

languages? string[] -

distributionChannels? ChannelReference[] -

supplyChannels? ChannelReference[] -

productSelections? ProductSelectionSetting[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: StoreAddDistributionChannelAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StoreAddProductSelectionAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

productSelection? ProductSelectionSettingDraft -

commercetools.cartsordershoppinglists: StoreAddSupplyChannelAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

supplyChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StoreChangeProductSelectionAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

productSelection? ResourceIdentifier -

active? boolean -

commercetools.cartsordershoppinglists: StoreCreatedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

name? LocalizedString -

languages? string[] -

distributionChannels? ChannelReference[] -

supplyChannels? ChannelReference[] -

productSelections? ProductSelectionSetting[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: StoreCreatedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

name? LocalizedString -

languages? string[] -

distributionChannels? ChannelReference[] -

supplyChannels? ChannelReference[] -

productSelections? ProductSelectionSetting[] -

custom? CustomFields -

commercetools.cartsordershoppinglists: StoreDeletedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: StoreDeletedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: StoreDraft

Fields

'key? string -

name? LocalizedString -

languages? string[] -

distributionChannels? ChannelResourceIdentifier[] -

supplyChannels? ChannelResourceIdentifier[] -

productSelections? ProductSelectionSettingDraft[] -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: StoreKeyReference

Fields

Fields Included from *KeyReference

typeId ReferenceTypeId
key string
anydata...

typeId? ReferenceTypeId -

'key? string -

commercetools.cartsordershoppinglists: StorePagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Store[] -

commercetools.cartsordershoppinglists: StoreProductSelectionsChangedMessage

Fields

Fields Included from *Message

id string
version int
createdAt string
lastModifiedAt string
lastModifiedBy LastModifiedBy
createdBy CreatedBy
sequenceNumber int
resource Reference
resourceVersion int
type string
resourceUserProvidedIdentifiers UserProvidedIdentifiers
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

sequenceNumber? int -

'resource? Reference -

resourceVersion? int -

'type? string -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

addedProductSelections? ProductSelectionSetting[] -

removedProductSelections? ProductSelectionSetting[] -

updatedProductSelections? ProductSelectionSetting[] -

commercetools.cartsordershoppinglists: StoreProductSelectionsChangedMessagePayload

Fields

Fields Included from *MessagePayload

type string
anydata...

'type? string -

addedProductSelections? ProductSelectionSetting[] -

removedProductSelections? ProductSelectionSetting[] -

updatedProductSelections? ProductSelectionSetting[] -

commercetools.cartsordershoppinglists: StoreReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Store -

commercetools.cartsordershoppinglists: StoreRemoveDistributionChannelAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

distributionChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StoreRemoveProductSelectionAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

productSelection? ResourceIdentifier -

commercetools.cartsordershoppinglists: StoreRemoveSupplyChannelAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

supplyChannel? ChannelResourceIdentifier -

commercetools.cartsordershoppinglists: StoreResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: StoreSetCustomFieldAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

name? string -

value? string|record {}|string[]|decimal|int|boolean -

commercetools.cartsordershoppinglists: StoreSetCustomTypeAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

'type? TypeResourceIdentifier -

fields? record {} -

commercetools.cartsordershoppinglists: StoreSetDistributionChannelsAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

distributionChannels? ChannelResourceIdentifier[] -

commercetools.cartsordershoppinglists: StoreSetLanguagesAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

languages? string[] -

commercetools.cartsordershoppinglists: StoreSetNameAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: StoreSetProductSelectionsAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

productSelections? ProductSelectionSettingDraft[] -

commercetools.cartsordershoppinglists: StoreSetSupplyChannelsAction

Fields

Fields Included from *StoreUpdateAction

action string
anydata...

action? string -

supplyChannels? ChannelResourceIdentifier[] -

commercetools.cartsordershoppinglists: StoreUpdate

Fields

'version? int -

actions? StoreUpdateAction[] -

commercetools.cartsordershoppinglists: StoreUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: SubRate

Fields

name? string -

amount? decimal -

commercetools.cartsordershoppinglists: Subscription

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

changes? ChangeSubscription[] -

destination? Destination -

'key? string -

messages? MessageSubscription[] -

format? DeliveryFormat -

status? SubscriptionHealthStatus -

commercetools.cartsordershoppinglists: SubscriptionChangeDestinationAction

Fields

Fields Included from *SubscriptionUpdateAction

action string
anydata...

action? string -

destination? Destination -

commercetools.cartsordershoppinglists: SubscriptionDelivery

Fields

projectKey? string -

notificationType? string -

'resource? Reference -

resourceUserProvidedIdentifiers? UserProvidedIdentifiers -

commercetools.cartsordershoppinglists: SubscriptionDraft

Fields

changes? ChangeSubscription[] -

destination? Destination -

'key? string -

messages? MessageSubscription[] -

format? DeliveryFormat -

commercetools.cartsordershoppinglists: SubscriptionPagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Subscription[] -

commercetools.cartsordershoppinglists: SubscriptionSetChangesAction

Fields

Fields Included from *SubscriptionUpdateAction

action string
anydata...

action? string -

changes? ChangeSubscription[] -

commercetools.cartsordershoppinglists: SubscriptionSetKeyAction

Fields

Fields Included from *SubscriptionUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: SubscriptionSetMessagesAction

Fields

Fields Included from *SubscriptionUpdateAction

action string
anydata...

action? string -

messages? MessageSubscription[] -

commercetools.cartsordershoppinglists: SubscriptionUpdate

Fields

'version? int -

actions? SubscriptionUpdateAction[] -

commercetools.cartsordershoppinglists: SubscriptionUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: Suggestion

Fields

text? string -

commercetools.cartsordershoppinglists: SuggestionResult

commercetools.cartsordershoppinglists: SuggestTokenizer

Fields

'type? string -

commercetools.cartsordershoppinglists: SyncInfo

Fields

channel? ChannelReference -

externalId? string -

syncedAt? string -

commercetools.cartsordershoppinglists: SyntaxErrorError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: TaxCategory

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

name? string -

description? string -

rates? TaxRate[] -

'key? string -

commercetools.cartsordershoppinglists: TaxCategoryAddTaxRateAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

taxRate? TaxRateDraft -

commercetools.cartsordershoppinglists: TaxCategoryChangeNameAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: TaxCategoryDraft

Fields

name? string -

description? string -

rates? TaxRateDraft[] -

'key? string -

commercetools.cartsordershoppinglists: TaxCategoryPagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? TaxCategory[] -

commercetools.cartsordershoppinglists: TaxCategoryReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? TaxCategory -

commercetools.cartsordershoppinglists: TaxCategoryRemoveTaxRateAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

taxRateId? string -

commercetools.cartsordershoppinglists: TaxCategoryReplaceTaxRateAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

taxRateId? string -

taxRate? TaxRateDraft -

commercetools.cartsordershoppinglists: TaxCategoryResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: TaxCategorySetDescriptionAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

description? string -

commercetools.cartsordershoppinglists: TaxCategorySetKeyAction

Fields

Fields Included from *TaxCategoryUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: TaxCategoryUpdate

Fields

'version? int -

actions? TaxCategoryUpdateAction[] -

commercetools.cartsordershoppinglists: TaxCategoryUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: TaxedItemPrice

Fields

totalNet? TypedMoney -

totalGross? TypedMoney -

commercetools.cartsordershoppinglists: TaxedItemPriceDraft

Fields

totalNet? Money -

totalGross? Money -

commercetools.cartsordershoppinglists: TaxedPrice

Fields

totalNet? TypedMoney -

totalGross? TypedMoney -

taxPortions? TaxPortion[] -

commercetools.cartsordershoppinglists: TaxedPriceDraft

Fields

totalNet? Money -

totalGross? Money -

taxPortions? TaxPortionDraft[] -

commercetools.cartsordershoppinglists: TaxPortion

Fields

name? string -

rate? decimal -

amount? TypedMoney -

commercetools.cartsordershoppinglists: TaxPortionDraft

Fields

name? string -

rate? decimal -

amount? Money -

commercetools.cartsordershoppinglists: TaxRate

Fields

id? string -

name? string -

amount? decimal -

includedInPrice? boolean -

country? CountryCode -

state? string -

subRates? SubRate[] -

commercetools.cartsordershoppinglists: TaxRateDraft

Fields

name? string -

amount? decimal -

includedInPrice? boolean -

country? CountryCode -

state? string -

subRates? SubRate[] -

commercetools.cartsordershoppinglists: TermFacetResult

Fields

Fields Included from *FacetResult

type FacetTypes
anydata...

'type? FacetTypes -

dataType? TermFacetResultType -

missing? int -

total? int -

other? int -

terms? FacetResultTerm[] -

commercetools.cartsordershoppinglists: TextLineItem

Fields

addedAt? string -

custom? CustomFields -

description? LocalizedString -

id? string -

name? LocalizedString -

quantity? int -

commercetools.cartsordershoppinglists: TextLineItemDraft

Fields

addedAt? string -

custom? CustomFieldsDraft -

description? LocalizedString -

name? LocalizedString -

quantity? int -

commercetools.cartsordershoppinglists: TrackingData

Fields

trackingId? string -

carrier? string -

provider? string -

providerTransaction? string -

isReturn? boolean -

commercetools.cartsordershoppinglists: Transaction

Fields

id? string -

timestamp? string -

'type? TransactionType -

amount? TypedMoney -

interactionId? string -

state? TransactionState -

custom? CustomFields -

commercetools.cartsordershoppinglists: TransactionDraft

Fields

timestamp? string -

'type? TransactionType -

amount? Money -

interactionId? string -

state? TransactionState -

custom? CustomFieldsDraft -

commercetools.cartsordershoppinglists: Type

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? LocalizedString -

description? LocalizedString -

resourceTypeIds? ResourceTypeId[] -

fieldDefinitions? FieldDefinition[] -

commercetools.cartsordershoppinglists: TypeAddEnumValueAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

value? CustomFieldEnumValue -

commercetools.cartsordershoppinglists: TypeAddFieldDefinitionAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldDefinition? FieldDefinition -

commercetools.cartsordershoppinglists: TypeAddLocalizedEnumValueAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

value? CustomFieldLocalizedEnumValue -

commercetools.cartsordershoppinglists: TypeChangeEnumValueLabelAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

value? CustomFieldEnumValue -

commercetools.cartsordershoppinglists: TypeChangeEnumValueOrderAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

keys? string[] -

commercetools.cartsordershoppinglists: TypeChangeFieldDefinitionOrderAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldNames? string[] -

commercetools.cartsordershoppinglists: TypeChangeInputHintAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

inputHint? TypeTextInputHint -

commercetools.cartsordershoppinglists: TypeChangeKeyAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: TypeChangeLabelAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

label? LocalizedString -

commercetools.cartsordershoppinglists: TypeChangeLocalizedEnumValueLabelAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

value? CustomFieldLocalizedEnumValue -

commercetools.cartsordershoppinglists: TypeChangeLocalizedEnumValueOrderAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

keys? string[] -

commercetools.cartsordershoppinglists: TypeChangeNameAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

name? LocalizedString -

commercetools.cartsordershoppinglists: TypedMoney

Fields

'type? MoneyType -

fractionDigits? int -

centAmount? int -

currencyCode? CurrencyCode -

commercetools.cartsordershoppinglists: TypedMoneyDraft

Fields

Fields Included from *Money

centAmount int
currencyCode CurrencyCode
anydata...

centAmount? int -

currencyCode? CurrencyCode -

'type? MoneyType -

fractionDigits? int -

commercetools.cartsordershoppinglists: TypeDraft

Fields

'key? string -

name? LocalizedString -

description? LocalizedString -

resourceTypeIds? ResourceTypeId[] -

fieldDefinitions? FieldDefinition[] -

commercetools.cartsordershoppinglists: TypePagedQueryResponse

Fields

'limit? int -

count? int -

total? int -

offset? int -

results? Type[] -

commercetools.cartsordershoppinglists: TypeReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Type -

commercetools.cartsordershoppinglists: TypeRemoveFieldDefinitionAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

fieldName? string -

commercetools.cartsordershoppinglists: TypeResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: TypeSetDescriptionAction

Fields

Fields Included from *TypeUpdateAction

action string
anydata...

action? string -

description? LocalizedString -

commercetools.cartsordershoppinglists: TypeUpdate

Fields

'version? int -

actions? TypeUpdateAction[] -

commercetools.cartsordershoppinglists: TypeUpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: Update

Fields

'version? int -

actions? UpdateAction[] -

commercetools.cartsordershoppinglists: UpdateAction

Fields

action? string -

commercetools.cartsordershoppinglists: URLEncodedPayload

commercetools.cartsordershoppinglists: UserProvidedIdentifiers

Fields

'key? string -

externalId? string -

orderNumber? string -

customerNumber? string -

sku? string -

slug? LocalizedString -

containerAndKey? ContainerAndKey -

commercetools.cartsordershoppinglists: VariantValues

Fields

sku? string -

prices? PriceDraft[] -

attributes? Attribute[] -

commercetools.cartsordershoppinglists: WeakPasswordError

Fields

Fields Included from *ErrorObject

code string
message string
anydata...

code? string -

message? string -

commercetools.cartsordershoppinglists: WhitespaceTokenizer

Fields

Fields Included from *SuggestTokenizer

type string
anydata...

'type? string -

commercetools.cartsordershoppinglists: Zone

Fields

Fields Included from *BaseResource

id string
version int
createdAt string
lastModifiedAt string
anydata...

id? string -

'version? int -

createdAt? string -

lastModifiedAt? string -

lastModifiedBy? LastModifiedBy -

createdBy? CreatedBy -

'key? string -

name? string -

description? string -

locations? Location[] -

commercetools.cartsordershoppinglists: ZoneAddLocationAction

Fields

Fields Included from *ZoneUpdateAction

action string
anydata...

action? string -

location? Location -

commercetools.cartsordershoppinglists: ZoneChangeNameAction

Fields

Fields Included from *ZoneUpdateAction

action string
anydata...

action? string -

name? string -

commercetools.cartsordershoppinglists: ZoneDraft

Fields

'key? string -

name? string -

description? string -

locations? Location[] -

commercetools.cartsordershoppinglists: ZonePagedQueryResponse

Fields

'limit? int -

offset? int -

count? int -

total? int -

results? Zone[] -

commercetools.cartsordershoppinglists: ZoneRate

Fields

zone? ZoneReference -

shippingRates? ShippingRate[] -

commercetools.cartsordershoppinglists: ZoneRateDraft

Fields

zone? ZoneResourceIdentifier -

shippingRates? ShippingRateDraft[] -

commercetools.cartsordershoppinglists: ZoneReference

Fields

Fields Included from *Reference

typeId ReferenceTypeId
id string
anydata...

typeId? ReferenceTypeId -

id? string -

obj? Zone -

commercetools.cartsordershoppinglists: ZoneRemoveLocationAction

Fields

Fields Included from *ZoneUpdateAction

action string
anydata...

action? string -

location? Location -

commercetools.cartsordershoppinglists: ZoneResourceIdentifier

Fields

Fields Included from *ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId? ReferenceTypeId -

id? string -

'key? string -

commercetools.cartsordershoppinglists: ZoneSetDescriptionAction

Fields

Fields Included from *ZoneUpdateAction

action string
anydata...

action? string -

description? string -

commercetools.cartsordershoppinglists: ZoneSetKeyAction

Fields

Fields Included from *ZoneUpdateAction

action string
anydata...

action? string -

'key? string -

commercetools.cartsordershoppinglists: ZoneUpdate

Fields

'version? int -

actions? ZoneUpdateAction[] -

commercetools.cartsordershoppinglists: ZoneUpdateAction

Fields

action? string -

Union types

commercetools.cartsordershoppinglists: AttributeValue

string|record {}|string[]|decimal|int|boolean

AttributeValue

String types

commercetools.cartsordershoppinglists: CurrencyCode

string

CurrencyCode

commercetools.cartsordershoppinglists: ResourceTypeId

string

ResourceTypeId

commercetools.cartsordershoppinglists: TaxMode

string

TaxMode

commercetools.cartsordershoppinglists: QueryPredicate

string

QueryPredicate

commercetools.cartsordershoppinglists: DiscountCodeState

string

DiscountCodeState

commercetools.cartsordershoppinglists: OrderSearchQuery

string

OrderSearchQuery

commercetools.cartsordershoppinglists: LineItemMode

string

LineItemMode

commercetools.cartsordershoppinglists: ProductPublishScope

string

ProductPublishScope

commercetools.cartsordershoppinglists: TransactionType

string

TransactionType

commercetools.cartsordershoppinglists: OrderState

string

OrderState

commercetools.cartsordershoppinglists: OrderSearchSorting

string

OrderSearchSorting

commercetools.cartsordershoppinglists: TaxCalculationMode

string

TaxCalculationMode

commercetools.cartsordershoppinglists: Sort

string

Sort

commercetools.cartsordershoppinglists: PaymentState

string

PaymentState

commercetools.cartsordershoppinglists: StateRoleEnum

string

StateRoleEnum

commercetools.cartsordershoppinglists: ReferenceTypeId

string

ReferenceTypeId

commercetools.cartsordershoppinglists: AnonymousCartSignInMode

string

AnonymousCartSignInMode

commercetools.cartsordershoppinglists: ExtensionResourceTypeId

string

ExtensionResourceTypeId

commercetools.cartsordershoppinglists: SubscriptionHealthStatus

string

SubscriptionHealthStatus

commercetools.cartsordershoppinglists: ShippingRateTierType

string

ShippingRateTierType

commercetools.cartsordershoppinglists: MoneyType

string

MoneyType

commercetools.cartsordershoppinglists: ShippingMethodState

string

ShippingMethodState

commercetools.cartsordershoppinglists: TermFacetResultType

string

TermFacetResultType

commercetools.cartsordershoppinglists: TransactionState

string

TransactionState

commercetools.cartsordershoppinglists: AttributeConstraintEnumDraft

string

AttributeConstraintEnumDraft

commercetools.cartsordershoppinglists: SearchIndexingConfigurationStatus

string

SearchIndexingConfigurationStatus

commercetools.cartsordershoppinglists: LineItemPriceMode

string

LineItemPriceMode

commercetools.cartsordershoppinglists: ProductSelectionTypeEnum

string

ProductSelectionTypeEnum

commercetools.cartsordershoppinglists: RoundingMode

string

RoundingMode

commercetools.cartsordershoppinglists: ShipmentState

string

ShipmentState

commercetools.cartsordershoppinglists: ChannelRoleEnum

string

ChannelRoleEnum

commercetools.cartsordershoppinglists: Expansion

string

Expansion

commercetools.cartsordershoppinglists: AttributeConstraintEnum

string

AttributeConstraintEnum

commercetools.cartsordershoppinglists: InventoryMode

string

InventoryMode

commercetools.cartsordershoppinglists: SelectionMode

string

SelectionMode

commercetools.cartsordershoppinglists: ExtensionAction

string

ExtensionAction

commercetools.cartsordershoppinglists: Locale

string

Locale

commercetools.cartsordershoppinglists: StateTypeEnum

string

StateTypeEnum

commercetools.cartsordershoppinglists: CountryCode

string

CountryCode

commercetools.cartsordershoppinglists: ReturnPaymentState

string

ReturnPaymentState

commercetools.cartsordershoppinglists: CartState

string

CartState

commercetools.cartsordershoppinglists: TypeTextInputHint

string

TypeTextInputHint

commercetools.cartsordershoppinglists: FacetTypes

string

FacetTypes

commercetools.cartsordershoppinglists: StackingMode

string

StackingMode

commercetools.cartsordershoppinglists: OrderSearchStatus

string

OrderSearchStatus

commercetools.cartsordershoppinglists: TextInputHint

string

TextInputHint

commercetools.cartsordershoppinglists: ReturnShipmentState

string

ReturnShipmentState

commercetools.cartsordershoppinglists: CartOrigin

string

CartOrigin

Import

import ballerinax/commercetools.cartsordershoppinglists;

Other versions

1.4.2

1.4.1 1.4.0 1.3.0

Metadata

Released date: 14 days ago

Version: 1.4.2

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.8.0

GraalVM compatible: Yes

Pull count

Total: 36

Current verison: 1

Weekly downloads

Source repository

Keywords

Type/Connector

Vendor/commercetools

Area/E-Commerce

Commerce/eCommerce

Cost/Paid

Contributors

Dependencies

ballerina/url/2.4.0 ballerina/http/2.10.24

Cookie policy

Delete policy

clients

records

unionTypes

stringTypes

ballerinax/commercetools.cartsordershoppinglists Ballerina library

Overview

Key Features

Prerequisites

Clients

commercetools.cartsordershoppinglists: Client

Constructor

getShoppingListByID

Parameters

Return Type

updateShoppingListByID

Parameters

Return Type

deleteShoppingListByID

Parameters

Return Type

getShoppingListByKey

Parameters

Return Type

updateShoppingListByKey

Parameters

Return Type

deleteShoppingListByKey

Parameters

Return Type

getShoppingListInStoreByID

Parameters

Return Type

updateShoppingListInStoreByID

Parameters

Return Type

deleteShoppingListInStoreByID

Parameters

Return Type

getShoppingListInStoreByKey

Parameters

Return Type

updateShoppingListInStoreByKey

Parameters

Return Type

deleteShoppingListInStoreByKey

Parameters

Return Type

queryShoppingListInStore

Parameters

Return Type

createShoppingListInStore

Parameters

Return Type

getMyShoppingListByID

Parameters

Return Type

updateMyShoppingListByID

Parameters

Return Type

deleteMyShoppingListByID

Parameters

Return Type

getMyShoppingListInStoreByID

Parameters

Return Type

updateMyShoppingListInStoreByID

Parameters

Return Type

deleteMyShoppingListInStoreByID

Parameters

Return Type

getMyShoppingListByKey

Parameters

Return Type

updateMyShoppingListByKey

Parameters

Return Type

deleteMyShoppingListByKey

Parameters

Return Type