/commercetools-config | Type: Application | PCID required: Yes
Tools
commercetools_config_create_custom_objects
If an object with the given container/key exists, the object will be replaced with the new value and the version is incremented. If the request contains a version and an object with the given container/key, then the version must match the version of the existing object. Concurrent updates to the same Custom Object returns a ConcurrentModification error even if the version is not provided. Fields withinvalue that have null values are not saved.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
container | string | Yes | — | The container value |
key | string | Yes | — | The key value |
value | object | Yes | — | The value value |
version | integer | No | — | The version value |
commercetools_config_create_extensions
POST /extensions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destination | object | Yes | — | The destination value |
key | string | No | — | The key value |
timeoutInMs | integer | No | — | Timeout In Ms |
triggers | object[] | Yes | — | The triggers value |
commercetools_config_create_states
POST /states Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | object | No | — | The description value |
initial | boolean | No | — | The initial value |
key | string | Yes | — | The key value |
name | object | No | — | The name value |
roles | string[] | No | — | The roles value |
transitions | any[] | No | — | The transitions value |
type | string | Yes | — | The type value |
commercetools_config_create_stores
POST /stores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
countries | object[] | No | — | The countries value |
custom | object | No | — | The custom value |
distributionChannels | any[] | No | — | Distribution Channels |
key | string | Yes | — | The key value |
languages | string[] | No | — | The languages value |
name | object | No | — | The name value |
productSelections | object[] | No | — | Product Selections |
supplyChannels | any[] | No | — | Supply Channels |
commercetools_config_create_subscriptions
A test notification is sent to ensure the correct configuration of the Destination. If the notification cannot be delivered, the Subscription will not be created. The payload of the test notification is of type ResourceCreated for theresourceTypeId subscription.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
changes | object[] | No | — | The changes value |
destination | object | Yes | — | The destination value |
events | object[] | No | — | The events value |
format | object | No | — | The format value |
key | string | No | — | The key value |
messages | object[] | No | — | The messages value |
commercetools_config_create_types
POST /types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
description | object | No | — | The description value |
fieldDefinitions | object[] | No | — | Field Definitions |
key | string | Yes | — | The key value |
name | object | Yes | — | The name value |
resourceTypeIds | string[] | Yes | — | Resource Type Ids |
commercetools_config_delete_custom_objects_by_container_and_key
DELETE /custom-objects/{container}/{key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
container | string | Yes | — | The container value |
key | string | Yes | — | The key value |
version | integer | No | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
dataErasure | boolean | No | — | Data Erasure |
commercetools_config_delete_extensions_by_id
DELETE /extensions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
commercetools_config_delete_extensions_by_key
DELETE /extensions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
commercetools_config_delete_states_by_id
DELETE /states/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_delete_states_by_key
DELETE /states/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_delete_stores_by_id
DELETE /stores/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_delete_stores_by_key
DELETE /stores/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_delete_subscriptions_by_id
DELETE /subscriptions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
commercetools_config_delete_subscriptions_by_key
DELETE /subscriptions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
commercetools_config_delete_types_by_id
DELETE /types/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_delete_types_by_key
DELETE /types/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_custom_objects_by_container
GET /custom-objects/{container} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
container | string | Yes | — | The container value |
sort | string[] | No | — | Sort order for results |
where | string[] | No | — | The where value |
expand | string[] | No | — | Related resources to expand inline |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
commercetools_config_get_custom_objects_by_container_and_key
GET /custom-objects/{container}/{key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
container | string | Yes | — | The container value |
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_extensions_by_id
GET /extensions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
commercetools_config_get_extensions_by_key
GET /extensions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
commercetools_config_get_states_by_id
GET /states/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_states_by_key
GET /states/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_stores_by_id
GET /stores/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_stores_by_key
GET /stores/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_subscriptions_by_id
GET /subscriptions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
commercetools_config_get_subscriptions_by_key
GET /subscriptions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
commercetools_config_get_types_by_id
GET /types/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_get_types_by_key
GET /types/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
commercetools_config_list_custom_objects
For performance reasons, it is highly advisable to query for Custom Objects in a container by using thecontainer field in the where predicate. This endpoint is deprecated and replaced by the Query CustomObjects in Container endpoint.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_list_extensions
GET /extensions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_list_states
GET /states Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_list_stores
GET /stores Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_list_subscriptions
GET /subscriptions Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_list_subscriptions_health_by_id
This endpoint can be polled by a monitoring or alerting system that checks the health of your Subscriptions. To ease integration with such systems this endpoint does not require Authorization. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
commercetools_config_list_types
GET /types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
sort | string[] | No | — | Sort order for results |
limit | integer | No | — | Maximum number of results to return |
offset | integer | No | — | The offset value |
withTotal | boolean | No | — | With Total |
where | string[] | No | — | The where value |
commercetools_config_update_extensions_by_id
POST /extensions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_extensions_by_key
POST /extensions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_states_by_id
POST /states/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_states_by_key
POST /states/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_stores_by_id
POST /stores/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_stores_by_key
POST /stores/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_subscriptions_by_id
POST /subscriptions/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_subscriptions_by_key
POST /subscriptions/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_types_by_id
POST /types/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
commercetools_config_update_types_by_key
POST /types/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |

