Queries and mutations for managing Products in the platform.

Queries

Query Products

QUERYproducts
Arguments
where​
String​
sort​
Array of String​
limit​
Int​
offset​
Int​
projectExpandedProducts​
Boolean​
Default: false​
localeProjection​
Array of Locale​
skus​
Array of String​

Queries for products with specified SKUs

Get Product

QUERYproduct
Arguments
projectExpandedProducts​
Boolean​
Default: false​
localeProjection​
Array of Locale​
sku​
String​

Queries for a product with specified SKU

variantKey​
String​
Queries for a Product with specified ProductVariant key
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output:Product

Mutations

Create Product

MUTATIONcreateProduct
Arguments
draft​
Output:Product

Update Product

MUTATIONupdateProduct
Arguments
version​
Long​
actions​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output:Product

Delete Product

MUTATIONdeleteProduct
Arguments
version​
Long​
id​
String​

Queries with specified ID

key​
String​

Queries with specified key

Output:Product

Output types

Product

id​
String​

Unique identifier of the Product.

key​
String​

User-defined unique identifier of the Product.

This is different from the key of a ProductVariant.
version​
Long​

Current version of the Product.

productTypeRef​

The Product Type defining the Attributes of the Product. Cannot be changed.

productType​

The Product Type defining the Attributes of the Product. Cannot be changed.

masterData​

Contains the current and the staged representation of the product information.

skus​
Array of String​
createdAt​

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

lastModifiedAt​

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

stateRef​
State of the Product.
state​
State of the Product.
priceMode​

Type of Price to be used when looking up a price for the Product.

Can be Embedded, or Standalone​
taxCategoryRef​
The TaxCategory of the Product.
taxCategory​
The TaxCategory of the Product.
reviewRatingStatistics​

Review statistics of the Product.

productSelectionRefs​
createdBy​

IDs and references that created the Product.

lastModifiedBy​

IDs and references that last modified the Product.

ProductCatalogData

current​

Current (published) data of the Product.

staged​

Staged (unpublished) data of the Product.

published​
Boolean​
Whether the current representation of the Product is retrievable in the Product Projection endpoints and indexed for Product Search.
hasStagedChanges​
Boolean​
Whether the staged data is different from the current data.

ProductData

name​
String​
description​
String​
nameAllLocales​
Array of LocalizedString​
descriptionAllLocales​
Array of LocalizedString​
slug​
String​
slugAllLocales​
Array of LocalizedString​
categoryOrderHint​
String​
categoryOrderHints​
Array of CategoryOrderHint​
categoriesRef​
Array of Reference​
categories​
Array of Category​
searchKeyword​
Array of SearchKeyword​
searchKeywords​
Array of SearchKeywords​
metaTitle​
String​
metaTitleAllLocales​
Array of LocalizedString​
metaKeywords​
String​
metaKeywordsAllLocales​
Array of LocalizedString​
metaDescription​
String​
metaDescriptionAllLocales​
Array of LocalizedString​
masterVariant​
variants​
Array of ProductVariant​
allVariants​
Array of ProductVariant​

Fetch all variants, including the master variant in first position.

variant​
skus​
Array of String​
attributesRaw​
defaultVariantRef​
defaultVariant​

CategoryOrderHint

categoryId​
String​
orderHint​
String​

SearchKeyword

text​
String​
Text to return in the SuggestionResult.
suggestTokenizer​
If no tokenizer is defined, the text is used as a single token.

SuggestTokenizer

type​
String​

SearchKeywords

locale​
searchKeywords​
Array of SearchKeyword​

ProductVariant

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

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

key​
String​

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

This is different from Product key.
sku​
String​

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

prices​
Array of ProductPrice​
If the Product is projected by Store, this field only contains Embedded Prices that are valid for that Store.
Cannot contain two Embedded Prices with the same scopes (currency, country, Customer Group, Channel, validFrom and validUntil).
price​

Returns a single price based on the price selection rules.

allRecurrencePrices​
Array of ProductPrice​

Returns all recurrence prices based on the price selection rules.

images​
Array of Image​

Images of the Product Variant.

assets​
Array of Asset​

Media assets of the Product Variant.

availability​
Set if the Product Variant is tracked by Inventory. Can be used as an optimization to reduce calls to the Inventory service. May not contain the latest Inventory State (it is eventually consistent).
attributesRaw​

This field contains raw attributes data

ProductPrice

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

DiscountedProductPriceValue

value​
discountRef​
discount​

ProductPriceTier

minimumQuantity​
Int​
value​

ProductVariantAvailabilityWithChannels

noChannel​
channels​

ProductVariantAvailability

Product variant availability

isOnStock​
Boolean​
Whether the Product Variant is in stock, based on an InventoryEntry that has no assigned supply Channel. This value reflects global or default availability; it does not aggregate the channel-specific availabilities found in the channels field.
restockableInDays​
Int​

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

availableQuantity​
Long​

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

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

ProductVariantAvailabilitiesResult

Product variant availabilities

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

ProductVariantAvailabilityWithChannel

channelRef​
channel​
availability​

RawProductAttribute

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

AttributeDefinition

type​

Describes the Type of the Attribute.

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

Human-readable label for the Attribute.

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

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

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

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

Can be Variant, or Product​
inputTip​
String​

Provides additional Attribute information to aid content managers configure Product details.

inputHint​
Provides a visual representation directive for values of this Attribute (only relevant for AttributeTextType and AttributeLocalizableTextType).
Can be SingleLine, or MultiLine​
isSearchable​
Boolean​
Whether the Attribute's values are available in the Product Search or the Product Projection Search API for use in full-text search queries, filters, and facets. However, if an Attribute's level is set as Product, then Product Projection Search does not support the Attribute. To use the Attribute in search, filters, or facets, set isSearchable to true for all AttributeDefinitions with the same name across different ProductTypes. If the isSearchable values are different, the Attribute isn't available for search, filters, or facets.
The exact features that are available with this flag depend on the specific AttributeType. The maximum size of a searchable field is restricted by the Field content size limit. This constraint is enforced at both Product creation and Product update. If the length of the input exceeds the maximum size, an InvalidField error is returned.
savedToLineItem​
Boolean​
Whether the Attribute value is copied onto the LineItem when the Product is added to a Cart. When false, the Attribute value is excluded from the Line Item variant. Line Items already in a Cart are not immediately affected by a change to this value. Existing Line Items are updated the next time their Product data is refreshed, such as when a Recalculate update action is performed with updateProductData set to true, or on a Cart update that triggers an API Extension. Replicating a Cart creates a new Cart that contains the current Product data; it does not update the original Cart.
When savedToLineItem is false, LineItem predicates that reference this Attribute, such as those in Cart Discounts and Shipping Methods, evaluate as if the Attribute is not set.
labelAllLocales​
Array of LocalizedString​

Human-readable label for the Attribute.

inputTipAllLocales​
Array of LocalizedString​

Provides additional Attribute information to aid content managers configure Product details.

AttributeDefinitionType

AttributeConstraint

None
No constraints are applied to the attribute
Unique
Attribute value should be different in each variant
CombinationUnique
A set of attributes, that have this constraint, should have different combinations in each variant
SameForAll
Attribute value should be the same in all variants

Level

Variant
The attribute can be used on the variant level
Product
The attribute can be used on the product level

PriceMode

Embedded
The system looks up prices from the `prices` field of the ProductVariant inside a Product.
Standalone
The system looks up prices from Standalone Prices, stored separately from Products.

ReviewRatingStatistics

averageRating​
Float​

Average rating of one target This number is rounded with 5 decimals.

highestRating​
Int​

Highest rating of one target

lowestRating​
Int​

Lowest rating of one target

count​
Long​

Number of ratings taken into account

ratingsDistribution​
Json​

Full distribution of the ratings. The keys are the different ratings and the values are the count of reviews having this rating. Only the used ratings appear in this object.

SelectionOfProductQueryResult

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of SelectionOfProduct​

SelectionOfProduct

