Module commercetools.productcatalog

ballerinax/commercetools.productcatalog Ballerina library

1.4.1

Overview

This is a generated connector for Commercetools API v1 OpenAPI specification.

The commercetools Platform HTTP API(Product Catalog) offers an interface for programmatic access to retrieve certain information on product catalog.

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.productcatalog: Client

Isolated

This is a generated connector for Commercetools API v1 OpenAPI specification. The commercetools Platform HTTP API(Product Catalog) offers an interface for programmatic access to the data stored on the platform and associated functionality for product catalogs.

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

getCategoryByID

Isolated FunctionRemote Function

function getCategoryByID(string projectKey, string id, Expansion[]? expand) returns Category|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

updateCategoryByID

Isolated FunctionRemote Function

function updateCategoryByID(string projectKey, string id, CategoryUpdate payload, Expansion[]? expand) returns Category|error

Parameters

projectKey string -

id string -

payload CategoryUpdate -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

deleteCategoryByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

queryCategory

Isolated FunctionRemote Function

function queryCategory(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns CategoryPagedQueryResponse|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

CategoryPagedQueryResponse|error - 200

createCategory

Isolated FunctionRemote Function

function createCategory(string projectKey, CategoryDraft payload, Expansion[]? expand) returns Category|error

Creating a category produces the CategoryCreated message.

Parameters

projectKey string -

payload CategoryDraft -

expand Expansion[]? (default ()) -

Return Type

Category|error - 201

getCategoryByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

updateCategoryByKey

Isolated FunctionRemote Function

function updateCategoryByKey(string projectKey, string 'key, CategoryUpdate payload, Expansion[]? expand) returns Category|error

Parameters

projectKey string -

'key string -

payload CategoryUpdate -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

deleteCategoryByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

Category|error - 200

getProductByID

Isolated FunctionRemote Function

function getProductByID(string projectKey, string id, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Gets the full representation of a product by ID.

Parameters

projectKey string -

id string -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

updateProductByID

Isolated FunctionRemote Function

function updateProductByID(string projectKey, string id, ProductUpdate payload, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Parameters

projectKey string -

id string -

payload ProductUpdate -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

deleteProductByID

Isolated FunctionRemote Function

function deleteProductByID(string projectKey, string id, decimal 'version, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Parameters

projectKey string -

id string -

'version decimal -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

checkIfProductWithGivenIDExists

Isolated FunctionRemote Function

function checkIfProductWithGivenIDExists(string projectKey, string id) returns Response|error

Checks if product with given ID exists.

Parameters

projectKey string -

id string -

Return Type

Response|error - The Product exists

queryProductSelectionsForProductByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

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

varAZaZ09 string[]? (default ()) -

Return Type

ProductSelectionPagedQueryResponse|error - 200

queryProductSelectionsForProductByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

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

varAZaZ09 string[]? (default ()) -

Return Type

ProductSelectionPagedQueryResponse|error - 200

getProductByKey

Isolated FunctionRemote Function

function getProductByKey(string projectKey, string 'key, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Gets the full representation of a product by Key.

Parameters

projectKey string -

'key string -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

updateProductByKey

Isolated FunctionRemote Function

function updateProductByKey(string projectKey, string 'key, ProductUpdate payload, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Parameters

projectKey string -

'key string -

payload ProductUpdate -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

deleteProductByKey

Isolated FunctionRemote Function

function deleteProductByKey(string projectKey, string 'key, decimal 'version, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

Parameters

projectKey string -

'key string -

'version decimal -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 200

checkIfProductWithGivenKeyExistsByKey

Isolated FunctionRemote Function

function checkIfProductWithGivenKeyExistsByKey(string projectKey, string 'key) returns Response|error

Checks if product with given key exists.

Parameters

projectKey string -

'key string -

Return Type

Response|error - The Product exists

queryProduct

Isolated FunctionRemote Function

function queryProduct(string projectKey, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ProductPagedQueryResponse|error

You can use the query endpoint to get the full representations of products. REMARK: We suggest to use the performance optimized search endpoint which has a bunch functionalities, the query API lacks like sorting on custom attributes, etc.

Parameters

projectKey string -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

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

varAZaZ09 string[]? (default ()) -

Return Type

ProductPagedQueryResponse|error - 200

createNewProduct

Isolated FunctionRemote Function

function createNewProduct(string projectKey, ProductDraft payload, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns Product|error

To create a new product, send a representation that is going to become the initial staged representation of the new product in the master catalog. If price selection query parameters are provided, the selected prices will be added to the response.

Parameters

projectKey string -

payload ProductDraft -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Product|error - 201

checkIfProductsExists

Isolated FunctionRemote Function

function checkIfProductsExists(string projectKey) returns Response|error

Checks if products exist.

Parameters

projectKey string -

Return Type

Response|error - At least one Product matching the query exists

uploadProductImage

Isolated FunctionRemote Function

function uploadProductImage(string projectKey, string id, byte[] payload, string? filename, decimal? variant, string? sku, boolean? staged) returns Product|error

Uploads a binary image file to a given product variant. The supported image formats are JPEG, PNG and GIF.

Parameters

projectKey string -

id string -

payload byte[] -

filename string? (default ()) -

variant decimal? (default ()) -

sku string? (default ()) -

staged boolean? (default ()) -

Return Type

Product|error - 200

getProductSelectionByID

Isolated FunctionRemote Function

function getProductSelectionByID(string projectKey, string id, Expansion[]? expand) returns ProductSelection|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

updateProductSelectionByID

Isolated FunctionRemote Function

function updateProductSelectionByID(string projectKey, string id, ProductSelectionUpdate payload, Expansion[]? expand) returns ProductSelection|error

Parameters

projectKey string -

id string -

payload ProductSelectionUpdate -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

deleteProductSelectionByID

Isolated FunctionRemote Function

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

Deletion will only succeed if the Product Selection is not assigned to any Store.

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

getProductSelectionsByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

updateProductSelectionsByKey

Isolated FunctionRemote Function

function updateProductSelectionsByKey(string projectKey, string 'key, ProductSelectionUpdate payload, Expansion[]? expand) returns ProductSelection|error

Parameters

projectKey string -

'key string -

payload ProductSelectionUpdate -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

deleteProductSelectionsByKey

Isolated FunctionRemote Function

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

Deletion will only succeed if the Product Selection is not assigned to any Store.

Parameters

projectKey string -

'key string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

ProductSelection|error - 200

queryProductsAssignedProductSelectionByKey

Isolated FunctionRemote Function

function queryProductsAssignedProductSelectionByKey(string projectKey, string 'key, Expansion[]? expand, decimal? 'limit, decimal? offset, boolean? withTotal) returns ProductSelectionProductPagedQueryResponse|error

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

Return Type

ProductSelectionProductPagedQueryResponse|error - 200

queryProductsAssignedProductSelectionByID

Isolated FunctionRemote Function

function queryProductsAssignedProductSelectionByID(string projectKey, string id, Expansion[]? expand, decimal? 'limit, decimal? offset, boolean? withTotal) returns ProductSelectionProductPagedQueryResponse|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

Return Type

ProductSelectionProductPagedQueryResponse|error - 200

getProductProjectionByID

Isolated FunctionRemote Function

function getProductProjectionByID(string projectKey, string id, boolean? staged, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns ProductProjection|error

Gets the current or staged representation of a product in a catalog by ID. When used with an API client that has the view_published_products:{projectKey} scope, this endpoint only returns published (current) product projections.

Parameters

projectKey string -

id string -

staged boolean? (default ()) -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ProductProjection|error - 200

getProductProjectionInStoreByID

Isolated FunctionRemote Function

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

Gets the current or staged representation of a product by its ID from a specific Store.

Parameters

projectKey string -

storeKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

ProductProjection|error - 200

getProductProjectionByKey

Isolated FunctionRemote Function

function getProductProjectionByKey(string projectKey, string 'key, boolean? staged, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns ProductProjection|error

Gets the current or staged representation of a product found by Key. When used with an API client that has the view_published_products:{projectKey} scope, this endpoint only returns published (current) product projections.

Parameters

projectKey string -

'key string -

staged boolean? (default ()) -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ProductProjection|error - 200

getProductProjectionInStoreByKey

Isolated FunctionRemote Function

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

Gets the current or staged representation of a product by its ID from a specific Store.

Parameters

projectKey string -

storeKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

ProductProjection|error - 200

queryProductProjections

Isolated FunctionRemote Function

function queryProductProjections(string projectKey, boolean? staged, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ProductProjectionPagedQueryResponse|error

You can use the product projections query endpoint to get the current or staged representations of Products. When used with an API client that has the view_published_products:{projectKey} scope, this endpoint only returns published (current) product projections.

Parameters

projectKey string -

staged boolean? (default ()) -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

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

varAZaZ09 string[]? (default ()) -

Return Type

ProductProjectionPagedQueryResponse|error - 200

searchproductprojectionsGet

Isolated FunctionRemote Function

function searchproductprojectionsGet(string projectKey, boolean? fuzzy, decimal? fuzzyLevel, boolean? markMatchingVariants, boolean? staged, string[]? filter, string[]? filterFacets, string[]? filterQuery, string[]? facet, string[]? textAZ2AZ2, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, string? priceCurrency, string? priceCountry, string? priceCustomerGroup, string? priceChannel, string? localeProjection, string? storeProjection, Expansion[]? expand) returns ProductProjectionPagedSearchResponse|error

Search Product Projection

Parameters

projectKey string -

fuzzy boolean? (default ()) -

fuzzyLevel decimal? (default ()) -

markMatchingVariants boolean? (default ()) -

staged boolean? (default ()) -

filter string[]? (default ()) -

filterFacets string[]? (default ()) -

filterQuery string[]? (default ()) -

facet string[]? (default ()) -

textAZ2AZ2 string[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

priceCurrency string? (default ()) -

priceCountry string? (default ()) -

priceCustomerGroup string? (default ()) -

priceChannel string? (default ()) -

localeProjection string? (default ()) -

storeProjection string? (default ()) -

expand Expansion[]? (default ()) -

Return Type

ProductProjectionPagedSearchResponse|error - 200

searchproductprojectionsPost

Isolated FunctionRemote Function

function searchproductprojectionsPost(string projectKey, URLEncodedPayload payload) returns ProductProjectionPagedSearchResponse|error

Search Product Projection

Parameters

projectKey string -

payload URLEncodedPayload -

Return Type

ProductProjectionPagedSearchResponse|error - 200

suggestQuery

Isolated FunctionRemote Function

function suggestQuery(string projectKey, boolean? fuzzy, boolean? staged, string[]? searchkeywordsAZ2AZ2, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal) returns json|error

Parameters

projectKey string -

fuzzy boolean? (default ()) -

staged boolean? (default ()) -

searchkeywordsAZ2AZ2 string[]? (default ()) -

sort Sort[]? (default ()) -

'limit decimal? (default ()) -

offset decimal? (default ()) -

withTotal boolean? (default ()) -

Return Type

json|error - 200

getInventoryEntryByID

Isolated FunctionRemote Function

function getInventoryEntryByID(string projectKey, string id, Expansion[]? expand) returns InventoryEntry|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

InventoryEntry|error - 200

updateInventoryEntryByID

Isolated FunctionRemote Function

function updateInventoryEntryByID(string projectKey, string id, InventoryEntryUpdate payload, Expansion[]? expand) returns InventoryEntry|error

Parameters

projectKey string -

id string -

payload InventoryEntryUpdate -

expand Expansion[]? (default ()) -

Return Type

InventoryEntry|error - 200

deleteInventoryEntryByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

'version decimal -

expand Expansion[]? (default ()) -

Return Type

InventoryEntry|error - 200

queryInventory

Isolated FunctionRemote Function

function queryInventory(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns InventoryPagedQueryResponse|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

InventoryPagedQueryResponse|error - 200

createInventory

Isolated FunctionRemote Function

function createInventory(string projectKey, InventoryEntryDraft payload, Expansion[]? expand) returns InventoryEntry|error

Parameters

projectKey string -

payload InventoryEntryDraft -

expand Expansion[]? (default ()) -

Return Type

InventoryEntry|error - 201

getReviewByID

Isolated FunctionRemote Function

function getReviewByID(string projectKey, string id, Expansion[]? expand) returns Review|error

Parameters

projectKey string -

id string -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

updateReviewByID

Isolated FunctionRemote Function

function updateReviewByID(string projectKey, string id, ReviewUpdate payload, Expansion[]? expand) returns Review|error

Parameters

projectKey string -

id string -

payload ReviewUpdate -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

deleteReviewByID

Isolated FunctionRemote Function

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

Parameters

projectKey string -

id string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

getReviewByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

updateReviewByKey

Isolated FunctionRemote Function

function updateReviewByKey(string projectKey, string 'key, ReviewUpdate payload, Expansion[]? expand) returns Review|error

Parameters

projectKey string -

'key string -

payload ReviewUpdate -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

deleteReviewByKey

Isolated FunctionRemote Function

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

Parameters

projectKey string -

'key string -

'version decimal -

dataErasure boolean? (default ()) -

expand Expansion[]? (default ()) -

Return Type

Review|error - 200

queryReviews

Isolated FunctionRemote Function

function queryReviews(string projectKey, Expansion[]? expand, Sort[]? sort, decimal? 'limit, decimal? offset, boolean? withTotal, QueryPredicate[]? 'where, string[]? varAZaZ09) returns ReviewPagedQueryResponse|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

ReviewPagedQueryResponse|error - 200

createReviews

Isolated FunctionRemote Function

function createReviews(string projectKey, ReviewDraft payload, Expansion[]? expand) returns Review|error

Parameters

projectKey string -

payload ReviewDraft -

expand Expansion[]? (default ()) -

Return Type

Review|error - 201

Records

commercetools.productcatalog: AccessDeniedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: AnonymousIdAlreadyInUseError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ApiClient

Fields

id string? -

name string? -

scope string? -

secret string? -

lastUsedAt string? -

deleteAt string? -

createdAt string? -

commercetools.productcatalog: ApiClientDraft

Fields

name string? -

scope string? -

deleteDaysAfterCreation int? -

commercetools.productcatalog: ApiClientPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results ApiClient[]? -

commercetools.productcatalog: Asset

Fields

id string? -

sources AssetSource[]? -

name LocalizedString? -

description LocalizedString? -

tags string[]? -

custom CustomFields? -

'key string? -

commercetools.productcatalog: AssetDimensions

Fields

w int? -

h int? -

commercetools.productcatalog: AssetDraft

Fields

sources AssetSource[]? -

name LocalizedString? -

description LocalizedString? -

tags string[]? -

custom CustomFieldsDraft? -

'key string? -

commercetools.productcatalog: AssetSource

Fields

uri string? -

'key string? -

dimensions AssetDimensions? -

contentType string? -

commercetools.productcatalog: AssignedProductReference

Fields

product ProductReference? -

commercetools.productcatalog: Attribute

Fields

name string? -

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

commercetools.productcatalog: AttributeBooleanType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeDateTimeType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeDateType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeDefinition

Fields

'type AttributeType? -

name string? -

label LocalizedString? -

isRequired boolean? -

attributeConstraint AttributeConstraintEnum? -

inputTip LocalizedString? -

inputHint TextInputHint? -

isSearchable boolean? -

commercetools.productcatalog: AttributeDefinitionAlreadyExistsError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingProductTypeId string? -

conflictingProductTypeName string? -

conflictingAttributeName string? -

commercetools.productcatalog: AttributeDefinitionDraft

Fields

'type AttributeType? -

name string? -

label LocalizedString? -

isRequired boolean? -

attributeConstraint AttributeConstraintEnum? -

inputTip LocalizedString? -

inputHint TextInputHint? -

isSearchable boolean? -

commercetools.productcatalog: AttributeDefinitionTypeConflictError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingProductTypeId string? -

conflictingProductTypeName string? -

conflictingAttributeName string? -

commercetools.productcatalog: AttributeEnumType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

values AttributePlainEnumValue[]? -

commercetools.productcatalog: AttributeLocalizableTextType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeLocalizedEnumType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

values AttributeLocalizedEnumValue[]? -

commercetools.productcatalog: AttributeLocalizedEnumValue

Fields

'key string? -

label LocalizedString? -

commercetools.productcatalog: AttributeMoneyType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeNameDoesNotExistError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

invalidAttributeName string? -

commercetools.productcatalog: AttributeNestedType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

typeReference ProductTypeReference? -

commercetools.productcatalog: AttributeNumberType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributePlainEnumValue

Fields

'key string? -

label string? -

commercetools.productcatalog: AttributeReferenceType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

referenceTypeId ReferenceTypeId? -

commercetools.productcatalog: AttributeSetType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

elementType AttributeType? -

commercetools.productcatalog: AttributeTextType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeTimeType

Fields

Fields Included from * AttributeType

name string
anydata...

name string? -

commercetools.productcatalog: AttributeType

Fields

name string? -

commercetools.productcatalog: AzureEventGridDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

uri string? -

accessKey string? -

commercetools.productcatalog: AzureServiceBusDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

connectionString string? -

commercetools.productcatalog: BadGatewayError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: BaseResource

Fields

id string? -

'version int? -

createdAt string? -

lastModifiedAt string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: CartAddDiscountCodeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

code string? -

commercetools.productcatalog: CartAddItemShippingAddressAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: 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.productcatalog: CartAddPaymentAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: CartAddShoppingListAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

shoppingList ShoppingListResourceIdentifier? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

targetsDelta ItemShippingTarget[]? -

commercetools.productcatalog: CartApplyDeltaToLineItemShippingDetailsTargetsAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

targetsDelta ItemShippingTarget[]? -

commercetools.productcatalog: CartChangeCustomLineItemMoneyAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

money Money? -

commercetools.productcatalog: CartChangeCustomLineItemQuantityAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

quantity int? -

commercetools.productcatalog: CartChangeLineItemQuantityAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.productcatalog: CartChangeTaxCalculationModeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

taxCalculationMode TaxCalculationMode? -

commercetools.productcatalog: CartChangeTaxModeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

taxMode TaxMode? -

commercetools.productcatalog: CartChangeTaxRoundingModeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

taxRoundingMode RoundingMode? -

commercetools.productcatalog: CartClassificationTier

Fields

Fields Included from * ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

value string? -

price Money? -

isMatching boolean? -

commercetools.productcatalog: CartClassificationType

Fields

Fields Included from * ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

values CustomFieldLocalizedEnumValue[]? -

commercetools.productcatalog: 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.productcatalog: CartDiscountChangeCartPredicateAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

cartPredicate string? -

commercetools.productcatalog: CartDiscountChangeIsActiveAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

isActive boolean? -

commercetools.productcatalog: CartDiscountChangeNameAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: CartDiscountChangeRequiresDiscountCodeAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

requiresDiscountCode boolean? -

commercetools.productcatalog: CartDiscountChangeSortOrderAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

sortOrder string? -

commercetools.productcatalog: CartDiscountChangeStackingModeAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

stackingMode StackingMode? -

commercetools.productcatalog: CartDiscountChangeTargetAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

target CartDiscountTarget? -

commercetools.productcatalog: CartDiscountChangeValueAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

value CartDiscountValueDraft? -

commercetools.productcatalog: CartDiscountCustomLineItemsTarget

Fields

Fields Included from * CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

commercetools.productcatalog: 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.productcatalog: CartDiscountLineItemsTarget

Fields

Fields Included from * CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

commercetools.productcatalog: CartDiscountPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results CartDiscount[]? -

commercetools.productcatalog: CartDiscountReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj CartDiscount? -

commercetools.productcatalog: CartDiscountResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: CartDiscountSetCustomFieldAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CartDiscountSetCustomTypeAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: CartDiscountSetDescriptionAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: CartDiscountSetKeyAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: CartDiscountSetValidFromAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

commercetools.productcatalog: CartDiscountSetValidFromAndUntilAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

validUntil string? -

commercetools.productcatalog: CartDiscountSetValidUntilAction

Fields

Fields Included from * CartDiscountUpdateAction

action string
anydata...

action string? -

validUntil string? -

commercetools.productcatalog: CartDiscountShippingCostTarget

Fields

Fields Included from * CartDiscountTarget

type string
anydata...

'type string? -

commercetools.productcatalog: CartDiscountTarget

Fields

'type string? -

commercetools.productcatalog: CartDiscountUpdate

Fields

'version int? -

actions CartDiscountUpdateAction[]? -

commercetools.productcatalog: CartDiscountUpdateAction

Fields

action string? -

commercetools.productcatalog: CartDiscountValue

Fields

'type string? -

commercetools.productcatalog: CartDiscountValueAbsolute

Fields

Fields Included from * CartDiscountValue

type string
anydata...

'type string? -

money TypedMoney[]? -

commercetools.productcatalog: CartDiscountValueAbsoluteDraft

Fields

Fields Included from * CartDiscountValueDraft

type string
anydata...

'type string? -

money Money[]? -

commercetools.productcatalog: CartDiscountValueDraft

Fields

'type string? -

commercetools.productcatalog: CartDiscountValueFixed

Fields

Fields Included from * CartDiscountValue

type string
anydata...

'type string? -

money TypedMoney[]? -

commercetools.productcatalog: CartDiscountValueFixedDraft

Fields

Fields Included from * CartDiscountValueDraft

type string
anydata...

'type string? -

money Money[]? -

commercetools.productcatalog: CartDiscountValueGiftLineItem

Fields

Fields Included from * CartDiscountValue

type string
anydata...

'type string? -

product ProductReference? -

variantId int? -

supplyChannel ChannelReference? -

distributionChannel ChannelReference? -

commercetools.productcatalog: CartDiscountValueGiftLineItemDraft

Fields

Fields Included from * CartDiscountValueDraft

type string
anydata...

'type string? -

product ProductResourceIdentifier? -

variantId int? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: CartDiscountValueRelative

Fields

Fields Included from * CartDiscountValue

type string
anydata...

'type string? -

permyriad int? -

commercetools.productcatalog: CartDiscountValueRelativeDraft

Fields

Fields Included from * CartDiscountValueDraft

type string
anydata...

'type string? -

permyriad int? -

commercetools.productcatalog: 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.productcatalog: CartPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Cart[]? -

commercetools.productcatalog: CartRecalculateAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

updateProductData boolean? -

commercetools.productcatalog: CartReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Cart? -

commercetools.productcatalog: CartRemoveCustomLineItemAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

commercetools.productcatalog: CartRemoveDiscountCodeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

discountCode DiscountCodeReference? -

commercetools.productcatalog: CartRemoveItemShippingAddressAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

commercetools.productcatalog: CartRemoveLineItemAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

shippingDetailsToRemove ItemShippingDetailsDraft? -

commercetools.productcatalog: CartRemovePaymentAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: CartResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: CartsConfiguration

Fields

countryTaxRateFallbackEnabled boolean? -

deleteDaysAfterLastModification int? -

commercetools.productcatalog: CartScoreTier

Fields

Fields Included from * ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

score decimal? -

price Money? -

priceFunction PriceFunction? -

isMatching boolean? -

commercetools.productcatalog: CartScoreType

Fields

Fields Included from * ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

commercetools.productcatalog: CartSetAnonymousIdAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

anonymousId string? -

commercetools.productcatalog: CartSetBillingAddressAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: CartSetBillingAddressCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CartSetBillingAddressCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetCartTotalTaxAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

externalTotalGross Money? -

externalTaxPortions TaxPortionDraft[]? -

commercetools.productcatalog: CartSetCountryAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

country CountryCode? -

commercetools.productcatalog: CartSetCustomerEmailAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: CartSetCustomerGroupAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customerGroup CustomerGroupResourceIdentifier? -

commercetools.productcatalog: CartSetCustomerIdAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customerId string? -

commercetools.productcatalog: CartSetCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CartSetCustomLineItemCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

name string? -

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

commercetools.productcatalog: CartSetCustomLineItemCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetCustomLineItemShippingDetailsAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: CartSetCustomLineItemTaxAmountAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: CartSetCustomLineItemTaxRateAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: CartSetCustomShippingMethodAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

shippingMethodName string? -

shippingRate ShippingRateDraft? -

taxCategory TaxCategoryResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: CartSetCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

deleteDaysAfterLastModification int? -

commercetools.productcatalog: CartSetDeliveryAddressCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

deliveryId string? -

name string? -

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

commercetools.productcatalog: CartSetDeliveryAddressCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

deliveryId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetItemShippingAddressCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

name string? -

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

commercetools.productcatalog: CartSetItemShippingAddressCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

addressKey string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetKeyAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: CartSetLineItemCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: CartSetLineItemCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetLineItemDistributionChannelAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: CartSetLineItemPriceAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalPrice Money? -

commercetools.productcatalog: CartSetLineItemShippingDetailsAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: CartSetLineItemSupplyChannelAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.productcatalog: CartSetLineItemTaxAmountAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: CartSetLineItemTaxRateAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: CartSetLineItemTotalPriceAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.productcatalog: CartSetLocaleAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: CartSetShippingAddressAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: CartSetShippingAddressCustomFieldAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CartSetShippingAddressCustomTypeAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CartSetShippingMethodAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

shippingMethod ShippingMethodResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: CartSetShippingMethodTaxAmountAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: CartSetShippingMethodTaxRateAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: CartSetShippingRateInputAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

shippingRateInput ShippingRateInputDraft? -

commercetools.productcatalog: CartUpdate

Fields

'version int? -

actions CartUpdateAction[]? -

commercetools.productcatalog: CartUpdateAction

Fields

action string? -

commercetools.productcatalog: CartUpdateItemShippingAddressAction

Fields

Fields Included from * CartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: CartValueTier

Fields

Fields Included from * ShippingRatePriceTier

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

minimumCentAmount int? -

price Money? -

isMatching boolean? -

commercetools.productcatalog: CartValueType

Fields

Fields Included from * ShippingRateInputType

type ShippingRateTierType
anydata...

'type ShippingRateTierType? -

commercetools.productcatalog: 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.productcatalog: CategoryAddAssetAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

asset AssetDraft? -

position int? -

commercetools.productcatalog: CategoryChangeAssetNameAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

name LocalizedString? -

commercetools.productcatalog: CategoryChangeAssetOrderAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetOrder string[]? -

commercetools.productcatalog: CategoryChangeNameAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: CategoryChangeOrderHintAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

orderHint string? -

commercetools.productcatalog: CategoryChangeParentAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

parent CategoryResourceIdentifier? -

commercetools.productcatalog: CategoryChangeSlugAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

slug LocalizedString? -

commercetools.productcatalog: 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.productcatalog: CategoryCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

category Category? -

commercetools.productcatalog: 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.productcatalog: CategoryOrderHints

commercetools.productcatalog: CategoryPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Category[]? -

commercetools.productcatalog: CategoryReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Category? -

commercetools.productcatalog: CategoryRemoveAssetAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

commercetools.productcatalog: CategoryResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: 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.productcatalog: CategorySetAssetCustomTypeAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: CategorySetAssetDescriptionAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

description LocalizedString? -

commercetools.productcatalog: CategorySetAssetKeyAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

commercetools.productcatalog: CategorySetAssetSourcesAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

sources AssetSource[]? -

commercetools.productcatalog: CategorySetAssetTagsAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

assetId string? -

assetKey string? -

tags string[]? -

commercetools.productcatalog: CategorySetCustomFieldAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CategorySetCustomTypeAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CategorySetDescriptionAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: CategorySetExternalIdAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

externalId string? -

commercetools.productcatalog: CategorySetKeyAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: CategorySetMetaDescriptionAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

metaDescription LocalizedString? -

commercetools.productcatalog: CategorySetMetaKeywordsAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

metaKeywords LocalizedString? -

commercetools.productcatalog: CategorySetMetaTitleAction

Fields

Fields Included from * CategoryUpdateAction

action string
anydata...

action string? -

metaTitle LocalizedString? -

commercetools.productcatalog: 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.productcatalog: CategorySlugChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

slug LocalizedString? -

oldSlug LocalizedString? -

commercetools.productcatalog: CategoryUpdate

Fields

'version int? -

actions CategoryUpdateAction[]? -

commercetools.productcatalog: CategoryUpdateAction

Fields

action string? -

commercetools.productcatalog: CentPrecisionMoney

Fields

Fields Included from * TypedMoney

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

'type MoneyType? -

fractionDigits int? -

centAmount int? -

currencyCode CurrencyCode? -

commercetools.productcatalog: CentPrecisionMoneyDraft

Fields

Fields Included from * TypedMoneyDraft

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

centAmount int? -

currencyCode CurrencyCode? -

'type MoneyType? -

fractionDigits int? -

commercetools.productcatalog: ChangeSubscription

Fields

resourceTypeId string? -

commercetools.productcatalog: 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.productcatalog: ChannelAddRolesAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.productcatalog: ChannelChangeDescriptionAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: ChannelChangeKeyAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ChannelChangeNameAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: ChannelDraft

Fields

'key string? -

roles ChannelRoleEnum[]? -

name LocalizedString? -

description LocalizedString? -

address BaseAddress? -

custom CustomFieldsDraft? -

geoLocation GeoJson? -

commercetools.productcatalog: ChannelPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results Channel[]? -

commercetools.productcatalog: ChannelReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Channel? -

commercetools.productcatalog: ChannelRemoveRolesAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.productcatalog: ChannelResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ChannelSetAddressAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: ChannelSetAddressCustomFieldAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: ChannelSetAddressCustomTypeAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ChannelSetCustomFieldAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: ChannelSetCustomTypeAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ChannelSetGeoLocationAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

geoLocation GeoJson? -

commercetools.productcatalog: ChannelSetRolesAction

Fields

Fields Included from * ChannelUpdateAction

action string
anydata...

action string? -

roles ChannelRoleEnum[]? -

commercetools.productcatalog: ChannelUpdate

Fields

'version int? -

actions ChannelUpdateAction[]? -

commercetools.productcatalog: ChannelUpdateAction

Fields

action string? -

commercetools.productcatalog: ClassificationShippingRateInput

Fields

Fields Included from * ShippingRateInput

type string
anydata...

'type string? -

'key string? -

label LocalizedString? -

commercetools.productcatalog: ClassificationShippingRateInputDraft

Fields

Fields Included from * ShippingRateInputDraft

type string
anydata...

'type string? -

'key string? -

commercetools.productcatalog: 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.productcatalog: ClientLogging

Fields

clientId string? -

externalUserId string? -

customer CustomerReference? -

anonymousId string? -

commercetools.productcatalog: ConcurrentModificationError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

currentVersion int? -

commercetools.productcatalog: 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.productcatalog: ContainerAndKey

Fields

'key string? -

container string? -

commercetools.productcatalog: CreatedBy

Fields

Fields Included from * ClientLogging

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

clientId string? -

externalUserId string? -

customer CustomerReference? -

anonymousId string? -

commercetools.productcatalog: 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.productcatalog: CustomerAddAddressAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: CustomerAddBillingAddressIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: 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.productcatalog: CustomerAddressAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.productcatalog: 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.productcatalog: CustomerAddressChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.productcatalog: 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.productcatalog: CustomerAddressRemovedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

address Address? -

commercetools.productcatalog: CustomerAddShippingAddressIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerAddStoreAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

store StoreResourceIdentifier? -

commercetools.productcatalog: CustomerChangeAddressAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

address BaseAddress? -

commercetools.productcatalog: CustomerChangeEmailAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: CustomerChangePassword

Fields

id string? -

'version int? -

currentPassword string? -

newPassword string? -

commercetools.productcatalog: 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.productcatalog: CustomerCompanyNameSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

companyName string? -

commercetools.productcatalog: 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.productcatalog: CustomerCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customer Customer? -

commercetools.productcatalog: CustomerCreateEmailToken

Fields

id string? -

'version int? -

ttlMinutes int? -

commercetools.productcatalog: CustomerCreatePasswordResetToken

Fields

email string? -

ttlMinutes int? -

commercetools.productcatalog: 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.productcatalog: CustomerDateOfBirthSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

dateOfBirth string? -

commercetools.productcatalog: 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.productcatalog: CustomerDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: CustomerEmailChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

email string? -

commercetools.productcatalog: 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.productcatalog: CustomerEmailVerifiedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

commercetools.productcatalog: CustomerEmailVerify

Fields

'version int? -

tokenValue string? -

commercetools.productcatalog: 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.productcatalog: CustomerFirstNameSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

firstName string? -

commercetools.productcatalog: 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.productcatalog: CustomerGroupChangeNameAction

Fields

Fields Included from * CustomerGroupUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: CustomerGroupDraft

Fields

'key string? -

groupName string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: CustomerGroupPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results CustomerGroup[]? -

commercetools.productcatalog: CustomerGroupReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj CustomerGroup? -

commercetools.productcatalog: CustomerGroupResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: CustomerGroupSetCustomFieldAction

Fields

Fields Included from * CustomerGroupUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CustomerGroupSetCustomTypeAction

Fields

Fields Included from * CustomerGroupUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CustomerGroupSetKeyAction

Fields

Fields Included from * CustomerGroupUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: 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.productcatalog: CustomerGroupSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customerGroup CustomerGroupReference? -

commercetools.productcatalog: CustomerGroupUpdate

Fields

'version int? -

actions CustomerGroupUpdateAction[]? -

commercetools.productcatalog: CustomerGroupUpdateAction

Fields

action string? -

commercetools.productcatalog: 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.productcatalog: CustomerLastNameSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

lastName string? -

commercetools.productcatalog: CustomerPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Customer[]? -

commercetools.productcatalog: 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.productcatalog: CustomerPasswordUpdatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

reset boolean? -

commercetools.productcatalog: CustomerReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Customer? -

commercetools.productcatalog: CustomerRemoveAddressAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerRemoveBillingAddressIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerRemoveShippingAddressIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerRemoveStoreAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

store StoreResourceIdentifier? -

commercetools.productcatalog: CustomerResetPassword

Fields

tokenValue string? -

newPassword string? -

'version int? -

commercetools.productcatalog: CustomerResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: CustomerSetAddressCustomFieldAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

name string? -

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

commercetools.productcatalog: CustomerSetAddressCustomTypeAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

addressId string? -

commercetools.productcatalog: CustomerSetCompanyNameAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

companyName string? -

commercetools.productcatalog: CustomerSetCustomerGroupAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

customerGroup CustomerGroupResourceIdentifier? -

commercetools.productcatalog: CustomerSetCustomerNumberAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

customerNumber string? -

commercetools.productcatalog: CustomerSetCustomFieldAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: CustomerSetCustomTypeAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CustomerSetDateOfBirthAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

dateOfBirth string? -

commercetools.productcatalog: CustomerSetDefaultBillingAddressAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerSetDefaultShippingAddressAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: CustomerSetExternalIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

externalId string? -

commercetools.productcatalog: CustomerSetFirstNameAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

firstName string? -

commercetools.productcatalog: CustomerSetKeyAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: CustomerSetLastNameAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

lastName string? -

commercetools.productcatalog: CustomerSetLocaleAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: CustomerSetMiddleNameAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

middleName string? -

commercetools.productcatalog: CustomerSetSalutationAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

salutation string? -

commercetools.productcatalog: CustomerSetStoresAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

stores StoreResourceIdentifier[]? -

commercetools.productcatalog: CustomerSetTitleAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

title string? -

commercetools.productcatalog: CustomerSetVatIdAction

Fields

Fields Included from * CustomerUpdateAction

action string
anydata...

action string? -

vatId string? -

commercetools.productcatalog: CustomerSignin

Fields

email string? -

password string? -

anonymousCartId string? -

anonymousCart CartResourceIdentifier? -

anonymousCartSignInMode AnonymousCartSignInMode? -

anonymousId string? -

updateProductData boolean? -

commercetools.productcatalog: CustomerSignInResult

Fields

customer Customer? -

cart Cart? -

commercetools.productcatalog: 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.productcatalog: CustomerTitleSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

title string? -

commercetools.productcatalog: CustomerToken

Fields

id string? -

createdAt string? -

lastModifiedAt string? -

customerId string? -

expiresAt string? -

value string? -

commercetools.productcatalog: CustomerUpdate

Fields

'version int? -

actions CustomerUpdateAction[]? -

commercetools.productcatalog: CustomerUpdateAction

Fields

action string? -

commercetools.productcatalog: CustomFieldBooleanType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldDateTimeType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldDateType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldEnumType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

values CustomFieldEnumValue[]? -

commercetools.productcatalog: CustomFieldEnumValue

Fields

'key string? -

label string? -

commercetools.productcatalog: CustomFieldLocalizedEnumType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

values CustomFieldLocalizedEnumValue[]? -

commercetools.productcatalog: CustomFieldLocalizedEnumValue

Fields

'key string? -

label LocalizedString? -

commercetools.productcatalog: CustomFieldLocalizedStringType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldMoneyType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldNumberType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldReferenceType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

referenceTypeId ReferenceTypeId? -

commercetools.productcatalog: CustomFields

Fields

'type TypeReference? -

fields FieldContainer? -

commercetools.productcatalog: CustomFieldsDraft

Fields

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: CustomFieldSetType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

elementType FieldType? -

commercetools.productcatalog: CustomFieldStringType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: CustomFieldTimeType

Fields

Fields Included from * FieldType

name string
anydata...

name string? -

commercetools.productcatalog: 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.productcatalog: CustomLineItemDraft

Fields

name LocalizedString? -

quantity int? -

money Money? -

slug string? -

taxCategory TaxCategoryResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

custom CustomFieldsDraft? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: CustomLineItemImportDraft

Fields

name LocalizedString? -

quantity int? -

money Money? -

slug string? -

state ItemState[]? -

taxRate TaxRate? -

taxCategory TaxCategoryResourceIdentifier? -

custom CustomFieldsDraft? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: CustomLineItemStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customLineItemId string? -

transitionDate string? -

quantity int? -

fromState StateReference? -

toState StateReference? -

commercetools.productcatalog: 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.productcatalog: CustomObjectDraft

Fields

container string? -

'key string? -

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

'version int? -

commercetools.productcatalog: CustomObjectPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results CustomObject[]? -

commercetools.productcatalog: CustomObjectReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj CustomObject? -

commercetools.productcatalog: CustomTokenizer

Fields

Fields Included from * SuggestTokenizer

type string
anydata...

'type string? -

inputs string[]? -

commercetools.productcatalog: Delivery

Fields

id string? -

createdAt string? -

items DeliveryItem[]? -

parcels Parcel[]? -

address Address? -

custom CustomFields? -

commercetools.productcatalog: 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.productcatalog: DeliveryAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

delivery Delivery? -

commercetools.productcatalog: 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.productcatalog: DeliveryAddressSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

deliveryId string? -

address Address? -

oldAddress Address? -

commercetools.productcatalog: DeliveryCloudEventsFormat

Fields

Fields Included from * DeliveryFormat

type string
anydata...

'type string? -

cloudEventsVersion string? -

commercetools.productcatalog: DeliveryFormat

Fields

'type string? -

commercetools.productcatalog: DeliveryItem

Fields

id string? -

quantity int? -

commercetools.productcatalog: 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.productcatalog: DeliveryItemsUpdatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

deliveryId string? -

items DeliveryItem[]? -

oldItems DeliveryItem[]? -

commercetools.productcatalog: DeliveryPlatformFormat

Fields

Fields Included from * DeliveryFormat

type string
anydata...

'type string? -

commercetools.productcatalog: 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.productcatalog: DeliveryRemovedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

delivery Delivery? -

commercetools.productcatalog: Destination

Fields

'type string? -

commercetools.productcatalog: 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.productcatalog: DiscountCodeChangeCartDiscountsAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

cartDiscounts CartDiscountResourceIdentifier[]? -

commercetools.productcatalog: DiscountCodeChangeGroupsAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

groups string[]? -

commercetools.productcatalog: DiscountCodeChangeIsActiveAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

isActive boolean? -

commercetools.productcatalog: 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.productcatalog: DiscountCodeInfo

Fields

discountCode DiscountCodeReference? -

state DiscountCodeState? -

commercetools.productcatalog: 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.productcatalog: DiscountCodePagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results DiscountCode[]? -

commercetools.productcatalog: DiscountCodeReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj DiscountCode? -

commercetools.productcatalog: DiscountCodeResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: DiscountCodeSetCartPredicateAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

cartPredicate string? -

commercetools.productcatalog: DiscountCodeSetCustomFieldAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: DiscountCodeSetCustomTypeAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: DiscountCodeSetDescriptionAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: DiscountCodeSetMaxApplicationsAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

maxApplications int? -

commercetools.productcatalog: DiscountCodeSetMaxApplicationsPerCustomerAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

maxApplicationsPerCustomer int? -

commercetools.productcatalog: DiscountCodeSetNameAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: DiscountCodeSetValidFromAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

validFrom string? -

commercetools.productcatalog: DiscountCodeSetValidFromAndUntilAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

validFrom string? -

validUntil string? -

commercetools.productcatalog: DiscountCodeSetValidUntilAction

Fields

Fields Included from * DiscountCodeUpdateAction

action string
anydata...

action string? -

validUntil string? -

commercetools.productcatalog: DiscountCodeUpdate

Fields

'version int? -

actions DiscountCodeUpdateAction[]? -

commercetools.productcatalog: DiscountCodeUpdateAction

Fields

action string? -

commercetools.productcatalog: DiscountedLineItemPortion

Fields

discount CartDiscountReference? -

discountedAmount TypedMoney? -

commercetools.productcatalog: DiscountedLineItemPrice

Fields

value TypedMoney? -

includedDiscounts DiscountedLineItemPortion[]? -

commercetools.productcatalog: DiscountedLineItemPriceDraft

Fields

value Money? -

includedDiscounts DiscountedLineItemPortion[]? -

commercetools.productcatalog: DiscountedLineItemPriceForQuantity

Fields

quantity decimal? -

discountedPrice DiscountedLineItemPrice? -

commercetools.productcatalog: DiscountedPrice

Fields

value TypedMoney? -

discount ProductDiscountReference? -

commercetools.productcatalog: DiscountedPriceDraft

Fields

value Money? -

discount ProductDiscountReference? -

commercetools.productcatalog: DuplicateAttributeValueError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

attribute Attribute? -

commercetools.productcatalog: DuplicateAttributeValuesError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

attributes Attribute[]? -

commercetools.productcatalog: DuplicateEnumValuesError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

duplicates string[]? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: DuplicatePriceScopeError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingPrices Price[]? -

commercetools.productcatalog: DuplicateVariantValuesError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

variantValues VariantValues? -

commercetools.productcatalog: EditPreviewFailedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

result OrderEditPreviewFailure? -

commercetools.productcatalog: EnumKeyAlreadyExistsError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingEnumKey string? -

conflictingAttributeName string? -

commercetools.productcatalog: EnumKeyDoesNotExistError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

conflictingEnumKey string? -

conflictingAttributeName string? -

commercetools.productcatalog: EnumValueIsUsedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: EnumValuesMustMatchError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ErrorByExtension

Fields

id string? -

'key string? -

commercetools.productcatalog: ErrorObject

Fields

code string? -

message string? -

commercetools.productcatalog: ErrorResponse

Fields

statusCode int? -

message string? -

'error string? -

error_description string? -

errors ErrorObject[]? -

commercetools.productcatalog: EventBridgeDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

region string? -

accountId string? -

commercetools.productcatalog: 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.productcatalog: ExtensionAuthorizationHeaderAuthentication

Fields

Fields Included from * ExtensionHttpDestinationAuthentication

type string
anydata...

'type string? -

headerValue string? -

commercetools.productcatalog: ExtensionAWSLambdaDestination

Fields

Fields Included from * ExtensionDestination

type string
anydata...

'type string? -

arn string? -

accessKey string? -

accessSecret string? -

commercetools.productcatalog: ExtensionAzureFunctionsAuthentication

Fields

Fields Included from * ExtensionHttpDestinationAuthentication

type string
anydata...

'type string? -

'key string? -

commercetools.productcatalog: ExtensionBadResponseError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

localizedMessage LocalizedString? -

extensionExtraInfo record {}? -

errorByExtension ErrorByExtension? -

commercetools.productcatalog: ExtensionChangeDestinationAction

Fields

Fields Included from * ExtensionUpdateAction

action string
anydata...

action string? -

destination ExtensionDestination? -

commercetools.productcatalog: ExtensionChangeTriggersAction

Fields

Fields Included from * ExtensionUpdateAction

action string
anydata...

action string? -

triggers ExtensionTrigger[]? -

commercetools.productcatalog: ExtensionDestination

Fields

'type string? -

commercetools.productcatalog: ExtensionDraft

Fields

'key string? -

destination ExtensionDestination? -

triggers ExtensionTrigger[]? -

timeoutInMs int? -

commercetools.productcatalog: ExtensionHttpDestination

Fields

Fields Included from * ExtensionDestination

type string
anydata...

'type string? -

url string? -

authentication ExtensionHttpDestinationAuthentication? -

commercetools.productcatalog: ExtensionHttpDestinationAuthentication

Fields

'type string? -

commercetools.productcatalog: ExtensionInput

Fields

action ExtensionAction? -

'resource Reference? -

commercetools.productcatalog: ExtensionNoResponseError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

extensionId string? -

extensionKey string? -

commercetools.productcatalog: ExtensionPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Extension[]? -

commercetools.productcatalog: ExtensionSetKeyAction

Fields

Fields Included from * ExtensionUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ExtensionSetTimeoutInMsAction

Fields

Fields Included from * ExtensionUpdateAction

action string
anydata...

action string? -

timeoutInMs int? -

commercetools.productcatalog: ExtensionTrigger

Fields

resourceTypeId ExtensionResourceTypeId? -

actions ExtensionAction[]? -

commercetools.productcatalog: ExtensionUpdate

Fields

'version int? -

actions ExtensionUpdateAction[]? -

commercetools.productcatalog: ExtensionUpdateAction

Fields

action string? -

commercetools.productcatalog: ExtensionUpdateActionsFailedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

localizedMessage LocalizedString? -

extensionExtraInfo record {}? -

errorByExtension ErrorByExtension? -

commercetools.productcatalog: ExternalLineItemTotalPrice

Fields

price Money? -

totalPrice Money? -

commercetools.productcatalog: ExternalOAuth

Fields

url string? -

authorizationHeader string? -

commercetools.productcatalog: ExternalOAuthFailedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ExternalTaxAmountDraft

Fields

totalGross Money? -

taxRate ExternalTaxRateDraft? -

commercetools.productcatalog: ExternalTaxRateDraft

Fields

name string? -

amount decimal? -

country string? -

state string? -

subRates SubRate[]? -

includedInPrice boolean? -

commercetools.productcatalog: FacetResult

Fields

'type FacetTypes? -

commercetools.productcatalog: FacetResultRange

Fields

'from decimal? -

fromStr string? -

to decimal? -

toStr string? -

count int? -

productCount int? -

total decimal? -

min decimal? -

max decimal? -

mean decimal? -

commercetools.productcatalog: FacetResults

commercetools.productcatalog: FacetResultTerm

Fields

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

count int? -

productCount int? -

commercetools.productcatalog: FeatureRemovedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: FieldContainer

commercetools.productcatalog: FieldDefinition

Fields

'type FieldType? -

name string? -

label LocalizedString? -

required boolean? -

inputHint TypeTextInputHint? -

commercetools.productcatalog: FieldType

Fields

name string? -

commercetools.productcatalog: FilteredFacetResult

Fields

Fields Included from * FacetResult

type FacetTypes
anydata...

'type FacetTypes? -

count int? -

productCount int? -

commercetools.productcatalog: GeneralError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: GeoJson

Fields

'type string? -

commercetools.productcatalog: GeoJsonPoint

Fields

Fields Included from * GeoJson

type string
anydata...

'type string? -

coordinates decimal[]? -

commercetools.productcatalog: GoogleCloudPubSubDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

projectId string? -

topic string? -

commercetools.productcatalog: GraphQLError

Fields

message string? -

locations GraphQLErrorLocation[]? -

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

commercetools.productcatalog: GraphQLErrorLocation

Fields

line int? -

column int? -

commercetools.productcatalog: GraphQLRequest

Fields

query string? -

operationName string? -

variables GraphQLVariablesMap? -

commercetools.productcatalog: GraphQLResponse

Fields

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

errors GraphQLError[]? -

commercetools.productcatalog: GraphQLVariablesMap

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: Hit

Fields

id string? -

'version int? -

relevance decimal? -

commercetools.productcatalog: Image

Fields

url string? -

dimensions ImageDimensions? -

label string? -

commercetools.productcatalog: ImageDimensions

Fields

w int? -

h int? -

commercetools.productcatalog: IndividualProductSelectionType

Fields

Fields Included from * ProductSelectionType

type ProductSelectionTypeEnum
anydata...

'type ProductSelectionTypeEnum? -

name LocalizedString? -

commercetools.productcatalog: InsufficientScopeError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InternalConstraintViolatedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidCredentialsError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidCurrentPasswordError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: InvalidInputError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidItemShippingDetailsError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

subject string? -

itemId string? -

commercetools.productcatalog: InvalidJsonInputError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidOperationError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidSubjectError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: InvalidTokenError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: InventoryEntryAddQuantityAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

quantity int? -

commercetools.productcatalog: InventoryEntryChangeQuantityAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

quantity int? -

commercetools.productcatalog: 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.productcatalog: InventoryEntryCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

inventoryEntry InventoryEntry? -

commercetools.productcatalog: 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.productcatalog: InventoryEntryDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

sku string? -

supplyChannel ChannelReference? -

commercetools.productcatalog: InventoryEntryDraft

Fields

sku string? -

supplyChannel ChannelResourceIdentifier? -

quantityOnStock int? -

restockableInDays int? -

expectedDelivery string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: 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.productcatalog: InventoryEntryQuantitySetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

oldQuantityOnStock int? -

newQuantityOnStock int? -

oldAvailableQuantity int? -

newAvailableQuantity int? -

supplyChannel ChannelReference? -

commercetools.productcatalog: InventoryEntryReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj InventoryEntry? -

commercetools.productcatalog: InventoryEntryRemoveQuantityAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

quantity int? -

commercetools.productcatalog: InventoryEntryResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: InventoryEntrySetCustomFieldAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: InventoryEntrySetCustomTypeAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: InventoryEntrySetExpectedDeliveryAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

expectedDelivery string? -

commercetools.productcatalog: InventoryEntrySetRestockableInDaysAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

restockableInDays int? -

commercetools.productcatalog: InventoryEntrySetSupplyChannelAction

Fields

Fields Included from * InventoryEntryUpdateAction

action string
anydata...

action string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.productcatalog: InventoryEntryUpdate

Fields

'version int? -

actions InventoryEntryUpdateAction[]? -

commercetools.productcatalog: InventoryEntryUpdateAction

Fields

action string? -

commercetools.productcatalog: InventoryPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results InventoryEntry[]? -

commercetools.productcatalog: IronMqDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

uri string? -

commercetools.productcatalog: ItemShippingDetails

Fields

targets ItemShippingTarget[]? -

valid boolean? -

commercetools.productcatalog: ItemShippingDetailsDraft

Fields

targets ItemShippingTarget[]? -

commercetools.productcatalog: ItemShippingTarget

Fields

addressKey string? -

quantity decimal? -

commercetools.productcatalog: ItemState

Fields

quantity decimal? -

state StateReference? -

commercetools.productcatalog: KeyReference

Fields

typeId ReferenceTypeId? -

'key string? -

commercetools.productcatalog: LanguageUsedInStoresError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: LastModifiedBy

Fields

Fields Included from * ClientLogging

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

clientId string? -

externalUserId string? -

customer CustomerReference? -

anonymousId string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: 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.productcatalog: 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.productcatalog: 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.productcatalog: LineItemStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

lineItemId string? -

transitionDate string? -

quantity int? -

fromState StateReference? -

toState StateReference? -

commercetools.productcatalog: LocalizedString

commercetools.productcatalog: Location

Fields

country CountryCode? -

state string? -

commercetools.productcatalog: 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.productcatalog: MaxResourceLimitExceededError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

exceededResource ReferenceTypeId? -

commercetools.productcatalog: 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.productcatalog: MessageConfiguration

Fields

enabled boolean? -

deleteDaysAfterCreation int? -

commercetools.productcatalog: MessageConfigurationDraft

Fields

enabled boolean? -

deleteDaysAfterCreation int? -

commercetools.productcatalog: 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.productcatalog: MessagePagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Message[]? -

commercetools.productcatalog: MessagePayload

Fields

'type string? -

commercetools.productcatalog: MessageSubscription

Fields

resourceTypeId string? -

types string[]? -

commercetools.productcatalog: MissingRoleOnChannelError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

channel ChannelResourceIdentifier? -

missingRole ChannelRoleEnum? -

commercetools.productcatalog: MissingTaxRateForCountryError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

taxCategoryId string? -

country string? -

state string? -

commercetools.productcatalog: Money

Fields

centAmount int? -

currencyCode CurrencyCode? -

commercetools.productcatalog: MultiBuyCustomLineItemsTarget

Fields

Fields Included from * CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

triggerQuantity int? -

discountedQuantity int? -

maxOccurrence int? -

selectionMode SelectionMode? -

commercetools.productcatalog: MultiBuyLineItemsTarget

Fields

Fields Included from * CartDiscountTarget

type string
anydata...

'type string? -

predicate string? -

triggerQuantity int? -

discountedQuantity int? -

maxOccurrence int? -

selectionMode SelectionMode? -

commercetools.productcatalog: MyCartAddDiscountCodeAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

code string? -

commercetools.productcatalog: MyCartAddItemShippingAddressAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: 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.productcatalog: MyCartAddPaymentAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: MyCartApplyDeltaToLineItemShippingDetailsTargetsAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

targetsDelta ItemShippingTarget[]? -

commercetools.productcatalog: MyCartChangeLineItemQuantityAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.productcatalog: MyCartChangeTaxModeAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

taxMode TaxMode? -

commercetools.productcatalog: 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.productcatalog: MyCartRecalculateAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

updateProductData boolean? -

commercetools.productcatalog: MyCartRemoveDiscountCodeAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

discountCode DiscountCodeReference? -

commercetools.productcatalog: MyCartRemoveItemShippingAddressAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

addressKey string? -

commercetools.productcatalog: MyCartRemoveLineItemAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

shippingDetailsToRemove ItemShippingDetailsDraft? -

commercetools.productcatalog: MyCartRemovePaymentAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: MyCartSetBillingAddressAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: MyCartSetCountryAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

country CountryCode? -

commercetools.productcatalog: MyCartSetCustomerEmailAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: MyCartSetCustomFieldAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: MyCartSetCustomTypeAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyCartSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

deleteDaysAfterLastModification int? -

commercetools.productcatalog: MyCartSetLineItemCustomFieldAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: MyCartSetLineItemCustomTypeAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyCartSetLineItemDistributionChannelAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: MyCartSetLineItemShippingDetailsAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: MyCartSetLineItemSupplyChannelAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

lineItemId string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.productcatalog: MyCartSetLocaleAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: MyCartSetShippingAddressAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: MyCartSetShippingMethodAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

shippingMethod ShippingMethodResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: MyCartUpdate

Fields

'version int? -

actions MyCartUpdateAction[]? -

commercetools.productcatalog: MyCartUpdateAction

Fields

action string? -

commercetools.productcatalog: MyCartUpdateItemShippingAddressAction

Fields

Fields Included from * MyCartUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: MyCustomerAddAddressAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: MyCustomerAddBillingAddressIdAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerAddShippingAddressIdAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerChangeAddressAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

address BaseAddress? -

commercetools.productcatalog: MyCustomerChangeEmailAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: MyCustomerChangePassword

Fields

'version int? -

currentPassword string? -

newPassword string? -

commercetools.productcatalog: 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.productcatalog: MyCustomerRemoveAddressAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerRemoveBillingAddressIdAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerRemoveShippingAddressIdAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerSetCompanyNameAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

companyName string? -

commercetools.productcatalog: MyCustomerSetCustomFieldAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: MyCustomerSetCustomTypeAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyCustomerSetDateOfBirthAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

dateOfBirth string? -

commercetools.productcatalog: MyCustomerSetDefaultBillingAddressAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerSetDefaultShippingAddressAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

addressId string? -

addressKey string? -

commercetools.productcatalog: MyCustomerSetFirstNameAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

firstName string? -

commercetools.productcatalog: MyCustomerSetLastNameAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

lastName string? -

commercetools.productcatalog: MyCustomerSetLocaleAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: MyCustomerSetMiddleNameAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

middleName string? -

commercetools.productcatalog: MyCustomerSetSalutationAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

salutation string? -

commercetools.productcatalog: MyCustomerSetTitleAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

title string? -

commercetools.productcatalog: MyCustomerSetVatIdAction

Fields

Fields Included from * MyCustomerUpdateAction

action string
anydata...

action string? -

vatId string? -

commercetools.productcatalog: MyCustomerUpdate

Fields

'version int? -

actions MyCustomerUpdateAction[]? -

commercetools.productcatalog: MyCustomerUpdateAction

Fields

action string? -

commercetools.productcatalog: MyLineItemDraft

Fields

productId string? -

variantId int? -

quantity int? -

addedAt string? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

custom CustomFieldsDraft? -

shippingDetails ItemShippingDetailsDraft? -

sku string? -

commercetools.productcatalog: MyOrderFromCartDraft

Fields

id string? -

'version int? -

commercetools.productcatalog: MyPayment

Fields

id string? -

'version int? -

customer CustomerReference? -

anonymousId string? -

amountPlanned TypedMoney? -

paymentMethodInfo PaymentMethodInfo? -

transactions Transaction[]? -

custom CustomFields? -

commercetools.productcatalog: MyPaymentAddTransactionAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

'transaction TransactionDraft? -

commercetools.productcatalog: MyPaymentChangeAmountPlannedAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

amount Money? -

commercetools.productcatalog: MyPaymentDraft

Fields

amountPlanned Money? -

paymentMethodInfo PaymentMethodInfo? -

custom CustomFieldsDraft? -

'transaction MyTransactionDraft? -

commercetools.productcatalog: MyPaymentPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results MyPayment[]? -

commercetools.productcatalog: MyPaymentSetCustomFieldAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: MyPaymentSetMethodInfoInterfaceAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

interface string? -

commercetools.productcatalog: MyPaymentSetMethodInfoMethodAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

method string? -

commercetools.productcatalog: MyPaymentSetMethodInfoNameAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: MyPaymentSetTransactionCustomFieldAction

Fields

Fields Included from * MyPaymentUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: MyPaymentUpdate

Fields

'version int? -

actions MyPaymentUpdateAction[]? -

commercetools.productcatalog: MyPaymentUpdateAction

Fields

action string? -

commercetools.productcatalog: MyShoppingListAddLineItemAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

sku string? -

productId string? -

variantId int? -

quantity int? -

addedAt string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: MyShoppingListAddTextLineItemAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

description LocalizedString? -

quantity int? -

addedAt string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: MyShoppingListChangeLineItemQuantityAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

commercetools.productcatalog: MyShoppingListChangeLineItemsOrderAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

lineItemOrder string[]? -

commercetools.productcatalog: MyShoppingListChangeNameAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: MyShoppingListChangeTextLineItemNameAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

name LocalizedString? -

commercetools.productcatalog: MyShoppingListChangeTextLineItemQuantityAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

quantity int? -

commercetools.productcatalog: MyShoppingListChangeTextLineItemsOrderAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemOrder string[]? -

commercetools.productcatalog: MyShoppingListDraft

Fields

name LocalizedString? -

description LocalizedString? -

lineItems ShoppingListLineItemDraft[]? -

textLineItems TextLineItemDraft[]? -

custom CustomFieldsDraft? -

deleteDaysAfterLastModification int? -

store StoreResourceIdentifier? -

commercetools.productcatalog: MyShoppingListRemoveLineItemAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

commercetools.productcatalog: MyShoppingListRemoveTextLineItemAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

quantity int? -

commercetools.productcatalog: MyShoppingListSetCustomFieldAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: MyShoppingListSetCustomTypeAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyShoppingListSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

deleteDaysAfterLastModification int? -

commercetools.productcatalog: MyShoppingListSetDescriptionAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: MyShoppingListSetLineItemCustomFieldAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: MyShoppingListSetLineItemCustomTypeAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyShoppingListSetTextLineItemCustomFieldAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

name string? -

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

commercetools.productcatalog: MyShoppingListSetTextLineItemCustomTypeAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: MyShoppingListSetTextLineItemDescriptionAction

Fields

Fields Included from * MyShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

description LocalizedString? -

commercetools.productcatalog: MyShoppingListUpdate

Fields

'version int? -

actions MyShoppingListUpdateAction[]? -

commercetools.productcatalog: MyShoppingListUpdateAction

Fields

action string? -

commercetools.productcatalog: MyTransactionDraft

Fields

timestamp string? -

'type TransactionType? -

amount Money? -

interactionId string? -

custom CustomFields? -

commercetools.productcatalog: NoMatchingProductDiscountFoundError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: NotEnabledError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: ObjectNotFoundError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: OrderAddDeliveryAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

items DeliveryItem[]? -

address BaseAddress? -

parcels ParcelDraft[]? -

custom CustomFields? -

commercetools.productcatalog: OrderAddItemShippingAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: OrderAddParcelToDeliveryAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

measurements ParcelMeasurements? -

trackingData TrackingData? -

items DeliveryItem[]? -

commercetools.productcatalog: OrderAddPaymentAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: OrderAddReturnInfoAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

returnTrackingId string? -

items ReturnItemDraft[]? -

returnDate string? -

commercetools.productcatalog: 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.productcatalog: OrderBillingAddressSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

address Address? -

oldAddress Address? -

commercetools.productcatalog: OrderChangeOrderStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

orderState OrderState? -

commercetools.productcatalog: OrderChangePaymentStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

paymentState PaymentState? -

commercetools.productcatalog: OrderChangeShipmentStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

shipmentState ShipmentState? -

commercetools.productcatalog: 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.productcatalog: OrderCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

'order Order? -

commercetools.productcatalog: 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.productcatalog: OrderCustomerEmailSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

email string? -

oldEmail string? -

commercetools.productcatalog: 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.productcatalog: OrderCustomerGroupSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customerGroup CustomerGroupReference? -

oldCustomerGroup CustomerGroupReference? -

commercetools.productcatalog: 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.productcatalog: OrderCustomerSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customer CustomerReference? -

customerGroup CustomerGroupReference? -

oldCustomer CustomerReference? -

oldCustomerGroup CustomerGroupReference? -

commercetools.productcatalog: 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.productcatalog: OrderCustomLineItemDiscountSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

customLineItemId string? -

discountedPricePerQuantity DiscountedLineItemPriceForQuantity[]? -

taxedPrice TaxedItemPrice? -

commercetools.productcatalog: 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.productcatalog: OrderDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

'order Order? -

commercetools.productcatalog: 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.productcatalog: OrderDiscountCodeAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

discountCode DiscountCodeReference? -

commercetools.productcatalog: 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.productcatalog: OrderDiscountCodeRemovedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

discountCode DiscountCodeReference? -

commercetools.productcatalog: 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.productcatalog: OrderDiscountCodeStateSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

discountCode DiscountCodeReference? -

state DiscountCodeState? -

oldState DiscountCodeState? -

commercetools.productcatalog: 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.productcatalog: OrderEditAddStagedActionAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

stagedAction StagedOrderUpdateAction? -

commercetools.productcatalog: OrderEditApplied

Fields

Fields Included from * OrderEditResult

type string
anydata...

'type string? -

appliedAt string? -

excerptBeforeEdit OrderExcerpt? -

excerptAfterEdit OrderExcerpt? -

commercetools.productcatalog: 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.productcatalog: OrderEditAppliedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

edit OrderEditReference? -

result OrderEditApplied? -

commercetools.productcatalog: OrderEditApply

Fields

editVersion int? -

resourceVersion int? -

commercetools.productcatalog: OrderEditDraft

Fields

'key string? -

'resource OrderReference? -

stagedActions StagedOrderUpdateAction[]? -

custom CustomFieldsDraft? -

comment string? -

dryRun boolean? -

commercetools.productcatalog: OrderEditNotProcessed

Fields

Fields Included from * OrderEditResult

type string
anydata...

'type string? -

commercetools.productcatalog: OrderEditPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results OrderEdit[]? -

commercetools.productcatalog: OrderEditPreviewFailure

Fields

Fields Included from * OrderEditResult

type string
anydata...

'type string? -

errors ErrorObject[]? -

commercetools.productcatalog: OrderEditPreviewSuccess

Fields

Fields Included from * OrderEditResult

type string
anydata...

'type string? -

preview StagedOrder? -

messagePayloads MessagePayload[]? -

commercetools.productcatalog: OrderEditReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj OrderEdit? -

commercetools.productcatalog: OrderEditResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: OrderEditResult

Fields

'type string? -

commercetools.productcatalog: OrderEditSetCommentAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

comment string? -

commercetools.productcatalog: OrderEditSetCustomFieldAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: OrderEditSetCustomTypeAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: OrderEditSetKeyAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: OrderEditSetStagedActionsAction

Fields

Fields Included from * OrderEditUpdateAction

action string
anydata...

action string? -

stagedActions StagedOrderUpdateAction[]? -

commercetools.productcatalog: OrderEditUpdate

Fields

'version int? -

actions OrderEditUpdateAction[]? -

dryRun boolean? -

commercetools.productcatalog: OrderEditUpdateAction

Fields

action string? -

commercetools.productcatalog: OrderExcerpt

Fields

totalPrice TypedMoney? -

taxedPrice TaxedPrice? -

'version int? -

commercetools.productcatalog: OrderFromCartDraft

Fields

id string? -

cart CartResourceIdentifier? -

'version int? -

orderNumber string? -

paymentState PaymentState? -

shipmentState ShipmentState? -

orderState OrderState? -

state StateResourceIdentifier? -

commercetools.productcatalog: OrderImportCustomLineItemStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

state ItemState[]? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: OrderImportedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

'order Order? -

commercetools.productcatalog: OrderImportLineItemStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

state ItemState[]? -

commercetools.productcatalog: 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.productcatalog: OrderLineItemAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

lineItem LineItem? -

addedQuantity int? -

commercetools.productcatalog: 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.productcatalog: OrderLineItemDiscountSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

lineItemId string? -

discountedPricePerQuantity DiscountedLineItemPriceForQuantity[]? -

totalPrice Money? -

taxedPrice TaxedItemPrice? -

commercetools.productcatalog: 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.productcatalog: OrderLineItemDistributionChannelSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

lineItemId string? -

distributionChannel ChannelReference? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: OrderPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Order[]? -

commercetools.productcatalog: OrderPagedSearchResponse

Fields

total int? -

offset int? -

'limit int? -

hits Hit[]? -

commercetools.productcatalog: 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.productcatalog: OrderPaymentAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

payment PaymentReference? -

commercetools.productcatalog: 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.productcatalog: OrderPaymentStateChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

paymentState PaymentState? -

oldPaymentState PaymentState? -

commercetools.productcatalog: OrderReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Order? -

commercetools.productcatalog: OrderRemoveDeliveryAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

commercetools.productcatalog: OrderRemoveItemShippingAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

commercetools.productcatalog: OrderRemoveParcelFromDeliveryAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

commercetools.productcatalog: OrderRemovePaymentAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: OrderResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: 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.productcatalog: OrderReturnInfoAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

returnInfo ReturnInfo? -

commercetools.productcatalog: 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.productcatalog: OrderReturnInfoSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

returnInfo ReturnInfo[]? -

commercetools.productcatalog: 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.productcatalog: OrderReturnShipmentStateChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

returnItemId string? -

returnShipmentState ReturnShipmentState? -

commercetools.productcatalog: OrderSearchRequest

Fields

query OrderSearchQuery? -

sort OrderSearchSorting? -

'limit int? -

offset int? -

commercetools.productcatalog: OrderSetBillingAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: OrderSetBillingAddressCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: OrderSetBillingAddressCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetCustomerEmailAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: OrderSetCustomerIdAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customerId string? -

commercetools.productcatalog: OrderSetCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: OrderSetCustomLineItemCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

name string? -

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

commercetools.productcatalog: OrderSetCustomLineItemCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetCustomLineItemShippingDetailsAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: OrderSetCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetDeliveryAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

address BaseAddress? -

commercetools.productcatalog: OrderSetDeliveryAddressCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

name string? -

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

commercetools.productcatalog: OrderSetDeliveryAddressCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetDeliveryCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: OrderSetDeliveryCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetDeliveryItemsAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

items DeliveryItem[]? -

commercetools.productcatalog: OrderSetItemShippingAddressCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

name string? -

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

commercetools.productcatalog: OrderSetItemShippingAddressCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetLineItemCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: OrderSetLineItemCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetLineItemShippingDetailsAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: OrderSetLocaleAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: OrderSetOrderNumberAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

orderNumber string? -

commercetools.productcatalog: OrderSetParcelCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

name string? -

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

commercetools.productcatalog: OrderSetParcelCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetParcelItemsAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

items DeliveryItem[]? -

commercetools.productcatalog: OrderSetParcelMeasurementsAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

measurements ParcelMeasurements? -

commercetools.productcatalog: OrderSetParcelTrackingDataAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

trackingData TrackingData? -

commercetools.productcatalog: OrderSetReturnInfoAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

items ReturnInfoDraft[]? -

commercetools.productcatalog: OrderSetReturnItemCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

name string? -

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

commercetools.productcatalog: OrderSetReturnItemCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetReturnPaymentStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

paymentState ReturnPaymentState? -

commercetools.productcatalog: OrderSetReturnShipmentStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

shipmentState ReturnShipmentState? -

commercetools.productcatalog: OrderSetShippingAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: OrderSetShippingAddressCustomFieldAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: OrderSetShippingAddressCustomTypeAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: OrderSetStoreAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

store StoreResourceIdentifier? -

commercetools.productcatalog: 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.productcatalog: OrderShipmentStateChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

shipmentState ShipmentState? -

oldShipmentState ShipmentState? -

commercetools.productcatalog: 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.productcatalog: OrderShippingAddressSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

address Address? -

oldAddress Address? -

commercetools.productcatalog: 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.productcatalog: OrderShippingInfoSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

shippingInfo ShippingInfo? -

oldShippingInfo ShippingInfo? -

commercetools.productcatalog: 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.productcatalog: OrderShippingRateInputSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

shippingRateInput ShippingRateInput? -

oldShippingRateInput ShippingRateInput? -

commercetools.productcatalog: 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.productcatalog: OrderStateChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

orderState OrderState? -

oldOrderState OrderState? -

commercetools.productcatalog: 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.productcatalog: OrderStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

state StateReference? -

oldState StateReference? -

force boolean? -

commercetools.productcatalog: 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.productcatalog: OrderStoreSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

store StoreKeyReference? -

commercetools.productcatalog: OrderTransitionCustomLineItemStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

quantity int? -

fromState StateResourceIdentifier? -

toState StateResourceIdentifier? -

actualTransitionDate string? -

commercetools.productcatalog: OrderTransitionLineItemStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

fromState StateResourceIdentifier? -

toState StateResourceIdentifier? -

actualTransitionDate string? -

commercetools.productcatalog: OrderTransitionStateAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

state StateResourceIdentifier? -

force boolean? -

commercetools.productcatalog: OrderUpdate

Fields

'version int? -

actions OrderUpdateAction[]? -

commercetools.productcatalog: OrderUpdateAction

Fields

action string? -

commercetools.productcatalog: OrderUpdateItemShippingAddressAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: OrderUpdateSyncInfoAction

Fields

Fields Included from * OrderUpdateAction

action string
anydata...

action string? -

channel ChannelResourceIdentifier? -

externalId string? -

syncedAt string? -

commercetools.productcatalog: OutOfStockError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

lineItems string[]? -

skus string[]? -

commercetools.productcatalog: OverCapacityError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: PagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results BaseResource[]? -

meta record {}? -

commercetools.productcatalog: Parcel

Fields

id string? -

createdAt string? -

measurements ParcelMeasurements? -

trackingData TrackingData? -

items DeliveryItem[]? -

custom CustomFields? -

commercetools.productcatalog: 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.productcatalog: ParcelAddedToDeliveryMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

delivery Delivery? -

parcel Parcel? -

commercetools.productcatalog: ParcelDraft

Fields

measurements ParcelMeasurements? -

trackingData TrackingData? -

items DeliveryItem[]? -

custom CustomFieldsDraft? -

commercetools.productcatalog: 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.productcatalog: ParcelItemsUpdatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

parcelId string? -

deliveryId string? -

items DeliveryItem[]? -

oldItems DeliveryItem[]? -

commercetools.productcatalog: ParcelMeasurements

Fields

heightInMillimeter decimal? -

lengthInMillimeter decimal? -

widthInMillimeter decimal? -

weightInGram decimal? -

commercetools.productcatalog: 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.productcatalog: ParcelMeasurementsUpdatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

deliveryId string? -

parcelId string? -

measurements ParcelMeasurements? -

commercetools.productcatalog: 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.productcatalog: ParcelRemovedFromDeliveryMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

deliveryId string? -

parcel Parcel? -

commercetools.productcatalog: 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.productcatalog: ParcelTrackingDataUpdatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

deliveryId string? -

parcelId string? -

trackingData TrackingData? -

commercetools.productcatalog: PayloadNotIncluded

Fields

reason string? -

payloadType string? -

commercetools.productcatalog: 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.productcatalog: PaymentAddInterfaceInteractionAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: PaymentAddTransactionAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

'transaction TransactionDraft? -

commercetools.productcatalog: PaymentChangeAmountPlannedAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

amount Money? -

commercetools.productcatalog: PaymentChangeTransactionInteractionIdAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

transactionId string? -

interactionId string? -

commercetools.productcatalog: PaymentChangeTransactionStateAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

transactionId string? -

state TransactionState? -

commercetools.productcatalog: PaymentChangeTransactionTimestampAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

transactionId string? -

timestamp string? -

commercetools.productcatalog: 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.productcatalog: PaymentCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

payment Payment? -

commercetools.productcatalog: 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.productcatalog: PaymentInfo

Fields

payments PaymentReference[]? -

commercetools.productcatalog: 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.productcatalog: PaymentInteractionAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

interaction CustomFields? -

commercetools.productcatalog: PaymentMethodInfo

Fields

paymentInterface string? -

method string? -

name LocalizedString? -

commercetools.productcatalog: PaymentPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Payment[]? -

commercetools.productcatalog: PaymentReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Payment? -

commercetools.productcatalog: PaymentResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: PaymentSetAmountPaidAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

amount Money? -

commercetools.productcatalog: PaymentSetAmountRefundedAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

amount Money? -

commercetools.productcatalog: PaymentSetAnonymousIdAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

anonymousId string? -

commercetools.productcatalog: PaymentSetAuthorizationAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

amount Money? -

until string? -

commercetools.productcatalog: PaymentSetCustomerAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

customer CustomerResourceIdentifier? -

commercetools.productcatalog: PaymentSetCustomFieldAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: PaymentSetCustomTypeAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: PaymentSetExternalIdAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

externalId string? -

commercetools.productcatalog: PaymentSetInterfaceIdAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

interfaceId string? -

commercetools.productcatalog: PaymentSetKeyAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: PaymentSetMethodInfoInterfaceAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

interface string? -

commercetools.productcatalog: PaymentSetMethodInfoMethodAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

method string? -

commercetools.productcatalog: PaymentSetMethodInfoNameAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: PaymentSetStatusInterfaceCodeAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

interfaceCode string? -

commercetools.productcatalog: PaymentSetStatusInterfaceTextAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

interfaceText string? -

commercetools.productcatalog: PaymentSetTransactionCustomFieldAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

transactionId string? -

name string? -

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

commercetools.productcatalog: PaymentSetTransactionCustomTypeAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

transactionId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: PaymentStatus

Fields

interfaceCode string? -

interfaceText string? -

state StateReference? -

commercetools.productcatalog: PaymentStatusDraft

Fields

interfaceCode string? -

interfaceText string? -

state StateResourceIdentifier? -

commercetools.productcatalog: 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.productcatalog: PaymentStatusInterfaceCodeSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

paymentId string? -

interfaceCode string? -

commercetools.productcatalog: 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.productcatalog: PaymentStatusStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

state StateReference? -

force boolean? -

commercetools.productcatalog: 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.productcatalog: PaymentTransactionAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

'transaction Transaction? -

commercetools.productcatalog: 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.productcatalog: PaymentTransactionStateChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

transactionId string? -

state TransactionState? -

commercetools.productcatalog: PaymentTransitionStateAction

Fields

Fields Included from * PaymentUpdateAction

action string
anydata...

action string? -

state StateResourceIdentifier? -

force boolean? -

commercetools.productcatalog: PaymentUpdate

Fields

'version int? -

actions PaymentUpdateAction[]? -

commercetools.productcatalog: PaymentUpdateAction

Fields

action string? -

commercetools.productcatalog: PendingOperationError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: Price

Fields

id string? -

value TypedMoney? -

country CountryCode? -

customerGroup CustomerGroupReference? -

channel ChannelReference? -

validFrom string? -

validUntil string? -

discounted DiscountedPrice? -

custom CustomFields? -

tiers PriceTier[]? -

commercetools.productcatalog: PriceChangedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

lineItems string[]? -

shipping boolean? -

commercetools.productcatalog: PriceDraft

Fields

value Money? -

country CountryCode? -

customerGroup CustomerGroupResourceIdentifier? -

channel ChannelResourceIdentifier? -

validFrom string? -

validUntil string? -

custom CustomFieldsDraft? -

tiers PriceTierDraft[]? -

discounted DiscountedPriceDraft? -

commercetools.productcatalog: PriceFunction

Fields

currencyCode CurrencyCode? -

'function string? -

commercetools.productcatalog: PriceTier

Fields

minimumQuantity int? -

value TypedMoney? -

commercetools.productcatalog: PriceTierDraft

Fields

minimumQuantity int? -

value Money? -

commercetools.productcatalog: 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.productcatalog: ProductAddAssetAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

asset AssetDraft? -

position int? -

commercetools.productcatalog: 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.productcatalog: ProductAddedToCategoryMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

category CategoryReference? -

staged boolean? -

commercetools.productcatalog: ProductAddExternalImageAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

image Image? -

staged boolean? -

commercetools.productcatalog: ProductAddPriceAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

price PriceDraft? -

staged boolean? -

commercetools.productcatalog: ProductAddToCategoryAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

category CategoryResourceIdentifier? -

orderHint string? -

staged boolean? -

commercetools.productcatalog: 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.productcatalog: ProductCatalogData

Fields

published boolean? -

current ProductData? -

staged ProductData? -

hasStagedChanges boolean? -

commercetools.productcatalog: ProductChangeAssetNameAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

name LocalizedString? -

commercetools.productcatalog: ProductChangeAssetOrderAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetOrder string[]? -

commercetools.productcatalog: ProductChangeMasterVariantAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

commercetools.productcatalog: ProductChangeNameAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

staged boolean? -

commercetools.productcatalog: ProductChangePriceAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

priceId string? -

price PriceDraft? -

staged boolean? -

commercetools.productcatalog: ProductChangeSlugAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

slug LocalizedString? -

staged boolean? -

commercetools.productcatalog: 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.productcatalog: ProductCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

productProjection ProductProjection? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ProductDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

removedImageUrls string[]? -

currentProjection ProductProjection? -

commercetools.productcatalog: 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.productcatalog: ProductDiscountChangeIsActiveAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

isActive boolean? -

commercetools.productcatalog: ProductDiscountChangeNameAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: ProductDiscountChangePredicateAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

predicate string? -

commercetools.productcatalog: ProductDiscountChangeSortOrderAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

sortOrder string? -

commercetools.productcatalog: ProductDiscountChangeValueAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

value ProductDiscountValueDraft? -

commercetools.productcatalog: ProductDiscountDraft

Fields

name LocalizedString? -

'key string? -

description LocalizedString? -

value ProductDiscountValueDraft? -

predicate string? -

sortOrder string? -

isActive boolean? -

validFrom string? -

validUntil string? -

commercetools.productcatalog: ProductDiscountMatchQuery

Fields

productId string? -

variantId int? -

staged boolean? -

price QueryPrice? -

commercetools.productcatalog: ProductDiscountPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ProductDiscount[]? -

commercetools.productcatalog: ProductDiscountReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj ProductDiscount? -

commercetools.productcatalog: ProductDiscountResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ProductDiscountSetDescriptionAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: ProductDiscountSetKeyAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ProductDiscountSetValidFromAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

commercetools.productcatalog: ProductDiscountSetValidFromAndUntilAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

validFrom string? -

validUntil string? -

commercetools.productcatalog: ProductDiscountSetValidUntilAction

Fields

Fields Included from * ProductDiscountUpdateAction

action string
anydata...

action string? -

validUntil string? -

commercetools.productcatalog: ProductDiscountUpdate

Fields

'version int? -

actions ProductDiscountUpdateAction[]? -

commercetools.productcatalog: ProductDiscountUpdateAction

Fields

action string? -

commercetools.productcatalog: ProductDiscountValue

Fields

'type string? -

commercetools.productcatalog: ProductDiscountValueAbsolute

Fields

Fields Included from * ProductDiscountValue

type string
anydata...

'type string? -

money TypedMoney[]? -

commercetools.productcatalog: ProductDiscountValueAbsoluteDraft

Fields

Fields Included from * ProductDiscountValueDraft

type string
anydata...

'type string? -

money Money[]? -

commercetools.productcatalog: ProductDiscountValueDraft

Fields

'type string? -

commercetools.productcatalog: ProductDiscountValueExternal

Fields

Fields Included from * ProductDiscountValue

type string
anydata...

'type string? -

commercetools.productcatalog: ProductDiscountValueExternalDraft

Fields

Fields Included from * ProductDiscountValueDraft

type string
anydata...

'type string? -

commercetools.productcatalog: ProductDiscountValueRelative

Fields

Fields Included from * ProductDiscountValue

type string
anydata...

'type string? -

permyriad int? -

commercetools.productcatalog: ProductDiscountValueRelativeDraft

Fields

Fields Included from * ProductDiscountValueDraft

type string
anydata...

'type string? -

permyriad int? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ProductImageAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

variantId int? -

image Image? -

staged boolean? -

commercetools.productcatalog: ProductLegacySetSkuAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

sku string? -

variantId int? -

commercetools.productcatalog: ProductMoveImageToPositionAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

imageUrl string? -

position int? -

staged boolean? -

commercetools.productcatalog: ProductPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Product[]? -

commercetools.productcatalog: 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.productcatalog: ProductPriceDiscountsSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

updatedPrices ProductPriceDiscountsSetUpdatedPrice[]? -

commercetools.productcatalog: ProductPriceDiscountsSetUpdatedPrice

Fields

variantId int? -

variantKey string? -

sku string? -

priceId string? -

discounted DiscountedPrice? -

staged boolean? -

commercetools.productcatalog: 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.productcatalog: ProductPriceExternalDiscountSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

variantId int? -

variantKey string? -

sku string? -

priceId string? -

discounted DiscountedPrice? -

staged boolean? -

commercetools.productcatalog: 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.productcatalog: ProductProjectionPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ProductProjection[]? -

commercetools.productcatalog: ProductProjectionPagedSearchResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ProductProjection[]? -

commercetools.productcatalog: ProductPublishAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

scope ProductPublishScope? -

commercetools.productcatalog: 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.productcatalog: ProductPublishedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

removedImageUrls string[]? -

productProjection ProductProjection? -

scope ProductPublishScope? -

commercetools.productcatalog: ProductReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Product? -

commercetools.productcatalog: ProductRemoveAssetAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

commercetools.productcatalog: 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.productcatalog: ProductRemovedFromCategoryMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

category CategoryReference? -

staged boolean? -

commercetools.productcatalog: ProductRemoveFromCategoryAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

category CategoryResourceIdentifier? -

staged boolean? -

commercetools.productcatalog: ProductRemoveImageAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

imageUrl string? -

staged boolean? -

commercetools.productcatalog: ProductRemovePriceAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

priceId string? -

staged boolean? -

commercetools.productcatalog: ProductRemoveVariantAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

id int? -

sku string? -

staged boolean? -

commercetools.productcatalog: ProductResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: 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.productcatalog: ProductRevertedStagedChangesMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

removedImageUrls string[]? -

commercetools.productcatalog: ProductRevertStagedChangesAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

commercetools.productcatalog: ProductRevertStagedVariantChangesAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

commercetools.productcatalog: 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.productcatalog: ProductSelectionAddProductAction

Fields

Fields Included from * ProductSelectionUpdateAction

action string
anydata...

action string? -

product ProductResourceIdentifier? -

commercetools.productcatalog: ProductSelectionAssignment

Fields

product ProductReference? -

productSelection ProductSelectionReference? -

commercetools.productcatalog: ProductSelectionChangeNameAction

Fields

Fields Included from * ProductSelectionUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: 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.productcatalog: ProductSelectionCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

productSelection ProductSelectionType? -

commercetools.productcatalog: 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.productcatalog: ProductSelectionDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

name LocalizedString? -

commercetools.productcatalog: ProductSelectionDraft

Fields

'key string? -

name LocalizedString? -

commercetools.productcatalog: ProductSelectionPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results ProductSelection[]? -

commercetools.productcatalog: 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.productcatalog: ProductSelectionProductAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

product ProductReference? -

commercetools.productcatalog: ProductSelectionProductPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results AssignedProductReference[]? -

commercetools.productcatalog: 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.productcatalog: ProductSelectionProductRemovedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

product ProductReference? -

commercetools.productcatalog: ProductSelectionReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj ProductSelection? -

commercetools.productcatalog: ProductSelectionRemoveProductAction

Fields

Fields Included from * ProductSelectionUpdateAction

action string
anydata...

action string? -

product ProductResourceIdentifier? -

commercetools.productcatalog: ProductSelectionResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ProductSelectionSetKeyAction

Fields

Fields Included from * ProductSelectionUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ProductSelectionSetting

Fields

productSelection ProductSelectionReference? -

active boolean? -

commercetools.productcatalog: ProductSelectionSettingDraft

Fields

productSelection ProductSelectionResourceIdentifier? -

active boolean? -

commercetools.productcatalog: ProductSelectionType

Fields

'type ProductSelectionTypeEnum? -

commercetools.productcatalog: ProductSelectionUpdate

Fields

'version int? -

actions ProductSelectionUpdateAction[]? -

commercetools.productcatalog: ProductSelectionUpdateAction

Fields

action string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ProductSetAssetDescriptionAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

description LocalizedString? -

commercetools.productcatalog: ProductSetAssetKeyAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

commercetools.productcatalog: ProductSetAssetSourcesAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

sources AssetSource[]? -

commercetools.productcatalog: ProductSetAssetTagsAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

assetId string? -

assetKey string? -

tags string[]? -

commercetools.productcatalog: 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.productcatalog: ProductSetAttributeInAllVariantsAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

name string? -

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

staged boolean? -

commercetools.productcatalog: ProductSetCategoryOrderHintAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

categoryId string? -

orderHint string? -

staged boolean? -

commercetools.productcatalog: ProductSetDescriptionAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

staged boolean? -

commercetools.productcatalog: ProductSetDiscountedPriceAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

priceId string? -

staged boolean? -

discounted DiscountedPriceDraft? -

commercetools.productcatalog: ProductSetImageLabelAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

sku string? -

variantId int? -

imageUrl string? -

label string? -

staged boolean? -

commercetools.productcatalog: ProductSetKeyAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ProductSetMetaDescriptionAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

metaDescription LocalizedString? -

staged boolean? -

commercetools.productcatalog: ProductSetMetaKeywordsAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

metaKeywords LocalizedString? -

staged boolean? -

commercetools.productcatalog: ProductSetMetaTitleAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

metaTitle LocalizedString? -

staged boolean? -

commercetools.productcatalog: ProductSetPricesAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

prices PriceDraft[]? -

staged boolean? -

commercetools.productcatalog: 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.productcatalog: ProductSetProductPriceCustomTypeAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

priceId string? -

staged boolean? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ProductSetProductVariantKeyAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

'key string? -

staged boolean? -

commercetools.productcatalog: ProductSetSearchKeywordsAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

searchKeywords SearchKeywords? -

staged boolean? -

commercetools.productcatalog: ProductSetSkuAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

variantId int? -

sku string? -

staged boolean? -

commercetools.productcatalog: ProductSetTaxCategoryAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

taxCategory TaxCategoryResourceIdentifier? -

commercetools.productcatalog: ProductsInStorePagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results ProductSelectionAssignment[]? -

commercetools.productcatalog: 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.productcatalog: ProductSlugChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

slug LocalizedString? -

oldSlug LocalizedString? -

commercetools.productcatalog: 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.productcatalog: ProductStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

state StateReference? -

force boolean? -

commercetools.productcatalog: ProductTransitionStateAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

state StateResourceIdentifier? -

force boolean? -

commercetools.productcatalog: 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.productcatalog: ProductTypeAddAttributeDefinitionAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attribute AttributeDefinitionDraft? -

commercetools.productcatalog: ProductTypeAddLocalizedEnumValueAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

value AttributeLocalizedEnumValue? -

commercetools.productcatalog: ProductTypeAddPlainEnumValueAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

value AttributePlainEnumValue? -

commercetools.productcatalog: ProductTypeChangeAttributeConstraintAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

newValue AttributeConstraintEnumDraft? -

commercetools.productcatalog: ProductTypeChangeAttributeNameAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

newAttributeName string? -

commercetools.productcatalog: ProductTypeChangeAttributeOrderAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributes AttributeDefinition[]? -

commercetools.productcatalog: ProductTypeChangeAttributeOrderByNameAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeNames string[]? -

commercetools.productcatalog: ProductTypeChangeDescriptionAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

description string? -

commercetools.productcatalog: ProductTypeChangeEnumKeyAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

'key string? -

newKey string? -

commercetools.productcatalog: ProductTypeChangeInputHintAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

newValue TextInputHint? -

commercetools.productcatalog: ProductTypeChangeIsSearchableAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

isSearchable boolean? -

commercetools.productcatalog: ProductTypeChangeLabelAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

label LocalizedString? -

commercetools.productcatalog: ProductTypeChangeLocalizedEnumValueLabelAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

newValue AttributeLocalizedEnumValue? -

commercetools.productcatalog: ProductTypeChangeLocalizedEnumValueOrderAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

values AttributeLocalizedEnumValue[]? -

commercetools.productcatalog: ProductTypeChangeNameAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: ProductTypeChangePlainEnumValueLabelAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

newValue AttributePlainEnumValue? -

commercetools.productcatalog: ProductTypeChangePlainEnumValueOrderAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

values AttributePlainEnumValue[]? -

commercetools.productcatalog: ProductTypeDraft

Fields

'key string? -

name string? -

description string? -

attributes AttributeDefinitionDraft[]? -

commercetools.productcatalog: ProductTypePagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ProductType[]? -

commercetools.productcatalog: ProductTypeReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj ProductType? -

commercetools.productcatalog: ProductTypeRemoveAttributeDefinitionAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: ProductTypeRemoveEnumValuesAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

keys string[]? -

commercetools.productcatalog: ProductTypeResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ProductTypeSetInputTipAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

attributeName string? -

inputTip LocalizedString? -

commercetools.productcatalog: ProductTypeSetKeyAction

Fields

Fields Included from * ProductTypeUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ProductTypeUpdate

Fields

'version int? -

actions ProductTypeUpdateAction[]? -

commercetools.productcatalog: ProductTypeUpdateAction

Fields

action string? -

commercetools.productcatalog: ProductUnpublishAction

Fields

Fields Included from * ProductUpdateAction

action string
anydata...

action string? -

commercetools.productcatalog: 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.productcatalog: ProductUnpublishedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

commercetools.productcatalog: ProductUpdate

Fields

'version int? -

actions ProductUpdateAction[]? -

commercetools.productcatalog: ProductUpdateAction

Fields

action string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ProductVariantAddedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

variant ProductVariant? -

staged boolean? -

commercetools.productcatalog: ProductVariantAvailability

Fields

isOnStock boolean? -

restockableInDays int? -

availableQuantity int? -

channels ProductVariantChannelAvailabilityMap? -

commercetools.productcatalog: ProductVariantChannelAvailability

Fields

isOnStock boolean? -

restockableInDays int? -

availableQuantity int? -

commercetools.productcatalog: ProductVariantChannelAvailabilityMap

commercetools.productcatalog: 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.productcatalog: ProductVariantDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

variant ProductVariant? -

removedImageUrls string[]? -

commercetools.productcatalog: ProductVariantDraft

Fields

sku string? -

'key string? -

prices PriceDraft[]? -

attributes Attribute[]? -

images Image[]? -

assets AssetDraft[]? -

commercetools.productcatalog: ProductVariantImportDraft

Fields

id int? -

sku string? -

prices PriceDraft[]? -

attributes Attribute[]? -

images Image[]? -

commercetools.productcatalog: 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.productcatalog: ProjectChangeCartsConfigurationAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

cartsConfiguration CartsConfiguration? -

commercetools.productcatalog: ProjectChangeCountriesAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

countries CountryCode[]? -

commercetools.productcatalog: ProjectChangeCountryTaxRateFallbackEnabledAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

countryTaxRateFallbackEnabled boolean? -

commercetools.productcatalog: ProjectChangeCurrenciesAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

currencies CurrencyCode[]? -

commercetools.productcatalog: ProjectChangeLanguagesAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

languages Locale[]? -

commercetools.productcatalog: ProjectChangeMessagesConfigurationAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

messagesConfiguration MessageConfigurationDraft? -

commercetools.productcatalog: ProjectChangeMessagesEnabledAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

messagesEnabled boolean? -

commercetools.productcatalog: ProjectChangeNameAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: ProjectChangeOrderSearchStatusAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

status OrderSearchStatus? -

commercetools.productcatalog: ProjectChangeProductSearchIndexingEnabledAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

enabled boolean? -

commercetools.productcatalog: ProjectChangeShoppingListsConfigurationAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

shoppingListsConfiguration ShoppingListsConfiguration? -

commercetools.productcatalog: ProjectNotConfiguredForLanguagesError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

languages string[]? -

commercetools.productcatalog: ProjectSetExternalOAuthAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

externalOAuth ExternalOAuth? -

commercetools.productcatalog: ProjectSetShippingRateInputTypeAction

Fields

Fields Included from * ProjectUpdateAction

action string
anydata...

action string? -

shippingRateInputType ShippingRateInputType? -

commercetools.productcatalog: ProjectUpdate

Fields

'version int? -

actions ProjectUpdateAction[]? -

commercetools.productcatalog: ProjectUpdateAction

Fields

action string? -

commercetools.productcatalog: 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.productcatalog: QueryComplexityLimitExceededError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: QueryPrice

Fields

id string? -

value Money? -

country CountryCode? -

customerGroup CustomerGroupReference? -

channel ChannelReference? -

validFrom string? -

validUntil string? -

discounted DiscountedPriceDraft? -

custom CustomFields? -

tiers PriceTierDraft[]? -

commercetools.productcatalog: QueryTimedOutError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: RangeFacetResult

Fields

Fields Included from * FacetResult

type FacetTypes
anydata...

'type FacetTypes? -

ranges FacetResultRange[]? -

commercetools.productcatalog: Reference

Fields

typeId ReferenceTypeId? -

id string? -

commercetools.productcatalog: ReferencedResourceNotFoundError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ReferenceExistsError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

referencedBy ReferenceTypeId? -

commercetools.productcatalog: ReplicaCartDraft

Fields

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

'key string? -

commercetools.productcatalog: RequiredFieldError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

'field string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ResourceIdentifier

Fields

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ResourceNotFoundError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ResourceSizeLimitExceededError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: ReturnInfo

Fields

items ReturnItem[]? -

returnTrackingId string? -

returnDate string? -

commercetools.productcatalog: ReturnInfoDraft

Fields

items ReturnItemDraft[]? -

returnTrackingId string? -

returnDate string? -

commercetools.productcatalog: ReturnItem

Fields

id string? -

quantity int? -

'type string? -

comment string? -

shipmentState ReturnShipmentState? -

paymentState ReturnPaymentState? -

custom CustomFields? -

lastModifiedAt string? -

createdAt string? -

commercetools.productcatalog: ReturnItemDraft

Fields

quantity int? -

lineItemId string? -

customLineItemId string? -

comment string? -

shipmentState ReturnShipmentState? -

custom CustomFieldsDraft? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ReviewCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

review Review? -

commercetools.productcatalog: 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.productcatalog: ReviewPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Review[]? -

commercetools.productcatalog: 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.productcatalog: ReviewRatingSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

oldRating decimal? -

newRating decimal? -

includedInStatistics boolean? -

target Reference? -

commercetools.productcatalog: ReviewRatingStatistics

Fields

averageRating decimal? -

highestRating decimal? -

lowestRating decimal? -

count int? -

ratingsDistribution record {}? -

commercetools.productcatalog: ReviewReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Review? -

commercetools.productcatalog: ReviewResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ReviewSetAuthorNameAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

authorName string? -

commercetools.productcatalog: ReviewSetCustomerAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

customer CustomerResourceIdentifier? -

commercetools.productcatalog: ReviewSetCustomFieldAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: ReviewSetCustomTypeAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ReviewSetKeyAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ReviewSetLocaleAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: ReviewSetRatingAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

rating int? -

commercetools.productcatalog: ReviewSetTargetAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

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

commercetools.productcatalog: ReviewSetTextAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

text string? -

commercetools.productcatalog: ReviewSetTitleAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

title string? -

commercetools.productcatalog: 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.productcatalog: ReviewStateTransitionMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

oldState StateReference? -

newState StateReference? -

oldIncludedInStatistics boolean? -

newIncludedInStatistics boolean? -

target Reference? -

force boolean? -

commercetools.productcatalog: ReviewTransitionStateAction

Fields

Fields Included from * ReviewUpdateAction

action string
anydata...

action string? -

state StateResourceIdentifier? -

force boolean? -

commercetools.productcatalog: ReviewUpdate

Fields

'version int? -

actions ReviewUpdateAction[]? -

commercetools.productcatalog: ReviewUpdateAction

Fields

action string? -

commercetools.productcatalog: ScopedPrice

Fields

id string? -

value TypedMoney? -

currentValue TypedMoney? -

country CountryCode? -

customerGroup CustomerGroupReference? -

channel ChannelReference? -

validFrom string? -

validUntil string? -

discounted DiscountedPrice? -

custom CustomFields? -

commercetools.productcatalog: ScoreShippingRateInput

Fields

Fields Included from * ShippingRateInput

type string
anydata...

'type string? -

score decimal? -

commercetools.productcatalog: ScoreShippingRateInputDraft

Fields

Fields Included from * ShippingRateInputDraft

type string
anydata...

'type string? -

score decimal? -

commercetools.productcatalog: SearchDeactivatedError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: SearchExecutionFailureError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: SearchFacetPathNotFoundError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: SearchIndexingConfiguration

Fields

products SearchIndexingConfigurationValues? -

orders SearchIndexingConfigurationValues? -

commercetools.productcatalog: SearchIndexingConfigurationValues

Fields

status SearchIndexingConfigurationStatus? -

lastModifiedAt string? -

lastModifiedBy LastModifiedBy? -

commercetools.productcatalog: SearchIndexingInProgressError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: SearchKeyword

Fields

text string? -

suggestTokenizer SuggestTokenizer? -

commercetools.productcatalog: SearchKeywords

commercetools.productcatalog: SemanticErrorError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ShippingInfo

Fields

shippingMethodName string? -

price TypedMoney? -

shippingRate ShippingRate? -

taxedPrice TaxedItemPrice? -

taxRate TaxRate? -

taxCategory TaxCategoryReference? -

shippingMethod ShippingMethodReference? -

deliveries Delivery[]? -

discountedPrice DiscountedLineItemPrice? -

shippingMethodState ShippingMethodState? -

commercetools.productcatalog: ShippingInfoImportDraft

Fields

shippingMethodName string? -

price Money? -

shippingRate ShippingRateDraft? -

taxRate TaxRate? -

taxCategory TaxCategoryResourceIdentifier? -

shippingMethod ShippingMethodResourceIdentifier? -

deliveries Delivery[]? -

discountedPrice DiscountedLineItemPriceDraft? -

shippingMethodState ShippingMethodState? -

commercetools.productcatalog: 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.productcatalog: ShippingMethodAddShippingRateAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

zone ZoneResourceIdentifier? -

shippingRate ShippingRateDraft? -

commercetools.productcatalog: ShippingMethodAddZoneAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

zone ZoneResourceIdentifier? -

commercetools.productcatalog: ShippingMethodChangeIsDefaultAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

isDefault boolean? -

commercetools.productcatalog: ShippingMethodChangeNameAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: ShippingMethodChangeTaxCategoryAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

taxCategory TaxCategoryResourceIdentifier? -

commercetools.productcatalog: ShippingMethodDoesNotMatchCartError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: ShippingMethodDraft

Fields

'key string? -

name string? -

localizedName LocalizedString? -

description string? -

localizedDescription LocalizedString? -

taxCategory TaxCategoryResourceIdentifier? -

zoneRates ZoneRateDraft[]? -

isDefault boolean? -

predicate string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: ShippingMethodPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ShippingMethod[]? -

commercetools.productcatalog: ShippingMethodReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj ShippingMethod? -

commercetools.productcatalog: ShippingMethodRemoveShippingRateAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

zone ZoneResourceIdentifier? -

shippingRate ShippingRateDraft? -

commercetools.productcatalog: ShippingMethodRemoveZoneAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

zone ZoneResourceIdentifier? -

commercetools.productcatalog: ShippingMethodResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ShippingMethodSetCustomFieldAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: ShippingMethodSetCustomTypeAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ShippingMethodSetDescriptionAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

description string? -

commercetools.productcatalog: ShippingMethodSetKeyAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ShippingMethodSetLocalizedDescriptionAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

localizedDescription LocalizedString? -

commercetools.productcatalog: ShippingMethodSetLocalizedNameAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

localizedName LocalizedString? -

commercetools.productcatalog: ShippingMethodSetPredicateAction

Fields

Fields Included from * ShippingMethodUpdateAction

action string
anydata...

action string? -

predicate string? -

commercetools.productcatalog: ShippingMethodUpdate

Fields

'version int? -

actions ShippingMethodUpdateAction[]? -

commercetools.productcatalog: ShippingMethodUpdateAction

Fields

action string? -

commercetools.productcatalog: ShippingRate

Fields

price TypedMoney? -

freeAbove TypedMoney? -

isMatching boolean? -

tiers ShippingRatePriceTier[]? -

commercetools.productcatalog: ShippingRateDraft

Fields

price Money? -

freeAbove Money? -

tiers ShippingRatePriceTier[]? -

commercetools.productcatalog: ShippingRateInput

Fields

'type string? -

commercetools.productcatalog: ShippingRateInputDraft

Fields

'type string? -

commercetools.productcatalog: ShippingRateInputType

Fields

'type ShippingRateTierType? -

commercetools.productcatalog: ShippingRatePriceTier

Fields

'type ShippingRateTierType? -

commercetools.productcatalog: 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.productcatalog: ShoppingListAddLineItemAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

sku string? -

productId string? -

variantId int? -

quantity int? -

addedAt string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: ShoppingListAddTextLineItemAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

description LocalizedString? -

quantity int? -

addedAt string? -

custom CustomFieldsDraft? -

commercetools.productcatalog: ShoppingListChangeLineItemQuantityAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

commercetools.productcatalog: ShoppingListChangeLineItemsOrderAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

lineItemOrder string[]? -

commercetools.productcatalog: ShoppingListChangeNameAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: ShoppingListChangeTextLineItemNameAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

name LocalizedString? -

commercetools.productcatalog: ShoppingListChangeTextLineItemQuantityAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

quantity int? -

commercetools.productcatalog: ShoppingListChangeTextLineItemsOrderAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemOrder string[]? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: ShoppingListLineItemDraft

Fields

addedAt string? -

custom CustomFieldsDraft? -

sku string? -

productId string? -

quantity int? -

variantId int? -

commercetools.productcatalog: ShoppingListPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results ShoppingList[]? -

commercetools.productcatalog: ShoppingListReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj ShoppingList? -

commercetools.productcatalog: ShoppingListRemoveLineItemAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

commercetools.productcatalog: ShoppingListRemoveTextLineItemAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

quantity int? -

commercetools.productcatalog: ShoppingListResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ShoppingListsConfiguration

Fields

deleteDaysAfterLastModification int? -

commercetools.productcatalog: ShoppingListSetAnonymousIdAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

anonymousId string? -

commercetools.productcatalog: ShoppingListSetCustomerAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

customer CustomerResourceIdentifier? -

commercetools.productcatalog: ShoppingListSetCustomFieldAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: ShoppingListSetCustomTypeAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ShoppingListSetDeleteDaysAfterLastModificationAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

deleteDaysAfterLastModification int? -

commercetools.productcatalog: ShoppingListSetDescriptionAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: ShoppingListSetKeyAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ShoppingListSetLineItemCustomFieldAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: ShoppingListSetLineItemCustomTypeAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ShoppingListSetSlugAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

slug LocalizedString? -

commercetools.productcatalog: ShoppingListSetStoreAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

store StoreResourceIdentifier? -

commercetools.productcatalog: ShoppingListSetTextLineItemCustomFieldAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

name string? -

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

commercetools.productcatalog: ShoppingListSetTextLineItemCustomTypeAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: ShoppingListSetTextLineItemDescriptionAction

Fields

Fields Included from * ShoppingListUpdateAction

action string
anydata...

action string? -

textLineItemId string? -

description LocalizedString? -

commercetools.productcatalog: ShoppingListStoreSetMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

store StoreKeyReference? -

commercetools.productcatalog: ShoppingListUpdate

Fields

'version int? -

actions ShoppingListUpdateAction[]? -

commercetools.productcatalog: ShoppingListUpdateAction

Fields

action string? -

commercetools.productcatalog: SnsDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

accessKey string? -

accessSecret string? -

topicArn string? -

commercetools.productcatalog: SqsDestination

Fields

Fields Included from * Destination

type string
anydata...

'type string? -

accessKey string? -

accessSecret string? -

queueUrl string? -

region string? -

commercetools.productcatalog: 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.productcatalog: 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.productcatalog: StagedOrderAddDeliveryAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

items DeliveryItem[]? -

address BaseAddress? -

parcels ParcelDraft[]? -

custom CustomFields? -

commercetools.productcatalog: StagedOrderAddDiscountCodeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

code string? -

commercetools.productcatalog: StagedOrderAddItemShippingAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: 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.productcatalog: StagedOrderAddParcelToDeliveryAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

measurements ParcelMeasurements? -

trackingData TrackingData? -

items DeliveryItem[]? -

commercetools.productcatalog: StagedOrderAddPaymentAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: StagedOrderAddReturnInfoAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

returnTrackingId string? -

items ReturnItemDraft[]? -

returnDate string? -

commercetools.productcatalog: StagedOrderAddShoppingListAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

shoppingList ShoppingListResourceIdentifier? -

supplyChannel ChannelResourceIdentifier? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StagedOrderChangeCustomLineItemMoneyAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

money Money? -

commercetools.productcatalog: StagedOrderChangeCustomLineItemQuantityAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

quantity decimal? -

commercetools.productcatalog: StagedOrderChangeLineItemQuantityAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity decimal? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.productcatalog: StagedOrderChangeOrderStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

orderState OrderState? -

commercetools.productcatalog: StagedOrderChangePaymentStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

paymentState PaymentState? -

commercetools.productcatalog: StagedOrderChangeShipmentStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

shipmentState ShipmentState? -

commercetools.productcatalog: StagedOrderChangeTaxCalculationModeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

taxCalculationMode TaxCalculationMode? -

commercetools.productcatalog: StagedOrderChangeTaxModeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

taxMode TaxMode? -

commercetools.productcatalog: StagedOrderChangeTaxRoundingModeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

taxRoundingMode RoundingMode? -

commercetools.productcatalog: StagedOrderImportCustomLineItemStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

state ItemState[]? -

commercetools.productcatalog: StagedOrderImportLineItemStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

state ItemState[]? -

commercetools.productcatalog: StagedOrderRemoveCustomLineItemAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

commercetools.productcatalog: StagedOrderRemoveDeliveryAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

commercetools.productcatalog: StagedOrderRemoveDiscountCodeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

discountCode DiscountCodeReference? -

commercetools.productcatalog: StagedOrderRemoveItemShippingAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

commercetools.productcatalog: StagedOrderRemoveLineItemAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity decimal? -

externalPrice Money? -

externalTotalPrice ExternalLineItemTotalPrice? -

shippingDetailsToRemove ItemShippingDetailsDraft? -

commercetools.productcatalog: StagedOrderRemoveParcelFromDeliveryAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

commercetools.productcatalog: StagedOrderRemovePaymentAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

payment PaymentResourceIdentifier? -

commercetools.productcatalog: StagedOrderSetBillingAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: StagedOrderSetBillingAddressCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetBillingAddressCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetCountryAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

country string? -

commercetools.productcatalog: StagedOrderSetCustomerEmailAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

email string? -

commercetools.productcatalog: StagedOrderSetCustomerGroupAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customerGroup CustomerGroupResourceIdentifier? -

commercetools.productcatalog: StagedOrderSetCustomerIdAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customerId string? -

commercetools.productcatalog: StagedOrderSetCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetCustomLineItemCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetCustomLineItemCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetCustomLineItemShippingDetailsAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: StagedOrderSetCustomLineItemTaxAmountAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: StagedOrderSetCustomLineItemTaxRateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetCustomShippingMethodAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

shippingMethodName string? -

shippingRate ShippingRateDraft? -

taxCategory TaxCategoryResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetDeliveryAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

address BaseAddress? -

commercetools.productcatalog: StagedOrderSetDeliveryAddressCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetDeliveryAddressCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetDeliveryCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetDeliveryCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: StagedOrderSetDeliveryItemsAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

deliveryId string? -

items DeliveryItem[]? -

commercetools.productcatalog: StagedOrderSetItemShippingAddressCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetItemShippingAddressCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

addressKey string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetLineItemCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetLineItemCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetLineItemDistributionChannelAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StagedOrderSetLineItemPriceAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalPrice Money? -

commercetools.productcatalog: StagedOrderSetLineItemShippingDetailsAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

shippingDetails ItemShippingDetailsDraft? -

commercetools.productcatalog: StagedOrderSetLineItemTaxAmountAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: StagedOrderSetLineItemTaxRateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetLineItemTotalPriceAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

externalTotalPrice ExternalLineItemTotalPrice? -

commercetools.productcatalog: StagedOrderSetLocaleAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

locale string? -

commercetools.productcatalog: StagedOrderSetOrderNumberAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

orderNumber string? -

commercetools.productcatalog: StagedOrderSetOrderTotalTaxAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

externalTotalGross Money? -

externalTaxPortions TaxPortionDraft[]? -

commercetools.productcatalog: StagedOrderSetParcelCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetParcelCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: StagedOrderSetParcelItemsAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

items DeliveryItem[]? -

commercetools.productcatalog: StagedOrderSetParcelMeasurementsAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

measurements ParcelMeasurements? -

commercetools.productcatalog: StagedOrderSetParcelTrackingDataAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

parcelId string? -

trackingData TrackingData? -

commercetools.productcatalog: StagedOrderSetReturnInfoAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

items ReturnInfoDraft[]? -

commercetools.productcatalog: StagedOrderSetReturnItemCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetReturnItemCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: StagedOrderSetReturnPaymentStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

paymentState ReturnPaymentState? -

commercetools.productcatalog: StagedOrderSetReturnShipmentStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

returnItemId string? -

shipmentState ReturnShipmentState? -

commercetools.productcatalog: StagedOrderSetShippingAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: StagedOrderSetShippingAddressAndCustomShippingMethodAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

shippingMethodName string? -

shippingRate ShippingRateDraft? -

taxCategory TaxCategoryResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetShippingAddressAndShippingMethodAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

shippingMethod ShippingMethodResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetShippingAddressCustomFieldAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: StagedOrderSetShippingAddressCustomTypeAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields FieldContainer? -

commercetools.productcatalog: StagedOrderSetShippingMethodAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

shippingMethod ShippingMethodResourceIdentifier? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetShippingMethodTaxAmountAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

externalTaxAmount ExternalTaxAmountDraft? -

commercetools.productcatalog: StagedOrderSetShippingMethodTaxRateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

externalTaxRate ExternalTaxRateDraft? -

commercetools.productcatalog: StagedOrderSetShippingRateInputAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

shippingRateInput ShippingRateInputDraft? -

commercetools.productcatalog: StagedOrderTransitionCustomLineItemStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

customLineItemId string? -

quantity int? -

fromState StateResourceIdentifier? -

toState StateResourceIdentifier? -

actualTransitionDate string? -

commercetools.productcatalog: StagedOrderTransitionLineItemStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

lineItemId string? -

quantity int? -

fromState StateResourceIdentifier? -

toState StateResourceIdentifier? -

actualTransitionDate string? -

commercetools.productcatalog: StagedOrderTransitionStateAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

state StateResourceIdentifier? -

force boolean? -

commercetools.productcatalog: StagedOrderUpdateAction

Fields

action string? -

commercetools.productcatalog: StagedOrderUpdateItemShippingAddressAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

address BaseAddress? -

commercetools.productcatalog: StagedOrderUpdateSyncInfoAction

Fields

Fields Included from * StagedOrderUpdateAction

action string
anydata...

action string? -

channel ChannelResourceIdentifier? -

externalId string? -

syncedAt string? -

commercetools.productcatalog: 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.productcatalog: StateAddRolesAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

roles StateRoleEnum[]? -

commercetools.productcatalog: StateChangeInitialAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

initial boolean? -

commercetools.productcatalog: StateChangeKeyAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: StateChangeTypeAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

'type StateTypeEnum? -

commercetools.productcatalog: StateDraft

Fields

'key string? -

'type StateTypeEnum? -

name LocalizedString? -

description LocalizedString? -

initial boolean? -

roles StateRoleEnum[]? -

transitions StateResourceIdentifier[]? -

commercetools.productcatalog: StatePagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results State[]? -

commercetools.productcatalog: StateReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj State? -

commercetools.productcatalog: StateRemoveRolesAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

roles StateRoleEnum[]? -

commercetools.productcatalog: StateResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: StateSetDescriptionAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: StateSetNameAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: StateSetRolesAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

roles StateRoleEnum[]? -

commercetools.productcatalog: StateSetTransitionsAction

Fields

Fields Included from * StateUpdateAction

action string
anydata...

action string? -

transitions StateResourceIdentifier[]? -

commercetools.productcatalog: StateUpdate

Fields

'version int? -

actions StateUpdateAction[]? -

commercetools.productcatalog: StateUpdateAction

Fields

action string? -

commercetools.productcatalog: 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.productcatalog: StoreAddDistributionChannelAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StoreAddProductSelectionAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

productSelection ProductSelectionSettingDraft? -

commercetools.productcatalog: StoreAddSupplyChannelAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StoreChangeProductSelectionAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

productSelection ResourceIdentifier? -

active boolean? -

commercetools.productcatalog: 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.productcatalog: StoreCreatedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

name LocalizedString? -

languages string[]? -

distributionChannels ChannelReference[]? -

supplyChannels ChannelReference[]? -

productSelections ProductSelectionSetting[]? -

custom CustomFields? -

commercetools.productcatalog: 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.productcatalog: StoreDeletedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

commercetools.productcatalog: StoreDraft

Fields

'key string? -

name LocalizedString? -

languages string[]? -

distributionChannels ChannelResourceIdentifier[]? -

supplyChannels ChannelResourceIdentifier[]? -

productSelections ProductSelectionSettingDraft[]? -

custom CustomFieldsDraft? -

commercetools.productcatalog: StoreKeyReference

Fields

Fields Included from * KeyReference

typeId ReferenceTypeId
key string
anydata...

typeId ReferenceTypeId? -

'key string? -

commercetools.productcatalog: StorePagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Store[]? -

commercetools.productcatalog: 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.productcatalog: StoreProductSelectionsChangedMessagePayload

Fields

Fields Included from * MessagePayload

type string
anydata...

'type string? -

addedProductSelections ProductSelectionSetting[]? -

removedProductSelections ProductSelectionSetting[]? -

updatedProductSelections ProductSelectionSetting[]? -

commercetools.productcatalog: StoreReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Store? -

commercetools.productcatalog: StoreRemoveDistributionChannelAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

distributionChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StoreRemoveProductSelectionAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

productSelection ResourceIdentifier? -

commercetools.productcatalog: StoreRemoveSupplyChannelAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

supplyChannel ChannelResourceIdentifier? -

commercetools.productcatalog: StoreResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: StoreSetCustomFieldAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

name string? -

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

commercetools.productcatalog: StoreSetCustomTypeAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

'type TypeResourceIdentifier? -

fields record {}? -

commercetools.productcatalog: StoreSetDistributionChannelsAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

distributionChannels ChannelResourceIdentifier[]? -

commercetools.productcatalog: StoreSetLanguagesAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

languages string[]? -

commercetools.productcatalog: StoreSetNameAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: StoreSetProductSelectionsAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

productSelections ProductSelectionSettingDraft[]? -

commercetools.productcatalog: StoreSetSupplyChannelsAction

Fields

Fields Included from * StoreUpdateAction

action string
anydata...

action string? -

supplyChannels ChannelResourceIdentifier[]? -

commercetools.productcatalog: StoreUpdate

Fields

'version int? -

actions StoreUpdateAction[]? -

commercetools.productcatalog: StoreUpdateAction

Fields

action string? -

commercetools.productcatalog: SubRate

Fields

name string? -

amount decimal? -

commercetools.productcatalog: 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.productcatalog: SubscriptionChangeDestinationAction

Fields

Fields Included from * SubscriptionUpdateAction

action string
anydata...

action string? -

destination Destination? -

commercetools.productcatalog: SubscriptionDelivery

Fields

projectKey string? -

notificationType string? -

'resource Reference? -

resourceUserProvidedIdentifiers UserProvidedIdentifiers? -

commercetools.productcatalog: SubscriptionDraft

Fields

changes ChangeSubscription[]? -

destination Destination? -

'key string? -

messages MessageSubscription[]? -

format DeliveryFormat? -

commercetools.productcatalog: SubscriptionPagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Subscription[]? -

commercetools.productcatalog: SubscriptionSetChangesAction

Fields

Fields Included from * SubscriptionUpdateAction

action string
anydata...

action string? -

changes ChangeSubscription[]? -

commercetools.productcatalog: SubscriptionSetKeyAction

Fields

Fields Included from * SubscriptionUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: SubscriptionSetMessagesAction

Fields

Fields Included from * SubscriptionUpdateAction

action string
anydata...

action string? -

messages MessageSubscription[]? -

commercetools.productcatalog: SubscriptionUpdate

Fields

'version int? -

actions SubscriptionUpdateAction[]? -

commercetools.productcatalog: SubscriptionUpdateAction

Fields

action string? -

commercetools.productcatalog: Suggestion

Fields

text string? -

commercetools.productcatalog: SuggestionResult

commercetools.productcatalog: SuggestTokenizer

Fields

'type string? -

commercetools.productcatalog: SyncInfo

Fields

channel ChannelReference? -

externalId string? -

syncedAt string? -

commercetools.productcatalog: SyntaxErrorError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: 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.productcatalog: TaxCategoryAddTaxRateAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

taxRate TaxRateDraft? -

commercetools.productcatalog: TaxCategoryChangeNameAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: TaxCategoryDraft

Fields

name string? -

description string? -

rates TaxRateDraft[]? -

'key string? -

commercetools.productcatalog: TaxCategoryPagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results TaxCategory[]? -

commercetools.productcatalog: TaxCategoryReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj TaxCategory? -

commercetools.productcatalog: TaxCategoryRemoveTaxRateAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

taxRateId string? -

commercetools.productcatalog: TaxCategoryReplaceTaxRateAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

taxRateId string? -

taxRate TaxRateDraft? -

commercetools.productcatalog: TaxCategoryResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: TaxCategorySetDescriptionAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

description string? -

commercetools.productcatalog: TaxCategorySetKeyAction

Fields

Fields Included from * TaxCategoryUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: TaxCategoryUpdate

Fields

'version int? -

actions TaxCategoryUpdateAction[]? -

commercetools.productcatalog: TaxCategoryUpdateAction

Fields

action string? -

commercetools.productcatalog: TaxedItemPrice

Fields

totalNet TypedMoney? -

totalGross TypedMoney? -

commercetools.productcatalog: TaxedItemPriceDraft

Fields

totalNet Money? -

totalGross Money? -

commercetools.productcatalog: TaxedPrice

Fields

totalNet TypedMoney? -

totalGross TypedMoney? -

taxPortions TaxPortion[]? -

commercetools.productcatalog: TaxedPriceDraft

Fields

totalNet Money? -

totalGross Money? -

taxPortions TaxPortionDraft[]? -

commercetools.productcatalog: TaxPortion

Fields

name string? -

rate decimal? -

amount TypedMoney? -

commercetools.productcatalog: TaxPortionDraft

Fields

name string? -

rate decimal? -

amount Money? -

commercetools.productcatalog: TaxRate

Fields

id string? -

name string? -

amount decimal? -

includedInPrice boolean? -

country CountryCode? -

state string? -

subRates SubRate[]? -

commercetools.productcatalog: TaxRateDraft

Fields

name string? -

amount decimal? -

includedInPrice boolean? -

country CountryCode? -

state string? -

subRates SubRate[]? -

commercetools.productcatalog: TermFacetResult

Fields

Fields Included from * FacetResult

type FacetTypes
anydata...

'type FacetTypes? -

dataType TermFacetResultType? -

missing int? -

total int? -

other int? -

terms FacetResultTerm[]? -

commercetools.productcatalog: TextLineItem

Fields

addedAt string? -

custom CustomFields? -

description LocalizedString? -

id string? -

name LocalizedString? -

quantity int? -

commercetools.productcatalog: TextLineItemDraft

Fields

addedAt string? -

custom CustomFieldsDraft? -

description LocalizedString? -

name LocalizedString? -

quantity int? -

commercetools.productcatalog: TrackingData

Fields

trackingId string? -

carrier string? -

provider string? -

providerTransaction string? -

isReturn boolean? -

commercetools.productcatalog: Transaction

Fields

id string? -

timestamp string? -

'type TransactionType? -

amount TypedMoney? -

interactionId string? -

state TransactionState? -

custom CustomFields? -

commercetools.productcatalog: TransactionDraft

Fields

timestamp string? -

'type TransactionType? -

amount Money? -

interactionId string? -

state TransactionState? -

custom CustomFieldsDraft? -

commercetools.productcatalog: 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.productcatalog: TypeAddEnumValueAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

value CustomFieldEnumValue? -

commercetools.productcatalog: TypeAddFieldDefinitionAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldDefinition FieldDefinition? -

commercetools.productcatalog: TypeAddLocalizedEnumValueAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

value CustomFieldLocalizedEnumValue? -

commercetools.productcatalog: TypeChangeEnumValueLabelAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

value CustomFieldEnumValue? -

commercetools.productcatalog: TypeChangeEnumValueOrderAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

keys string[]? -

commercetools.productcatalog: TypeChangeFieldDefinitionOrderAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldNames string[]? -

commercetools.productcatalog: TypeChangeInputHintAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

inputHint TypeTextInputHint? -

commercetools.productcatalog: TypeChangeKeyAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: TypeChangeLabelAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

label LocalizedString? -

commercetools.productcatalog: TypeChangeLocalizedEnumValueLabelAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

value CustomFieldLocalizedEnumValue? -

commercetools.productcatalog: TypeChangeLocalizedEnumValueOrderAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

keys string[]? -

commercetools.productcatalog: TypeChangeNameAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

name LocalizedString? -

commercetools.productcatalog: TypedMoney

Fields

'type MoneyType? -

fractionDigits int? -

centAmount int? -

currencyCode CurrencyCode? -

commercetools.productcatalog: TypedMoneyDraft

Fields

Fields Included from * Money

centAmount int
currencyCode CurrencyCode
anydata...

centAmount int? -

currencyCode CurrencyCode? -

'type MoneyType? -

fractionDigits int? -

commercetools.productcatalog: TypeDraft

Fields

'key string? -

name LocalizedString? -

description LocalizedString? -

resourceTypeIds ResourceTypeId[]? -

fieldDefinitions FieldDefinition[]? -

commercetools.productcatalog: TypePagedQueryResponse

Fields

'limit int? -

count int? -

total int? -

offset int? -

results Type[]? -

commercetools.productcatalog: TypeReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Type? -

commercetools.productcatalog: TypeRemoveFieldDefinitionAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

fieldName string? -

commercetools.productcatalog: TypeResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: TypeSetDescriptionAction

Fields

Fields Included from * TypeUpdateAction

action string
anydata...

action string? -

description LocalizedString? -

commercetools.productcatalog: TypeUpdate

Fields

'version int? -

actions TypeUpdateAction[]? -

commercetools.productcatalog: TypeUpdateAction

Fields

action string? -

commercetools.productcatalog: Update

Fields

'version int? -

actions UpdateAction[]? -

commercetools.productcatalog: UpdateAction

Fields

action string? -

commercetools.productcatalog: URLEncodedPayload

commercetools.productcatalog: UserProvidedIdentifiers

Fields

'key string? -

externalId string? -

orderNumber string? -

customerNumber string? -

sku string? -

slug LocalizedString? -

containerAndKey ContainerAndKey? -

commercetools.productcatalog: VariantValues

Fields

sku string? -

prices PriceDraft[]? -

attributes Attribute[]? -

commercetools.productcatalog: WeakPasswordError

Fields

Fields Included from * ErrorObject

code string
message string
anydata...

code string? -

message string? -

commercetools.productcatalog: WhitespaceTokenizer

Fields

Fields Included from * SuggestTokenizer

type string
anydata...

'type string? -

commercetools.productcatalog: 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.productcatalog: ZoneAddLocationAction

Fields

Fields Included from * ZoneUpdateAction

action string
anydata...

action string? -

location Location? -

commercetools.productcatalog: ZoneChangeNameAction

Fields

Fields Included from * ZoneUpdateAction

action string
anydata...

action string? -

name string? -

commercetools.productcatalog: ZoneDraft

Fields

'key string? -

name string? -

description string? -

locations Location[]? -

commercetools.productcatalog: ZonePagedQueryResponse

Fields

'limit int? -

offset int? -

count int? -

total int? -

results Zone[]? -

commercetools.productcatalog: ZoneRate

Fields

zone ZoneReference? -

shippingRates ShippingRate[]? -

commercetools.productcatalog: ZoneRateDraft

Fields

zone ZoneResourceIdentifier? -

shippingRates ShippingRateDraft[]? -

commercetools.productcatalog: ZoneReference

Fields

Fields Included from * Reference

typeId ReferenceTypeId
id string
anydata...

typeId ReferenceTypeId? -

id string? -

obj Zone? -

commercetools.productcatalog: ZoneRemoveLocationAction

Fields

Fields Included from * ZoneUpdateAction

action string
anydata...

action string? -

location Location? -

commercetools.productcatalog: ZoneResourceIdentifier

Fields

Fields Included from * ResourceIdentifier

typeId ReferenceTypeId
id string
key string
anydata...

typeId ReferenceTypeId? -

id string? -

'key string? -

commercetools.productcatalog: ZoneSetDescriptionAction

Fields

Fields Included from * ZoneUpdateAction

action string
anydata...

action string? -

description string? -

commercetools.productcatalog: ZoneSetKeyAction

Fields

Fields Included from * ZoneUpdateAction

action string
anydata...

action string? -

'key string? -

commercetools.productcatalog: ZoneUpdate

Fields

'version int? -

actions ZoneUpdateAction[]? -

commercetools.productcatalog: ZoneUpdateAction

Fields

action string? -

Union types

commercetools.productcatalog: AttributeValue

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

AttributeValue

Import

import ballerinax/commercetools.productcatalog;

Metadata

Released date: about 1 year ago

Version: 1.4.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Commerce/eCommerce

Cost/Paid

Contributors

Other versions

1.4.1

1.4.0 1.3.0 1.1.0 1.0.0

Dependencies

ballerina/url/2.2.3 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

unionTypes

ballerinax/commercetools.productcatalog Ballerina library

Overview

Prerequisites

Clients

commercetools.productcatalog: Client

Constructor

getCategoryByID

Parameters

Return Type

updateCategoryByID

Parameters

Return Type

deleteCategoryByID

Parameters

Return Type

queryCategory

Parameters

Return Type

createCategory

Parameters

Return Type

getCategoryByKey

Parameters

Return Type

updateCategoryByKey

Parameters

Return Type

deleteCategoryByKey

Parameters

Return Type

getProductByID

Parameters

Return Type

updateProductByID

Parameters

Return Type

deleteProductByID

Parameters

Return Type

checkIfProductWithGivenIDExists

Parameters

Return Type

queryProductSelectionsForProductByKey

Parameters

Return Type

queryProductSelectionsForProductByID

Parameters

Return Type

getProductByKey

Parameters

Return Type

updateProductByKey

Parameters

Return Type

deleteProductByKey

Parameters

Return Type

checkIfProductWithGivenKeyExistsByKey

Parameters

Return Type

queryProduct

Parameters

Return Type

createNewProduct

Parameters

Return Type

checkIfProductsExists

Parameters

Return Type

uploadProductImage

Parameters

Return Type

getProductSelectionByID

Parameters

Return Type

updateProductSelectionByID

Parameters