/commercetools-products | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
commercetools_products_create_attribute_groups | POST /attribute-groups |
commercetools_products_create_product_projections_search | For implementing funnel search on Product Listing Pages where users select multiple filters, use this POST method. To avoid URL length restrictions, this method passes the same query parameters as defined in the GET method, within the request body in URL-encoded format. |
commercetools_products_create_product_tailoring | Generates the ProductTailoringCreated Message. |
commercetools_products_create_product_types | POST /product-types |
commercetools_products_create_products | To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog. If Product price selection query parameters are provided, selected Prices will be added to the response. Produces the ProductCreated Message. |
commercetools_products_create_products_images_by_id | Uploads a JPEG, PNG, or a GIF image file to a ProductVariant. The maximum file size of the image is 10MB. Either variant or sku is required to update a specific ProductVariant. If neither is provided, the image is uploaded to the Master Variant of the Product. The response status code depends on the size of the original image. If the image is small, the API responds with 200 OK, and if the image is larger, it responds with 202 Accepted. The Product returned with a 202 Accepted status code contains a warnings field with an ImageProcessingOngoing Warning. Produces the ProductImageAdded Message. |
commercetools_products_create_products_search | If indexing is in progress or if Product Search is inactive, an ObjectNotFound error is returned. If inactive, you can reactivate it. |
commercetools_products_delete_attribute_groups_by_id | DELETE /attribute-groups/{ID} |
commercetools_products_delete_attribute_groups_by_key | DELETE /attribute-groups/key={key} |
commercetools_products_delete_by_id | If Product price selection query parameters are provided, the selected Prices are added to the response. Produces the ProductDeleted Message. |
commercetools_products_delete_by_key | If Product price selection query parameters are provided, the selected Prices are added to the response. Produces the ProductDeleted Message. |
commercetools_products_delete_product_tailoring_by_id | Generates the ProductTailoringDeleted Message. |
commercetools_products_delete_product_tailoring_by_key | Generates the ProductTailoringDeleted Message. |
commercetools_products_delete_product_types_by_id | DELETE /product-types/{ID} |
commercetools_products_delete_product_types_by_key | DELETE /product-types/key={key} |
commercetools_products_get_attribute_groups_by_id | GET /attribute-groups/{ID} |
commercetools_products_get_attribute_groups_by_key | GET /attribute-groups/key={key} |
commercetools_products_get_by_id | If Product price selection query parameters are provided, the selected Prices are added to the response. |
commercetools_products_get_by_key | If Product price selection query parameters are provided, the selected Prices are added to the response. |
commercetools_products_get_product_projections_by_id | Retrieves the projected representation of a Product by its ID. By default, this endpoint returns the current representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope. |
commercetools_products_get_product_projections_by_key | Retrieves the projected representation of a Product by its Key. By default, this endpoint returns the current representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope. |
commercetools_products_get_product_tailoring_by_id | GET /product-tailoring/{ID} |
commercetools_products_get_product_tailoring_by_key | GET /product-tailoring/key={key} |
commercetools_products_get_product_types_by_id | GET /product-types/{ID} |
commercetools_products_get_product_types_by_key | GET /product-types/key={key} |
commercetools_products_list_attribute_groups | GET /attribute-groups |
commercetools_products_list_product_projections | Retrieves the projected representation of Products by query predicates. By default, this endpoint returns the current representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope. |
commercetools_products_list_product_projections_search | This method appends query parameters to the URL. The maximum allowed URL length is 8192 characters. Exceeding this limit will result in URL truncation, potentially leading to unexpected results. For funnel searches on Product Listing Pages, where users select multiple filters, we recommend the POST method which passes the query parameters within the request body, avoiding URL length restrictions. |
commercetools_products_list_product_projections_suggest | GET /product-projections/suggest |
commercetools_products_list_product_tailoring | GET /product-tailoring |
commercetools_products_list_product_types | GET /product-types |
commercetools_products_list_products | If Product price selection query parameters are provided, the selected Prices are added to the response. |
commercetools_products_list_products_product_selections_by_id | GET /products/{ID}/product-selections |
commercetools_products_list_products_product_selections_by_key | GET /products/key={key}/product-selections |
commercetools_products_update_attribute_groups_by_id | POST /attribute-groups/{ID} |
commercetools_products_update_attribute_groups_by_key | POST /attribute-groups/key={key} |
commercetools_products_update_product_tailoring_by_id | POST /product-tailoring/{ID} |
commercetools_products_update_product_tailoring_by_key | POST /product-tailoring/key={key} |
commercetools_products_update_product_types_by_id | POST /product-types/{ID} |
commercetools_products_update_product_types_by_key | POST /product-types/key={key} |
commercetools_products_update_products_by_id | If Product price selection query parameters are provided, the selected Prices are added to the response. A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error. |
commercetools_products_update_products_by_key | A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error. |
commercetools_products_create_attribute_groups
POST /attribute-groups Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
attributes | object[] | Yes | — | The attributes value |
description | object | No | — | The description value |
key | string | No | — | The key value |
name | object | Yes | — | The name value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "The key value"
}
},
"required": [
"key"
]
},
"description": "The attributes value"
},
"description": {
"type": "object",
"description": "The description value"
},
"key": {
"type": "string",
"description": "The key value"
},
"name": {
"type": "object",
"description": "The name value"
}
},
"required": [
"PCID",
"attributes",
"name"
]
}
commercetools_products_create_product_projections_search
For implementing funnel search on Product Listing Pages where users select multiple filters, use this POST method. To avoid URL length restrictions, this method passes the same query parameters as defined in the GET method, within the request body in URL-encoded format. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | No | — | Request body |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"type": "string",
"description": "Request body"
}
},
"required": [
"PCID"
]
}
commercetools_products_create_product_tailoring
Generates the ProductTailoringCreated Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
attributes | object[] | No | — | The attributes value |
description | object | No | — | The description value |
key | string | No | — | The key value |
metaDescription | object | No | — | Meta Description |
metaKeywords | object | No | — | Meta Keywords |
metaTitle | object | No | — | Meta Title |
name | object | No | — | The name value |
product | object | Yes | — | The product value |
publish | boolean | No | — | The publish value |
slug | object | No | — | The slug value |
store | object | Yes | — | The store value |
variants | object[] | No | — | The variants value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"value": {
"description": "The value value"
}
},
"required": [
"name",
"value"
]
},
"description": "The attributes value"
},
"description": {
"type": "object",
"description": "The description value"
},
"key": {
"type": "string",
"description": "The key value"
},
"metaDescription": {
"type": "object",
"description": "Meta Description"
},
"metaKeywords": {
"type": "object",
"description": "Meta Keywords"
},
"metaTitle": {
"type": "object",
"description": "Meta Title"
},
"name": {
"type": "object",
"description": "The name value"
},
"product": {
"description": "The product value"
},
"publish": {
"type": "boolean",
"description": "The publish value"
},
"slug": {
"type": "object",
"description": "The slug value"
},
"store": {
"description": "The store value"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "The id value"
},
"sku": {
"type": "string",
"description": "The sku value"
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"dimensions": {
"type": "object"
},
"label": {
"type": "string"
}
}
},
"description": "The images value"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sources": {
"type": "array"
},
"name": {
"type": "object"
},
"description": {
"type": "object"
},
"tags": {
"type": "array"
},
"custom": {
"type": "object"
},
"key": {
"type": "string"
}
}
},
"description": "The assets value"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {}
}
},
"description": "The attributes value"
}
}
},
"description": "The variants value"
}
},
"required": [
"PCID",
"product",
"store"
]
}
commercetools_products_create_product_types
POST /product-types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string[] | No | — | Related resources to expand inline |
attributes | object[] | No | — | The attributes value |
description | string | Yes | — | The description value |
key | string | No | — | The key value |
name | string | Yes | — | The name value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"type": {
"type": "object",
"description": "The type value"
},
"name": {
"type": "string",
"description": "The name value"
},
"label": {
"type": "object",
"description": "The label value"
},
"isRequired": {
"type": "boolean",
"description": "Is Required"
},
"level": {
"type": "string",
"enum": [
"Product",
"Variant"
],
"description": "The level value"
},
"attributeConstraint": {
"type": "string",
"enum": [
"None",
"Unique",
"CombinationUnique",
"SameForAll"
],
"description": "Attribute Constraint"
},
"inputTip": {
"type": "object",
"description": "Input Tip"
},
"inputHint": {
"type": "string",
"enum": [
"SingleLine",
"MultiLine"
],
"description": "Input Hint"
},
"isSearchable": {
"type": "boolean",
"description": "Is Searchable"
}
},
"required": [
"isRequired",
"label",
"name",
"type"
]
},
"description": "The attributes value"
},
"description": {
"type": "string",
"description": "The description value"
},
"key": {
"type": "string",
"description": "The key value"
},
"name": {
"type": "string",
"description": "The name value"
}
},
"required": [
"PCID",
"description",
"name"
]
}
commercetools_products_create_products
To create a new Product, send a representation that is going to become the initial staged and current representation of the new Product in the catalog. If Product price selection query parameters are provided, selected Prices will be added to the response. Produces the ProductCreated Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
expand | string[] | No | — | Related resources to expand inline |
attributes | object[] | No | — | The attributes value |
categories | any[] | No | — | The categories value |
categoryOrderHints | object | No | — | Category Order Hints |
description | object | No | — | The description value |
key | string | No | — | The key value |
masterVariant | object | No | — | Master Variant |
metaDescription | object | No | — | Meta Description |
metaKeywords | object | No | — | Meta Keywords |
metaTitle | object | No | — | Meta Title |
name | object | Yes | — | The name value |
priceMode | string | No | — | Price Mode |
productType | object | Yes | — | Product Type |
publish | boolean | No | — | The publish value |
searchKeywords | object | No | — | Search Keywords |
slug | object | Yes | — | The slug value |
state | object | No | — | The state value |
taxCategory | object | No | — | Tax Category |
variants | object[] | No | — | The variants value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name value"
},
"value": {
"description": "The value value"
}
},
"required": [
"name",
"value"
]
},
"description": "The attributes value"
},
"categories": {
"type": "array",
"description": "The categories value"
},
"categoryOrderHints": {
"type": "object",
"description": "Category Order Hints"
},
"description": {
"type": "object",
"description": "The description value"
},
"key": {
"type": "string",
"description": "The key value"
},
"masterVariant": {
"type": "object",
"description": "Master Variant",
"properties": {
"sku": {
"type": "string",
"description": "The sku value"
},
"key": {
"type": "string",
"description": "The key value"
},
"prices": {
"type": "array",
"items": {
"type": "object"
},
"description": "The prices value"
},
"attributes": {
"type": "array",
"items": {
"type": "object"
},
"description": "The attributes value"
},
"images": {
"type": "array",
"items": {
"type": "object"
},
"description": "The images value"
},
"assets": {
"type": "array",
"items": {
"type": "object"
},
"description": "The assets value"
}
}
},
"metaDescription": {
"type": "object",
"description": "Meta Description"
},
"metaKeywords": {
"type": "object",
"description": "Meta Keywords"
},
"metaTitle": {
"type": "object",
"description": "Meta Title"
},
"name": {
"type": "object",
"description": "The name value"
},
"priceMode": {
"type": "string",
"description": "Price Mode",
"enum": [
"Embedded",
"Standalone"
]
},
"productType": {
"description": "Product Type"
},
"publish": {
"type": "boolean",
"description": "The publish value"
},
"searchKeywords": {
"type": "object",
"description": "Search Keywords"
},
"slug": {
"type": "object",
"description": "The slug value"
},
"state": {
"description": "The state value"
},
"taxCategory": {
"description": "Tax Category"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "The sku value"
},
"key": {
"type": "string",
"description": "The key value"
},
"prices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "object"
},
"country": {
"type": "string"
},
"customerGroup": {},
"channel": {},
"validFrom": {
"type": "string"
},
"validUntil": {
"type": "string"
},
"discounted": {
"type": "object"
},
"tiers": {
"type": "array"
},
"custom": {
"type": "object"
},
"recurrencePolicy": {}
}
},
"description": "The prices value"
},
"attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {}
}
},
"description": "The attributes value"
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"url": {
"type": "string"
},
"dimensions": {
"type": "object"
},
"label": {
"type": "string"
}
}
},
"description": "The images value"
},
"assets": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sources": {
"type": "array"
},
"name": {
"type": "object"
},
"description": {
"type": "object"
},
"tags": {
"type": "array"
},
"custom": {
"type": "object"
},
"key": {
"type": "string"
}
}
},
"description": "The assets value"
}
}
},
"description": "The variants value"
}
},
"required": [
"PCID",
"name",
"productType",
"slug"
]
}
commercetools_products_create_products_images_by_id
Uploads a JPEG, PNG, or a GIF image file to a ProductVariant. The maximum file size of the image is 10MB. Eithervariant or sku is required to update a specific ProductVariant. If neither is provided, the image is uploaded to the Master Variant of the Product. The response status code depends on the size of the original image. If the image is small, the API responds with 200 OK, and if the image is larger, it responds with 202 Accepted. The Product returned with a 202 Accepted status code contains a warnings field with an ImageProcessingOngoing Warning. Produces the ProductImageAdded Message.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
filename | string | No | — | The filename value |
variant | number | No | — | The variant value |
sku | string | No | — | The sku value |
staged | boolean | No | — | The staged value |
body | string | No | — | Request body |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"filename": {
"type": "string",
"description": "The filename value"
},
"variant": {
"type": "number",
"description": "The variant value"
},
"sku": {
"type": "string",
"description": "The sku value"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"body": {
"type": "string",
"description": "Request body"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_create_products_search
If indexing is in progress or if Product Search is inactive, an ObjectNotFound error is returned. If inactive, you can reactivate it. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
facets | object[] | No | — | The facets value |
limit | integer | No | — | Maximum number of results to return |
markMatchingVariants | boolean | No | — | Mark Matching Variants |
offset | integer | No | — | The offset value |
postFilter | object | No | — | Post Filter |
productProjectionParameters | object | No | — | Product Projection Parameters |
query | object | No | — | Search query string |
sort | object[] | No | — | Sort order for results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"facets": {
"type": "array",
"items": {
"type": "object"
},
"description": "The facets value"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"markMatchingVariants": {
"type": "boolean",
"description": "Mark Matching Variants"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"postFilter": {
"type": "object",
"description": "Post Filter"
},
"productProjectionParameters": {
"type": "object",
"description": "Product Projection Parameters",
"properties": {
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"localeProjection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Locale Projection"
},
"storeProjection": {
"type": "string",
"description": "Store Projection"
}
}
},
"query": {
"type": "object",
"description": "Search query string"
},
"sort": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"description": "The field value"
},
"language": {
"type": "string",
"description": "The language value"
},
"order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "The order value"
},
"mode": {
"type": "string",
"enum": [
"min",
"max",
"avg",
"sum"
],
"description": "The mode value"
},
"fieldType": {
"type": "string",
"enum": [
"boolean",
"text",
"ltext",
"enum",
"lenum",
"number",
"money",
"date",
"datetime",
"time",
"reference",
"set_boolean",
"set_text",
"set_ltext",
"set_enum",
"set_lenum",
"set_number",
"set_money",
"set_date",
"set_datetime",
"set_time",
"set_reference"
],
"description": "Field Type"
},
"filter": {
"type": "object",
"description": "The filter value"
}
},
"required": [
"field",
"order"
]
},
"description": "Sort order for results"
}
},
"required": [
"PCID"
]
}
commercetools_products_delete_attribute_groups_by_id
DELETE /attribute-groups/{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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
commercetools_products_delete_attribute_groups_by_key
DELETE /attribute-groups/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
commercetools_products_delete_by_id
If Product price selection query parameters are provided, the selected Prices are added to the response. Produces the ProductDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
commercetools_products_delete_by_key
If Product price selection query parameters are provided, the selected Prices are added to the response. Produces the ProductDeleted Message. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
version | integer | Yes | — | The version value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
commercetools_products_delete_product_tailoring_by_id
Generates the ProductTailoringDeleted Message. 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
commercetools_products_delete_product_tailoring_by_key
Generates the ProductTailoringDeleted Message. 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
commercetools_products_delete_product_types_by_id
DELETE /product-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID",
"version"
]
}
commercetools_products_delete_product_types_by_key
DELETE /product-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"version": {
"type": "integer",
"description": "The version value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key",
"version"
]
}
commercetools_products_get_attribute_groups_by_id
GET /attribute-groups/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_get_attribute_groups_by_key
GET /attribute-groups/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_get_by_id
If Product price selection query parameters are provided, the selected Prices are added to the response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_get_by_key
If Product price selection query parameters are provided, the selected Prices are added to the response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_get_product_projections_by_id
Retrieves the projected representation of a Product by its ID. By default, this endpoint returns thecurrent representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
staged | boolean | No | — | The staged value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
localeProjection | string[] | No | — | Locale Projection |
storeProjection | string | No | — | Store Projection |
filter[attributes] | string[] | No | — | The filter[attributes] value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"localeProjection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Locale Projection"
},
"storeProjection": {
"type": "string",
"description": "Store Projection"
},
"filter[attributes]": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter[attributes] value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_get_product_projections_by_key
Retrieves the projected representation of a Product by its Key. By default, this endpoint returns thecurrent representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
staged | boolean | No | — | The staged value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
localeProjection | string[] | No | — | Locale Projection |
storeProjection | string | No | — | Store Projection |
filter[attributes] | string[] | No | — | The filter[attributes] value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"localeProjection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Locale Projection"
},
"storeProjection": {
"type": "string",
"description": "Store Projection"
},
"filter[attributes]": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter[attributes] value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_get_product_tailoring_by_id
GET /product-tailoring/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_get_product_tailoring_by_key
GET /product-tailoring/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_get_product_types_by_id
GET /product-types/{ID} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_get_product_types_by_key
GET /product-types/key={key} Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
expand | string[] | No | — | Related resources to expand inline |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_list_attribute_groups
GET /attribute-groups 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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_product_projections
Retrieves the projected representation of Products by query predicates. By default, this endpoint returns thecurrent representation of Products where the published flag is true. If a Product is unpublished (published=false), the endpoint returns a Not Found error. Required access scopes: - To retrieve the current representation of published Products (published data), the view_published_products:{projectKey} scope is required. - To retrieve the staged representation of Products (draft data) or access unpublished Products, the API Client must have the view_products:{projectKey} scope.
Parameters:
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
staged | boolean | No | — | The staged value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
localeProjection | string[] | No | — | Locale Projection |
storeProjection | string | No | — | Store Projection |
filter[attributes] | string[] | No | — | The filter[attributes] value |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"localeProjection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Locale Projection"
},
"storeProjection": {
"type": "string",
"description": "Store Projection"
},
"filter[attributes]": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter[attributes] value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_product_projections_search
This method appends query parameters to the URL. The maximum allowed URL length is 8192 characters. Exceeding this limit will result in URL truncation, potentially leading to unexpected results. For funnel searches on Product Listing Pages, where users select multiple filters, we recommend the POST method which passes the query parameters within the request body, avoiding URL length restrictions. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
markMatchingVariants | boolean | No | — | Mark Matching Variants |
fuzzy | boolean | No | — | The fuzzy value |
fuzzyLevel | number | No | — | Fuzzy Level |
filter.query | string[] | No | — | The filter.query value |
filter | string[] | No | — | The filter value |
facet | string[] | No | — | The facet value |
filter.facets | string[] | No | — | The filter.facets value |
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 |
staged | boolean | No | — | The staged value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
localeProjection | string[] | No | — | Locale Projection |
storeProjection | string | No | — | Store Projection |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"markMatchingVariants": {
"type": "boolean",
"description": "Mark Matching Variants"
},
"fuzzy": {
"type": "boolean",
"description": "The fuzzy value"
},
"fuzzyLevel": {
"type": "number",
"description": "Fuzzy Level"
},
"filter.query": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter.query value"
},
"filter": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter value"
},
"facet": {
"type": "array",
"items": {
"type": "string"
},
"description": "The facet value"
},
"filter.facets": {
"type": "array",
"items": {
"type": "string"
},
"description": "The filter.facets value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"staged": {
"type": "boolean",
"description": "The staged value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"localeProjection": {
"type": "array",
"items": {
"type": "string"
},
"description": "Locale Projection"
},
"storeProjection": {
"type": "string",
"description": "Store Projection"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_product_projections_suggest
GET /product-projections/suggest Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Maximum number of results to return |
fuzzy | boolean | No | — | The fuzzy value |
staged | boolean | No | — | The staged value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"fuzzy": {
"type": "boolean",
"description": "The fuzzy value"
},
"staged": {
"type": "boolean",
"description": "The staged value"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_product_tailoring
GET /product-tailoring Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
withTotal | boolean | No | — | With Total |
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 |
where | string[] | No | — | The where value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_product_types
GET /product-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_products
If Product price selection query parameters are provided, the selected Prices are added to the response. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
where | string[] | No | — | The where value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
}
},
"required": [
"PCID"
]
}
commercetools_products_list_products_product_selections_by_id
GET /products/{ID}/product-selections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
withTotal | boolean | No | — | With Total |
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 |
where | string[] | No | — | The where value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID",
"ID"
]
}
commercetools_products_list_products_product_selections_by_key
GET /products/key={key}/product-selections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
withTotal | boolean | No | — | With Total |
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 |
where | string[] | No | — | The where value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"withTotal": {
"type": "boolean",
"description": "With Total"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"sort": {
"type": "array",
"items": {
"type": "string"
},
"description": "Sort order for results"
},
"limit": {
"type": "integer",
"description": "Maximum number of results to return"
},
"offset": {
"type": "integer",
"description": "The offset value"
},
"where": {
"type": "array",
"items": {
"type": "string"
},
"description": "The where value"
}
},
"required": [
"PCID",
"key"
]
}
commercetools_products_update_attribute_groups_by_id
POST /attribute-groups/{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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"ID",
"actions",
"version"
]
}
commercetools_products_update_attribute_groups_by_key
POST /attribute-groups/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"key",
"actions",
"version"
]
}
commercetools_products_update_product_tailoring_by_id
POST /product-tailoring/{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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"ID",
"actions",
"version"
]
}
commercetools_products_update_product_tailoring_by_key
POST /product-tailoring/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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"key",
"actions",
"version"
]
}
commercetools_products_update_product_types_by_id
POST /product-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"ID",
"actions",
"version"
]
}
commercetools_products_update_product_types_by_key
POST /product-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 |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"key",
"actions",
"version"
]
}
commercetools_products_update_products_by_id
If Product price selection query parameters are provided, the selected Prices are added to the response. A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
ID | string | Yes | — | The id value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"ID": {
"type": "string",
"description": "The id value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"ID",
"actions",
"version"
]
}
commercetools_products_update_products_by_key
A failed response can return a DuplicatePriceScope, DuplicateVariantValues, DuplicateAttributeValue, or DuplicateAttributeValues error. Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | Yes | — | The key value |
priceCurrency | string | No | — | Price Currency |
priceCountry | string | No | — | Price Country |
priceCustomerGroup | string | No | — | Price Customer Group |
priceCustomerGroupAssignments | string[] | No | — | Price Customer Group Assignments |
priceChannel | string | No | — | Price Channel |
priceRecurrencePolicy | string | No | — | Price Recurrence Policy |
expand | string[] | No | — | Related resources to expand inline |
actions | object[] | Yes | — | The actions value |
version | integer | Yes | — | The version value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"key": {
"type": "string",
"description": "The key value"
},
"priceCurrency": {
"type": "string",
"description": "Price Currency"
},
"priceCountry": {
"type": "string",
"description": "Price Country"
},
"priceCustomerGroup": {
"type": "string",
"description": "Price Customer Group"
},
"priceCustomerGroupAssignments": {
"type": "array",
"items": {
"type": "string"
},
"description": "Price Customer Group Assignments"
},
"priceChannel": {
"type": "string",
"description": "Price Channel"
},
"priceRecurrencePolicy": {
"type": "string",
"description": "Price Recurrence Policy"
},
"expand": {
"type": "array",
"items": {
"type": "string"
},
"description": "Related resources to expand inline"
},
"actions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"description": "The action value"
}
},
"required": [
"action"
]
},
"description": "The actions value"
},
"version": {
"type": "integer",
"description": "The version value"
}
},
"required": [
"PCID",
"key",
"actions",
"version"
]
}