productSelectionRef​
productSelection​
variantSelection​
variantExclusion​
createdAt​
lastModifiedAt​

ProductVariantSelection

type​
String​
skus​
Array of String​

ProductVariantExclusion

Defines the Product Variants that are excluded from a Product Selection with IndividualExclusion ProductSelectionMode. Product Variants not listed remain available in the Product Selection.
skus​
Array of String​
Non-empty array of SKUs representing Product Variants to be excluded from the Product Selection with IndividualExclusion ProductSelectionMode.

ProductQueryResult

offset​
Int​
count​
Int​
total​
Long​
exists​
Boolean​
results​
Array of Product​

Input types

ProductDraft

name​

Name of the Product.

productType​

The Product Type defining the Attributes for the Product. Cannot be changed later.

slug​
User-defined identifier used in a deep-link URL for the Product. It must be unique across a Project, but a Product can have the same slug in different Locales. It must match the pattern [a-zA-Z0-9_-]{2,256}.
key​
String​

User-defined unique identifier for the Product.

This field is optional for backwards compatibility reasons, but we strongly recommend setting it. Keys are mandatory for importing Products with the Import API and the Merchant Center.
description​

Description of the Product.

categories​

Categories assigned to the Product.

categoryOrderHints​
Numerical values to allow ordering of Products within specified Categories. If the referenced Categories are not also assigned in the categories field, an InvalidOperation error is returned.
metaTitle​

Title of the Product as used by search engines.

metaDescription​

Description of the Product as used by search engines.

metaKeywords​

Keywords that give additional information about the Product to search engines.

masterVariant​
The Product Variant to be the Master Variant for the Product. Required if variants are provided or if the referenced Product Type contains any Variant-level AttributeDefinition with isRequired set to true.
Must not be provided when the Project has the ProductCatalogModel Modular. Use the Variants API to create Variants instead.
attributes​
Product Attributes according to the respective AttributeDefinition. Not supported by Product Projection Search.
Default: []​
variants​

The additional Product Variants for the Product.

Must not be provided when the Project has the ProductCatalogModel Modular. Use the Variants API to create Variants instead.
Default: []​
taxCategory​

The Tax Category to be assigned to the Product.

State to be assigned to the Product.

priceMode​

Specifies the type of prices used when looking up a price for the Product.

Can be Embedded, or Standalone​
searchKeywords​
Array of SearchKeywordInput​
Used by Search Term Suggestions, but is also considered for a full text search in the Product Projection Search API.
publish​
Boolean​
Whether the platform sets the published flag on the resulting ProductCatalogData to true. This makes the current representation retrievable in Product Projection endpoints and indexes it for Product Search. You can also set this flag later using the Publish update action.

CategoryOrderHintInput

uuid​
String​
orderHint​
String​

ProductVariantInput

sku​
String​
key​
String​
prices​
Default: []​
images​
Array of ImageInput​
Default: []​
attributes​
Default: []​
assets​
Array of AssetDraftInput​
Default: []​

ProductPriceDataInput

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

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

ImageInput

url​
String​
label​
String​
dimensions​

DimensionsInput

width​
Int​
height​
Int​

ProductAttributeInput

An input object used to define a ProductAttribute.

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

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

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

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

AssetDraftInput

key​
String​
name​
description​
custom​
sources​
Array of AssetSourceInput​
tags​
Array of String​

AssetSourceInput

uri​
String​
key​
String​
dimensions​
contentType​
String​

AssetDimensionsInput

width​
Int​
height​
Int​

PriceMode

Embedded
The system looks up prices from the `prices` field of the ProductVariant inside a Product.
Standalone
The system looks up prices from Standalone Prices, stored separately from Products.

SearchKeywordInput

locale​
keywords​

SearchKeywordItemInput

text​
String​
suggestTokenizer​

BaseSearchKeywordInput

whitespace​
custom​

WhitespaceSuggestTokenizerInput

dummy​
String​

CustomSuggestTokenizerInput

inputs​
Array of String​

SearchKeywordArgument

searchKeyword​
String​
locale​

ProductUpdateAction

moveImageToPosition​
setSearchKeywords​
revertStagedChanges​
revertStagedVariantChanges​
publish​
setProductAttribute​
unpublish​
transitionState​
removePrice​
addAsset​
addExternalImage​
addPrice​
addToCategory​
addVariant​
changeAssetName​
changeAssetOrder​
changeMasterVariant​
changeImageLabel​
changeName​
changePrice​
changeSlug​
removeAsset​
removeFromCategory​
removeImage​
removeVariant​
setAssetCustomField​
setAssetCustomType​
setAssetDescription​
setAssetKey​
setAssetSources​
setAssetTags​
setCategoryOrderHint​
setDefaultVariant​
setDiscountedPrice​
setAttribute​
setAttributeInAllVariants​
setDescription​
setImageLabel​
setKey​
setMetaAttributes​
setMetaDescription​
setMetaKeywords​
setMetaTitle​
setProductPriceCustomField​
setProductPriceCustomType​
setPriceKey​
setPriceMode​
setPrices​
setSku​
setTaxCategory​
setProductVariantKey​

Update actions

Move Image To Position

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
imageUrl​
String​

The URL of the image to update.

position​
Int​
Position in images where the image should be moved. Must be between 0 and the total number of images minus 1.
staged​
Boolean​
Whether only staged images are updated. If false, both current and staged images are updated.

Set Search Keywords

searchKeywords​
Array of SearchKeywordInput​
staged​
Boolean​

SearchKeywordInput

locale​
keywords​

SearchKeywordItemInput

text​
String​
suggestTokenizer​

BaseSearchKeywordInput

whitespace​
custom​

WhitespaceSuggestTokenizerInput

dummy​
String​

CustomSuggestTokenizerInput

inputs​
Array of String​

Revert Staged Changes

dummy​
String​

Revert Staged Variant Changes

variantId​
Int​

Publish

Copies the product data from the Product's staged representation to its current representation and sets the published flag on the resulting ProductCatalogData to true. This makes the current representation retrievable in Product Projection endpoints and indexes it for Product Search.
Produces the ProductPublished Message.
scope​
All or Prices
Can be All, or Prices​

PublishScope

All
Publishes the complete staged projection
Prices
Publishes only prices on the staged projection

Set Product Attribute

An input object used to define a ProductAttribute.

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

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

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

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

Unpublish

dummy​
String​

Transition State

If the existing State has set transitions, there must be a direct transition to the new State. If transitions is not set, no validation is performed. Produces the ProductStateTransition Message.
state​

The State to transition to. If there is no existing State, this must be an initial State.

force​
Boolean​

Whether validations are disabled.

Remove Price

priceId​
String​
The id of the Embedded Price to remove.
staged​
Boolean​
Whether only the staged Embedded Price is removed. If false, both the current and staged Embedded Price are removed.
Default: true​

Add Asset

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only staged assets are updated. If false, both current and staged assets are updated.
Default: true​
position​
Int​
Position in assets where the Asset should be put. When specified, the value must be between 0 and the total number of Assets minus 1.
asset​

Value to append.

AssetDraftInput

key​
String​
name​
description​
custom​
sources​
Array of AssetSourceInput​
tags​
Array of String​

AssetSourceInput

uri​
String​
key​
String​
dimensions​
contentType​
String​

AssetDimensionsInput

width​
Int​
height​
Int​

Add External Image

Either variantId or sku is required. Produces the ProductImageAdded Message.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
image​
Value to add to images.
staged​
Boolean​
Whether only staged images are updated. If false, both current and staged images are updated.
Default: true​

ImageInput

url​
String​
label​
String​
dimensions​

DimensionsInput

width​
Int​
height​
Int​

Add Price

Adds the given Price to the prices array of the ProductVariant. Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
price​

Embedded Price to add to the Product Variant.

If the key of the Price is used by another Embedded Price on the ProductVariant, a DuplicatePriceKey error is returned.
If this Embedded Price has the same price scope as an existing Embedded Price on the ProductVariant, a DuplicatePriceScope error is returned.
If this Embedded Price has overlapping validity periods within the same price scope, an OverlappingPriceValidity error is returned. An Embedded Price without validity period does not conflict with an Embedded Price defined for a time period.
staged​
Boolean​
Whether only staged prices are updated. If false, both current and staged prices are updated.
Default: true​

