Skip to main content
Server path: /commercetools-categories | Type: Application | PCID required: Yes

Tools

ToolDescription
commercetools_categories_create_categoriesEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Creating a Category produces the CategoryCreated Message.
commercetools_categories_create_product_selectionsPOST /product-selections
commercetools_categories_create_reviewsPOST /reviews
commercetools_categories_create_shopping_listsCreate a ShoppingList in the Project.
commercetools_categories_delete_by_idEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
commercetools_categories_delete_by_keyEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
commercetools_categories_delete_product_selections_by_idDeletion will only succeed if the Product Selection is not assigned to any Store.
commercetools_categories_delete_product_selections_by_keyDeletion will only succeed if the Product Selection is not assigned to any Store.
commercetools_categories_delete_reviews_by_idDELETE /reviews/{ID}
commercetools_categories_delete_reviews_by_keyDELETE /reviews/key={key}
commercetools_categories_delete_shopping_lists_by_idDeletes a ShoppingList in the Project.
commercetools_categories_delete_shopping_lists_by_keyDeletes a ShoppingList in the Project.
commercetools_categories_get_by_idEither the scope view_products:{projectKey} or view_categories:{projectKey} is required.
commercetools_categories_get_by_keyEither the scope view_products:{projectKey} or view_categories:{projectKey} is required.
commercetools_categories_get_product_selections_by_idGET /product-selections/{ID}
commercetools_categories_get_product_selections_by_keyGET /product-selections/key={key}
commercetools_categories_get_reviews_by_idGET /reviews/{ID}
commercetools_categories_get_reviews_by_keyGET /reviews/key={key}
commercetools_categories_get_shopping_lists_by_idRetrieves a ShoppingList with the provided id.
commercetools_categories_get_shopping_lists_by_keyRetrieves a ShoppingList with the provided key.
commercetools_categories_list_categoriesEither the scope view_products:{projectKey} or view_categories:{projectKey} is required.
commercetools_categories_list_product_selectionsGET /product-selections
commercetools_categories_list_product_selections_products_by_idGET /product-selections/{ID}/products
commercetools_categories_list_product_selections_products_by_keyGET /product-selections/key={key}/products
commercetools_categories_list_reviewsGET /reviews
commercetools_categories_list_shopping_listsRetrieves ShoppingLists in the Project.
commercetools_categories_update_categories_by_idEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
commercetools_categories_update_categories_by_keyEither the scope manage_products:{projectKey} or manage_categories:{projectKey} is required.
commercetools_categories_update_product_selections_by_idPOST /product-selections/{ID}
commercetools_categories_update_product_selections_by_keyPOST /product-selections/key={key}
commercetools_categories_update_reviews_by_idPOST /reviews/{ID}
commercetools_categories_update_reviews_by_keyPOST /reviews/key={key}
commercetools_categories_update_shopping_lists_by_idUpdates a ShoppingList in the Project using one or more update actions.
commercetools_categories_update_shopping_lists_by_keyUpdates a ShoppingList in the Project using one or more update actions.

commercetools_categories_create_categories

Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Creating a Category produces the CategoryCreated Message. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
assetsobject[]NoThe assets value
customobjectNoThe custom value
descriptionobjectNoThe description value
externalIdstringNoExternal Id
keystringNoThe key value
metaDescriptionobjectNoMeta Description
metaKeywordsobjectNoMeta Keywords
metaTitleobjectNoMeta Title
nameobjectYesThe name value
orderHintstringNoOrder Hint
parentobjectNoThe parent value
slugobjectYesThe slug value

commercetools_categories_create_product_selections

POST /product-selections Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
customobjectNoThe custom value
keystringNoThe key value
modestringNoThe mode value
nameobjectYesThe name value
typestringNoThe type value

commercetools_categories_create_reviews

POST /reviews Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
authorNamestringNoAuthor Name
customobjectNoThe custom value
customerobjectNoThe customer value
keystringNoThe key value
localestringNoLocale or language code
ratingintegerNoThe rating value
stateobjectNoThe state value
targetobjectNoThe target value
textstringNoThe text value
titlestringNoThe title value
uniquenessValuestringNoUniqueness Value

commercetools_categories_create_shopping_lists

Create a ShoppingList in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
anonymousIdstringNoAnonymous Id
businessUnitobjectNoBusiness Unit
customobjectNoThe custom value
customerobjectNoThe customer value
deleteDaysAfterLastModificationintegerNoDelete Days After Last Modification
descriptionobjectNoThe description value
keystringNoThe key value
lineItemsobject[]NoLine Items
nameobjectYesThe name value
slugobjectNoThe slug value
storeobjectNoThe store value
textLineItemsobject[]NoText Line Items

commercetools_categories_delete_by_id

Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_by_key

Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_product_selections_by_id

Deletion will only succeed if the Product Selection is not assigned to any Store. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_product_selections_by_key

Deletion will only succeed if the Product Selection is not assigned to any Store. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_reviews_by_id

DELETE /reviews/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_reviews_by_key

DELETE /reviews/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
dataErasurebooleanNoData Erasure
versionintegerYesThe version value
expandstring[]NoRelated resources to expand inline

commercetools_categories_delete_shopping_lists_by_id

Deletes a ShoppingList in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
dataErasurebooleanNoData Erasure
versionintegerYesThe version value

commercetools_categories_delete_shopping_lists_by_key

Deletes a ShoppingList in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
dataErasurebooleanNoData Erasure
versionintegerYesThe version value

commercetools_categories_get_by_id

Either the scope view_products:{projectKey} or view_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_by_key

Either the scope view_products:{projectKey} or view_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_product_selections_by_id

GET /product-selections/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_product_selections_by_key

GET /product-selections/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_reviews_by_id

GET /reviews/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_reviews_by_key

GET /reviews/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_shopping_lists_by_id

Retrieves a ShoppingList with the provided id. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline

commercetools_categories_get_shopping_lists_by_key

Retrieves a ShoppingList with the provided key. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline

commercetools_categories_list_categories

Either the scope view_products:{projectKey} or view_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_categories_list_product_selections

GET /product-selections Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_categories_list_product_selections_products_by_id

GET /product-selections/{ID}/products Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
wherestring[]NoThe where value
withTotalbooleanNoWith Total
expandstring[]NoRelated resources to expand inline
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
sortstring[]NoSort order for results

commercetools_categories_list_product_selections_products_by_key

GET /product-selections/key={key}/products Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
wherestring[]NoThe where value
withTotalbooleanNoWith Total
expandstring[]NoRelated resources to expand inline
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
sortstring[]NoSort order for results

commercetools_categories_list_reviews

GET /reviews Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_categories_list_shopping_lists

Retrieves ShoppingLists in the Project. Parameters:
ParameterTypeRequiredDefaultDescription
expandstring[]NoRelated resources to expand inline
sortstring[]NoSort order for results
limitintegerNoMaximum number of results to return
offsetintegerNoThe offset value
withTotalbooleanNoWith Total
wherestring[]NoThe where value

commercetools_categories_update_categories_by_id

Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_categories_by_key

Either the scope manage_products:{projectKey} or manage_categories:{projectKey} is required. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_product_selections_by_id

POST /product-selections/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_product_selections_by_key

POST /product-selections/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_reviews_by_id

POST /reviews/{ID} Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_reviews_by_key

POST /reviews/key={key} Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_shopping_lists_by_id

Updates a ShoppingList in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
IDstringYesThe id value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value

commercetools_categories_update_shopping_lists_by_key

Updates a ShoppingList in the Project using one or more update actions. Parameters:
ParameterTypeRequiredDefaultDescription
keystringYesThe key value
expandstring[]NoRelated resources to expand inline
actionsobject[]YesThe actions value
versionintegerYesThe version value