ProductPriceDataInput

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

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

Add To Category

Produces the ProductAddedToCategory Message.

The Category to add.

orderHint​
String​
A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If omitted, any existing value is removed.
staged​
Boolean​
Whether only staged categories and categoryOrderHints are updated. If false, both current and staged categories and categoryOrderHints are updated.
Default: true​

Add Variant

assets​
Array of AssetDraftInput​

Media assets for the Product Variant.

Default: []​
attributes​

Attributes for the Product Variant.

Default: []​
images​
Array of ImageInput​

Images for the Product Variant.

Default: []​
prices​

Embedded Prices for the Product Variant.

Default: []​
key​
String​

Value to set. Must be unique among ProductVariants in the same Product.

sku​
String​

Value to set. Must be unique across all ProductVariants in a Project.

staged​
Boolean​
Whether the new Product Variant is only staged. If false the new Product Variant is both current and staged.
Default: true​

AssetDraftInput

key​
String​
name​
description​
custom​
sources​
Array of AssetSourceInput​
tags​
Array of String​

AssetSourceInput

uri​
String​
key​
String​
dimensions​
contentType​
String​

AssetDimensionsInput

width​
Int​
height​
Int​

ProductAttributeInput

An input object used to define a ProductAttribute.

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

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

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

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

ImageInput

url​
String​
label​
String​
dimensions​

DimensionsInput

width​
Int​
height​
Int​

ProductPriceDataInput

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

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

Change Asset Name

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset are updated.
Default: true​
name​

New value to set. Must not be empty.

assetKey​
String​
The key of the Asset to update.
assetId​
String​
The id of the Asset to update.

Change Asset Order

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only staged assets are updated. If false, both current and staged assets are updated.
Default: true​
assetOrder​
Array of String​
All existing Asset ids of the ProductVariant in the desired new order.

Change Master Variant

Assigns the specified Product Variant to the masterVariant and removes the same from variants at the same time. The current Master Variant becomes part of the variants array. Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to become the Master Variant.
sku​
String​
The sku of the ProductVariant to become the Master Variant.
staged​
Boolean​
Whether only the staged Master Variant is changed. If false, both the current and staged Master Variant are changed.
Default: true​

Change Image Label

variantId​
Int​
sku​
String​
imageUrl​
String​
label​
String​
staged​
Boolean​
Default: true​

Change Name

name​

Value to set. Must not be empty.

staged​
Boolean​
Whether only the staged name is updated. If false, both the current and staged name are updated.
Default: true​

Change Price

priceId​
String​
variantId​
Int​
sku​
String​
price​
staged​
Boolean​
Default: true​

ProductPriceDataInput

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

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

Change Slug

Produces the ProductSlugChanged Message.
slug​
Value to set. Must not be empty. A Product can have the same slug for different Locales, but it must be unique across the Project. Must match the pattern ^[A-Za-z0-9_-]{2,256}+$.
staged​
Boolean​
Whether only the staged slug is updated. If false, both the current and staged slug are updated.
Default: true​

Remove Asset

Either variantId or sku is required. The Asset to remove must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is removed. If false, both the current and staged Asset is removed.
Default: true​
assetKey​
String​
The key of the Asset to remove.
assetId​
String​
The id of the Asset to remove.

Remove From Category

Produces the ProductRemovedFromCategory Message.

The Category to remove.

staged​
Boolean​
Whether only the staged categories and categoryOrderHints are removed. If false, both the current and staged categories and categoryOrderHints are removed.
Default: true​

Remove Image

Removes a Product image and deletes it from the Content Delivery Network (CDN) if it had been uploaded to our CDN. External images will not be deleted. The API deletes the removed image from the CDN in an eventual consistent way. Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
imageUrl​
String​

The URL of the image to remove.

staged​
Boolean​
Whether only the staged image is removed. If false, both the current image and staged image are removed.
Default: true​

Remove Variant

Either id or sku is required. Produces the ProductVariantDeleted Message. If the Product Variant to remove is part of a ProductSelectionAssignment its SKU will be automatically removed from the respective ProductVariantSelection.
id​
Int​
The id of the ProductVariant to remove.
sku​
String​
The sku of the ProductVariant to remove.
staged​
Boolean​
Whether only the staged ProductVariant is removed. If false, both the current and staged ProductVariant is removed.
Default: true​

Set Asset Custom Field

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.
Default: true​
value​
String​
If value is absent or null, this field will be removed if it exists. Removing a field that does not exist returns an InvalidOperation error. If value is provided, it is set for the field defined by name.
name​
String​
Name of the Custom Field.
assetKey​
String​
The key of the Asset to update.
assetId​
String​
The id of the Asset to update.

Set Asset Custom Type

variantId​
Int​
sku​
String​
staged​
Boolean​
Default: true​
typeId​
String​
typeKey​
String​
fields​
Array of CustomFieldInput​
assetKey​
String​
assetId​
String​

Set Asset Description

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.
Default: true​
description​

Value to set. If omitted, any existing value is removed.

assetKey​
String​
The key of the Asset to update.
assetId​
String​
The id of the Asset to update.

Set Asset Key

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.
Default: true​
assetKey​
String​

Value to set. If omitted, any existing value is removed.

assetId​
String​
The id of the Asset to update.

Set Asset Sources

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.
Default: true​
sources​
Array of AssetSourceInput​

Value to set.

Default: []​
assetKey​
String​
The key of the Asset to update.
assetId​
String​
The id of the Asset to update.

AssetSourceInput

uri​
String​
key​
String​
dimensions​
contentType​
String​

AssetDimensionsInput

width​
Int​
height​
Int​

Set Asset Tags

Either variantId or sku is required. The Asset to update must be specified using either assetId or assetKey.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
staged​
Boolean​
Whether only the staged Asset is updated. If false, both the current and staged Asset is updated.
Default: true​
tags​
Array of String​

Keywords for categorizing and organizing Assets.

Default: []​
assetKey​
String​
The key of the Asset to update.
assetId​
String​
The id of the Asset to update.

Set Category Order Hint

categoryId​
String​
The id of the Category to add the orderHint. If this Category is not assigned to the Product, an InvalidOperation error is returned.
orderHint​
String​
A string representing a number between 0 and 1. Must start with 0. and cannot end with 0. If omitted, any existing value is removed.
staged​
Boolean​
Whether only the staged categoryOrderHints is updated. If false, both the current and staged categoryOrderHints are updated.
Default: true​

Set Default Variant

Sets the defaultVariant of the Product. Only available for Projects with productCatalogModel set to Modular. The Variant must belong to the Product. If variant is omitted, any existing default Variant is cleared.

The Variant to set as default. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged defaultVariant is updated. If false, both the current and staged defaultVariant are updated.
Default: true​

Set Discounted Price

Produces the ProductPriceExternalDiscountSet Message.
priceId​
String​
The id of the Price to set the Discount.
discounted​
Value to set. If omitted, any existing value is removed. The referenced ProductDiscount must have the Type external, be active, and its predicate must match the referenced Price.
staged​
Boolean​
Whether only the staged Embedded Price is updated. If false, both the current and staged Embedded Price are updated.
Default: true​

DiscountedProductPriceValueInput

value​

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

Set Attribute

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
name​
String​

Name of the Attribute to set.

value​
String​

Value to set for the Attribute. If omitted, any existing value is removed.

The AttributeType determines the format of the Attribute value to be provided:
staged​
Boolean​
Whether only the staged Attribute is set. If false, both the current and staged Attributes are set.
Default: true​

Set Attribute In All Variants

Adds, removes, or changes a Variant Attribute in all Product Variants at the same time. This action is useful for setting values for Attributes with the Constraint SameForAll.
name​
String​

Name of the Attribute to set.

value​
String​

Value to set for the Attributes. If omitted, any existing value is removed.

The AttributeType determines the format of the Attribute value to be provided:
staged​
Boolean​
Whether only the staged Attributes are set. If false, both the current and staged Attributes are set.
Default: true​

Set Description

description​

Value to set. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged description is updated. If false, both the current and staged description are updated.
Default: true​

Set Image Label

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
imageUrl​
String​

The URL of the image to set the label.

label​
String​

Value to set. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged image is updated. If false, both the current and staged image is updated.
Default: true​

Set Key

key​
String​

Value to set. If omitted, any existing value is removed.

To update a Product using the Import API and the Merchant Center, the Product key must match the pattern ^[A-Za-z0-9_-]{2,256}$.

Set Meta Attributes

metaDescription​
metaKeywords​
metaTitle​
staged​
Boolean​
Default: true​

Set Meta Description

metaDescription​

Value to set. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged metaDescription is updated. If false, both the current and staged metaDescription are updated.
Default: true​

Set Meta Keywords

metaKeywords​

Value to set. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged metaKeywords is updated. If false, both the current and staged metaKeywords are updated.
Default: true​

Set Meta Title

metaTitle​

Value to set. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged metaTitle is updated. If false, both the current and staged metaTitle are updated.
Default: true​

Set Product Price Custom Field

priceId​
String​
staged​
Boolean​
Default: true​
name​
String​
value​
String​

Set Product Price Custom Type

priceId​
String​
staged​
Boolean​
Default: true​
fields​
Array of CustomFieldInput​
typeKey​
String​
typeId​
String​

Set Price Key

Sets the key of an Embedded Price. Produces the ProductPriceKeySet Message.
priceId​
String​
The id of the Price to set the key.
key​
String​

Value to set. If omitted, any existing value is removed.

If the value is used by another Embedded Price on the same ProductVariant, a DuplicatePriceKey error is returned.
staged​
Boolean​
Whether only the staged Embedded Price is updated. If false, both the current and staged Embedded Price are updated.
Default: true​

Set Price Mode

Controls whether the Prices of a Product Variant are embedded into the Product or standalone.

priceMode​

Specifies which type of Prices should be used when looking up a price for the Product.

Can be Embedded, or Standalone​

PriceMode

Embedded
The system looks up prices from the `prices` field of the ProductVariant inside a Product.
Standalone
The system looks up prices from Standalone Prices, stored separately from Products.

Set Prices

Either variantId or sku is required.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​
The sku of the ProductVariant to update.
prices​

The Embedded Prices to set.

If any two Embedded Prices in this array have the same key, a DuplicatePriceKey error is returned.
If any two Embedded Prices in this array have the same price scope, a DuplicatePriceScope error is returned.
If any two Embedded Prices in this array have overlapping validity periods within the same price scope, an OverlappingPriceValidity error is returned. An Embedded Price without validity period does not conflict with an Embedded Price defined for a time period.
staged​
Boolean​
Whether only the staged ProductVariant is updated. If false, both the current and staged ProductVariant are updated.
Default: true​

ProductPriceDataInput

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

BaseMoneyInput

centPrecision​
highPrecision​

MoneyInput

currencyCode​
centAmount​
Long​

HighPrecisionMoneyInput

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

ProductPriceTierInput

minimumQuantity​
Int​
value​

DiscountedProductPriceValueInput

value​

Set SKU

SKU cannot be changed or removed if it is associated with an InventoryEntry. If the SKU to set or unset is part of a ProductSelectionAssignment it will be automatically added or removed from the respective ProductVariantSelection.
variantId​
Int​
The id of the ProductVariant to update.
sku​
String​

Value to set. Must be unique across all ProductVariants in a Project. If omitted, any existing value is removed.

staged​
Boolean​
Whether only the staged sku is updated. If false, both the current and staged sku are updated.
Default: true​

Set Tax Category

Cannot be staged. Published Products are immediately updated.

taxCategory​

The Tax Category to set. If omitted, any existing value is removed.

Set Product Variant Key

variantId​
Int​
sku​
String​
key​
String​
staged​
Boolean​
Default: true​