Update a product or bundle

PUT 
https://euwest.api.elasticpath.com/pcm/products/:productID

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the product or bundle is not updated.

Request

Path Parameters

productID stringrequired

A unique identifier for the product.

application/json

Body

data objectrequired

typestringrequired

This represents the type of resource object being returned. Always product.

Possible values: [product]

Example: product

idstringrequired

The unique identifier of the product. Must match the product ID specified in the request path.

Example: 00000000-0000-0000-0000-000000000000

attributes objectrequired

external_refstring

The unique attribute associated with the product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters.

namestring

The product name to display to customers.

descriptionstring

A description for the product.

slugstring

The unique slug of the product. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed.

skustring

The unique stock keeping unit of the product.

statusstring

The status for the product, either draft or live. Default is draft. For a product to appear in a catalog it must be in a live status.

Possible values: [live, draft]

commodity_typestring

The commodity type, either physical or digital.

Possible values: [physical, digital]

upc_eanstring

The universal product code or european article number of the product.

mpnstring

The manufacturer part number of the product.

tagsstring[]

You can use product tags to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. A product can have up to 20 tags. A product tag can be up to 255 characters. Product tags must not contain any spaces or commas. See Product Tags.

build_rules object

You can build a combination of child products associated with a product, based on build rules that you specify. This is useful, for example, if you have a variation option that you do not sell. This makes managing and building your child products quick and easy. See Using Build Rules.

defaultstring

Specifies the default behaviour, either include or exclude.

Possible values: [include, exclude]

includearray[]

An array of option IDs to include when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.

excludearray[]

An array of option IDs to exclude when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.

locales object

Product Experience Manager supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and descriptions. You can have as many locales as you want.

property name* object

A three-letter language code that represents the name of language you have used.

namestringrequired

A localized name for the product.

descriptionstring

A localized description for the product.

custom_inputs object

You use the custom_inputs attribute to allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized or you sell greetings cards that can be printed with your shoppers personalized messages. See Personalizing Products.

property name* object

A name for the custom text field. You can rename this to something more representative of the input that shoppers are adding, for example, message or front.

namestring

A name for the custom text field.

validation_rulesarray

The validation rules for the custom text.

typestring

This represents the type of the resource being returned.

optionsobject

The length of the custom input text field.

max_lengthinteger

The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters.

requiredboolean

true or false depending on whether the custom text is required.

components object

With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity. See Bundles.

property name* object

The name of the component, such as games. The bundle_configuration uses the component name to reference a component. A component name should be relatively short and must not contain any special characters.

namestring

The component name. The component name is the name that is displayed in your storefront.

options object[]

The product options included in a component. This can be the ID of another bundle.

Array [

idstring

The unique ID of the product you want to add to a component.

typestring

This represents the type of object being returned. Always product.

quantityinteger

The number of this product option that a shopper must purchase.

Possible values: >= 1

mininteger

The minimum quantity of this product option that a shopper can select. Must be 1 or greater. If specified, max must also be specified.

Possible values: >= 1

maxinteger

The maximum quantity of this product option that a shopper can select. Must be 1 or greater and greater than or equal to min. If specified, min must also be specified.

Possible values: >= 1

sort_orderinteger

The sort order of the options. The create a bundle and update a bundle endpoints do not sort the options. You can use the sort_order attribute when programming your storefront to display the options in the order that you want.

defaultboolean

Whether the product option is a default option in a bundle. Shoppers can select a bundle that specifies a default list of product options. See Dynamic Bundles.

]

mininteger

The minimum number of product options a shopper can select from this component.

maxinteger

The maximum number of product options a shopper can select from this component.

sort_orderinteger

The sort order of the components. The create a bundle and update a bundle endpoints do not sort the components. You can use the sort_order attribute when programming your storefront to display the components in the order that you want.

Responses

200

Updates a product with the following attributes.

application/json

Schema

Schema

data object
idstring
A unique product ID that is generated when you create the product.
typestring
This represents the type of resource object being returned. Always product.
Possible values: [product]
attributes object
namestring
A name for the product.
descriptionstring
A description for the product.
slugstring
A label for the product that is used in the URL paths. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. By default, the product name is used as the slug.
skustring
The unique stock keeping unit of the product.
statusstring
The status for the product, either draft or live.
Possible values: [live, draft]
commodity_typestring
The commodity type, either physical or digital.
Possible values: [physical, digital]
upc_eanstring
The universal product code or european article number of the product.
mpnstring
The manufacturer part number of the product.
external_refstring
The unique attribute associated with the product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters.
locales object
Product Experience Manager supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and descriptions. You can have as many locales as you want.
property name* object
A three-letter language code that represents the name of language you have used.
namestringrequired
A localized name for the product.
descriptionstring
A localized description for the product.
tagsstring[]
You can use product tags to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. A product can have up to 20 tags. A product tag can be up to 255 characters. Product tags must not contain any spaces or commas.
extensions object
property name* object
property name* object
oneOf
string
stringnullable
integer
integer
boolean
boolean
custom_inputs object
You use the custom_inputs attribute to allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized or you sell greetings cards that can be printed with your shoppers personalized messages. See Personalizing Products.
property name* object
A name for the custom text field. You can rename this to something more representative of the input that shoppers are adding, for example, message or front.
namestring
A name for the custom text field.
validation_rulesarray
The validation rules for the custom text.
typestring
This represents the type of the resource being returned.
optionsobject
The length of the custom input text field.
max_lengthinteger
The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters.
requiredboolean
true or false depending on whether the custom text is required.
build_rules object
You can build a combination of child products associated with a product, based on build rules that you specify. This is useful, for example, if you have a variation option that you do not sell. This makes managing and building your child products quick and easy. See Using Build Rules.
defaultstring
Specifies the default behaviour, either include or exclude.
Possible values: [include, exclude]
includearray[]
An array of option IDs to include when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.
excludearray[]
An array of option IDs to exclude when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.
components object
With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity. See Bundles.
property name* object
The name of the component, such as games. The bundle_configuration uses the component name to reference a component. A component name should be relatively short and must not contain any special characters.
namestring
The component name. The component name is the name that is displayed in your storefront.
options object[]
The product options included in a component. This can be the ID of another bundle.
Array [
idstring
The unique ID of the product you want to add to a component.
typestring
This represents the type of object being returned. Always product.
quantityinteger
The number of this product option that a shopper must purchase.
Possible values: >= 1
mininteger
The minimum quantity of this product option that a shopper can select. Must be 1 or greater. If specified, max must also be specified.
Possible values: >= 1
maxinteger
The maximum quantity of this product option that a shopper can select. Must be 1 or greater and greater than or equal to min. If specified, min must also be specified.
Possible values: >= 1
sort_orderinteger
The sort order of the options. The create a bundle and update a bundle endpoints do not sort the options. You can use the sort_order attribute when programming your storefront to display the options in the order that you want.
defaultboolean
Whether the product option is a default option in a bundle. Shoppers can select a bundle that specifies a default list of product options. See Dynamic Bundles.
]
mininteger
The minimum number of product options a shopper can select from this component.
maxinteger
The maximum number of product options a shopper can select from this component.
sort_orderinteger
The sort order of the components. The create a bundle and update a bundle endpoints do not sort the components. You can use the sort_order attribute when programming your storefront to display the components in the order that you want.
meta object
created_atstring<date-time>
The date and time a product is created.
Example: 2020-09-22T09:00:00
updated_atstring<date-time>
The date and time a product is updated.
Example: 2020-09-22T09:00:00
ownerstring
The resource owner, either organization or store.
Possible values: [organization, store]
variations object[]
A product's variations and the options defined for each variation. If you have specified build_rules, only the child products included in the build_rules are specified.
Array [
idstring
A unique ID generated when a variation is created.
namestring
The name of a variation.
options object[]
Array [
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
]
custom_relationshipsarray
Custom relationship slugs that are attached to the product.
child_variations object[]nullable
A child product's variations and the option defined for each variation. This details the variation and options specific to a child product.
Array [
idstring
A unique ID generated when a variation is created.
namestring
The name of a variation.
sort_orderinteger
The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want. The variation with the highest value of sort_order is displayed first. For example, a variation with a sort_order value of 3 appears before a variation with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, including, zero or negative numbers. You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.
options object[]nullable
This will be unset for child product variations.
Array [
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
option object
The options available for this variation.
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
product_typesstring[]
One of the following product types:
• standard - A standard product is a standalone product.
• parent - A parent product is a product that has child products that have been built using the Build Child Products endpoint.
• child - When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.
• bundle - A bundle is a purchasable product, comprising one or more standalone products (in other words, components) to be sold together.
Possible values: [parent, child, bundle, standard]
variation_matrixobject
The child products defined for a product. The order of the variations in the variation_matrix is the order of the variations in the array when the variations were linked to the product. For example, the first variation in the variation_matrix corresponds to the first variation in the array, and so on. You can use the sort_orderattribute to sort the order of your variation and variation options in the variation_matrix object. See Sorting the Order of Variations and Options If no variations are defined for a product, the variation_matrix is empty.
relationships object
Relationships are established between different product entities. For example, a bundle product and a child product are related to a parent product, as both are associated with it.
property name* object
data object
oneOf
array
Array [
idstring
A unique identifier for a resource.
typestring
This represents the type of resource object being returned.
]
object
idstring
A unique identifier for a resource.
typestring
This represents the type of resource object being returned.
links object
Links are used to allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Sometimes, there are not enough entities for a project to fill multiple pages. In this situation, we return some defaults.
Property	Description
current	Always the current page.
first	Always the first page.
last	null if there is only one page.
prev	null if the user is on the first page.
next	null if there is only one page.
property name*string
included object
Included is an array of resources that are included in the response.
main_images object[]
The main images associated with a product.
Array [
idstring<uuid>
The unique identifier for this file.
typestring
The type represents the object being returned.
Example: file
file_namestring
The name of the file.
Example: file_name.jpg
mime_typestring
The mime type of the file.
Example: image/jpeg
file_sizeinteger
The size of the file. Required when uploading files.
Example: 36000
publicboolean
DEPRECATED Whether the file public or not. Required when uploading files.
Example: true
meta
timestamps object
The date and time the file was created.
created_atstring
The date and time the file was created.
Example: 2023-10-11T13:02:25.293Z
dimensions object
The file dimensions.
widthinteger
The width of the file.
Example: 1800
heightinteger
The height of the file.
Example: 1000
links object
Links are used to allow you to move between requests.
selfstring
Single entities use a self parameter with a link to that specific resource.
Example: https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52
link object
The publicly available URL for this file.
hrefstring
The publicly available URL for this file.
Example: https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png
meta object
results object
Contains the results for the entire collection.
totalinteger
Total number of results for the entire collection.
Example: 2
]
component_products object[]
Returns a list of component products in a product bundle. If a bundle has no component products (in other words, is not a product bundle), an empty array is returned.
Array [
idstring
A unique product ID that is generated when you create the product.
typestring
This represents the type of resource object being returned. Always product.
Possible values: [product]
attributes object
namestring
A name for the product.
descriptionstring
A description for the product.
slugstring
A label for the product that is used in the URL paths. A slug can contain A to Z, a to z, 0 to 9, hyphen, underscore, and period. Spaces or other special characters like ^, [], *, and $ are not allowed. By default, the product name is used as the slug.
skustring
The unique stock keeping unit of the product.
statusstring
The status for the product, either draft or live.
Possible values: [live, draft]
commodity_typestring
The commodity type, either physical or digital.
Possible values: [physical, digital]
upc_eanstring
The universal product code or european article number of the product.
mpnstring
The manufacturer part number of the product.
external_refstring
The unique attribute associated with the product. This could be an external reference from a separate company system, for example. The maximum length is 2048 characters.
locales object
Product Experience Manager supports localization of products and hierarchies. If your store supports multiple languages, you can localize product names and descriptions. You can have as many locales as you want.
property name* object
A three-letter language code that represents the name of language you have used.
namestringrequired
A localized name for the product.
descriptionstring
A localized description for the product.
tagsstring[]
You can use product tags to store or assign a key word against a product. The product tag can then be used to describe or label that product. Using product tags means that you can group your products together, for example, by brand, category, subcategory, colors, types, industries, and so on. A product can have up to 20 tags. A product tag can be up to 255 characters. Product tags must not contain any spaces or commas.
extensions object
property name* object
property name* object
oneOf
string
stringnullable
integer
integer
boolean
boolean
custom_inputs object
You use the custom_inputs attribute to allow your shoppers to add custom text to a product when adding product items to their carts. This is useful, for example, if you have a product like a T-shirt that can be personalized or you sell greetings cards that can be printed with your shoppers personalized messages. See Personalizing Products.
property name* object
A name for the custom text field. You can rename this to something more representative of the input that shoppers are adding, for example, message or front.
namestring
A name for the custom text field.
validation_rulesarray
The validation rules for the custom text.
typestring
This represents the type of the resource being returned.
optionsobject
The length of the custom input text field.
max_lengthinteger
The number of characters the custom text field can be. You can specify a maximum length up to 255 characters, as the limit is 255 characters.
requiredboolean
true or false depending on whether the custom text is required.
build_rules object
You can build a combination of child products associated with a product, based on build rules that you specify. This is useful, for example, if you have a variation option that you do not sell. This makes managing and building your child products quick and easy. See Using Build Rules.
defaultstring
Specifies the default behaviour, either include or exclude.
Possible values: [include, exclude]
includearray[]
An array of option IDs to include when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.
excludearray[]
An array of option IDs to exclude when child products are built. Each combination consists of a nested array of option IDs from one or more variations. Combinations of option IDs in the nested arrays must come from different variations.
components object
With Product Experience Manager, you can create and manage bundles. A bundle is a purchasable product, consisting of one or more products that you want to sell together. You can create multiple components within a bundle. Each component must have at least one or more options. Each option is a product and a quantity. See Bundles.
property name* object
The name of the component, such as games. The bundle_configuration uses the component name to reference a component. A component name should be relatively short and must not contain any special characters.
namestring
The component name. The component name is the name that is displayed in your storefront.
options object[]
The product options included in a component. This can be the ID of another bundle.
Array [
idstring
The unique ID of the product you want to add to a component.
typestring
This represents the type of object being returned. Always product.
quantityinteger
The number of this product option that a shopper must purchase.
Possible values: >= 1
mininteger
The minimum quantity of this product option that a shopper can select. Must be 1 or greater. If specified, max must also be specified.
Possible values: >= 1
maxinteger
The maximum quantity of this product option that a shopper can select. Must be 1 or greater and greater than or equal to min. If specified, min must also be specified.
Possible values: >= 1
sort_orderinteger
The sort order of the options. The create a bundle and update a bundle endpoints do not sort the options. You can use the sort_order attribute when programming your storefront to display the options in the order that you want.
defaultboolean
Whether the product option is a default option in a bundle. Shoppers can select a bundle that specifies a default list of product options. See Dynamic Bundles.
]
mininteger
The minimum number of product options a shopper can select from this component.
maxinteger
The maximum number of product options a shopper can select from this component.
sort_orderinteger
The sort order of the components. The create a bundle and update a bundle endpoints do not sort the components. You can use the sort_order attribute when programming your storefront to display the components in the order that you want.
meta object
created_atstring<date-time>
The date and time a product is created.
Example: 2020-09-22T09:00:00
updated_atstring<date-time>
The date and time a product is updated.
Example: 2020-09-22T09:00:00
ownerstring
The resource owner, either organization or store.
Possible values: [organization, store]
variations object[]
A product's variations and the options defined for each variation. If you have specified build_rules, only the child products included in the build_rules are specified.
Array [
idstring
A unique ID generated when a variation is created.
namestring
The name of a variation.
options object[]
Array [
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
]
custom_relationshipsarray
Custom relationship slugs that are attached to the product.
child_variations object[]nullable
A child product's variations and the option defined for each variation. This details the variation and options specific to a child product.
Array [
idstring
A unique ID generated when a variation is created.
namestring
The name of a variation.
sort_orderinteger
The sort order value is visible when you add the variations and variation options to your catalogs. You can then use the sort_order value to program your storefront to display the variation options in the order that you want. The variation with the highest value of sort_order is displayed first. For example, a variation with a sort_order value of 3 appears before a variation with a sort_order value of 2. You can specify any numbers that you want. You can use 1, 2, 3, or 100, 90, 80, including, zero or negative numbers. You can set sort_order to either null or omit it entirely from the request if you wish to remove an existing sort_order attribute.
options object[]nullable
This will be unset for child product variations.
Array [
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
option object
The options available for this variation.
idstring
A unique ID that is generated an option is created.
namestring
The name of an option.
descriptionstring
A description of an option.
]
product_typesstring[]
One of the following product types:
• standard - A standard product is a standalone product.
• parent - A parent product is a product that has child products that have been built using the Build Child Products endpoint.
• child - When you configure product variations and variation options for parent products, the child products derived from the parent products are automatically created in Commerce.
• bundle - A bundle is a purchasable product, comprising one or more standalone products (in other words, components) to be sold together.
Possible values: [parent, child, bundle, standard]
variation_matrixobject
The child products defined for a product. The order of the variations in the variation_matrix is the order of the variations in the array when the variations were linked to the product. For example, the first variation in the variation_matrix corresponds to the first variation in the array, and so on. You can use the sort_orderattribute to sort the order of your variation and variation options in the variation_matrix object. See Sorting the Order of Variations and Options If no variations are defined for a product, the variation_matrix is empty.
relationships object
Relationships are established between different product entities. For example, a bundle product and a child product are related to a parent product, as both are associated with it.
property name* object
data object
oneOf
array
Array [
idstring
A unique identifier for a resource.
typestring
This represents the type of resource object being returned.
]
object
idstring
A unique identifier for a resource.
typestring
This represents the type of resource object being returned.
links object
Links are used to allow you to move between requests. Single entities use a self parameter with a link to that specific resource. Sometimes, there are not enough entities for a project to fill multiple pages. In this situation, we return some defaults.
Property	Description
current	Always the current page.
first	Always the first page.
last	null if there is only one page.
prev	null if the user is on the first page.
next	null if there is only one page.
property name*string
]
files object[]
The files associated with a product.
Array [
idstring<uuid>
The unique identifier for this file.
typestring
The type represents the object being returned.
Example: file
file_namestring
The name of the file.
Example: file_name.jpg
mime_typestring
The mime type of the file.
Example: image/jpeg
file_sizeinteger
The size of the file. Required when uploading files.
Example: 36000
publicboolean
DEPRECATED Whether the file public or not. Required when uploading files.
Example: true
meta
timestamps object
The date and time the file was created.
created_atstring
The date and time the file was created.
Example: 2023-10-11T13:02:25.293Z
dimensions object
The file dimensions.
widthinteger
The width of the file.
Example: 1800
heightinteger
The height of the file.
Example: 1000
links object
Links are used to allow you to move between requests.
selfstring
Single entities use a self parameter with a link to that specific resource.
Example: https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52
link object
The publicly available URL for this file.
hrefstring
The publicly available URL for this file.
Example: https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png
meta object
results object
Contains the results for the entire collection.
totalinteger
Total number of results for the entire collection.
Example: 2
]

Example (auto)

{
  "data": {
    "id": "string",
    "type": "product",
    "attributes": {
      "name": "string",
      "description": "string",
      "slug": "string",
      "sku": "string",
      "status": "live",
      "commodity_type": "physical",
      "upc_ean": "string",
      "mpn": "string",
      "external_ref": "string",
      "locales": {},
      "tags": [
        "string"
      ],
      "extensions": {},
      "custom_inputs": {},
      "build_rules": {
        "default": "include",
        "include": [
          "string"
        ],
        "exclude": [
          "string"
        ]
      },
      "components": {}
    },
    "meta": {
      "created_at": "2020-09-22T09:00:00",
      "updated_at": "2020-09-22T09:00:00",
      "owner": "organization",
      "variations": [
        {
          "id": "string",
          "name": "string",
          "options": [
            {
              "id": "string",
              "name": "string",
              "description": "string"
            }
          ]
        }
      ],
      "custom_relationships": [
        null
      ],
      "child_variations": [
        {
          "id": "string",
          "name": "string",
          "sort_order": 0,
          "options": [
            {
              "id": "string",
              "name": "string",
              "description": "string"
            }
          ],
          "option": {
            "id": "string",
            "name": "string",
            "description": "string"
          }
        }
      ],
      "product_types": [
        "parent"
      ],
      "variation_matrix": {}
    },
    "relationships": {}
  },
  "included": {
    "main_images": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "file",
        "file_name": "file_name.jpg",
        "mime_type": "image/jpeg",
        "file_size": 36000,
        "public": true,
        "meta": {
          "timestamps": {
            "created_at": "2023-10-11T13:02:25.293Z"
          },
          "dimensions": {
            "width": 1800,
            "height": 1000
          }
        },
        "links": {
          "self": "https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
        },
        "link": {
          "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png",
          "meta": {
            "results": {
              "total": 2
            }
          }
        }
      }
    ],
    "component_products": [
      {
        "id": "string",
        "type": "product",
        "attributes": {
          "name": "string",
          "description": "string",
          "slug": "string",
          "sku": "string",
          "status": "live",
          "commodity_type": "physical",
          "upc_ean": "string",
          "mpn": "string",
          "external_ref": "string",
          "locales": {},
          "tags": [
            "string"
          ],
          "extensions": {},
          "custom_inputs": {},
          "build_rules": {
            "default": "include",
            "include": [
              "string"
            ],
            "exclude": [
              "string"
            ]
          },
          "components": {}
        },
        "meta": {
          "created_at": "2020-09-22T09:00:00",
          "updated_at": "2020-09-22T09:00:00",
          "owner": "organization",
          "variations": [
            {
              "id": "string",
              "name": "string",
              "options": [
                {
                  "id": "string",
                  "name": "string",
                  "description": "string"
                }
              ]
            }
          ],
          "custom_relationships": [
            null
          ],
          "child_variations": [
            {
              "id": "string",
              "name": "string",
              "sort_order": 0,
              "options": [
                {
                  "id": "string",
                  "name": "string",
                  "description": "string"
                }
              ],
              "option": {
                "id": "string",
                "name": "string",
                "description": "string"
              }
            }
          ],
          "product_types": [
            "parent"
          ],
          "variation_matrix": {}
        },
        "relationships": {}
      }
    ],
    "files": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "file",
        "file_name": "file_name.jpg",
        "mime_type": "image/jpeg",
        "file_size": 36000,
        "public": true,
        "meta": {
          "timestamps": {
            "created_at": "2023-10-11T13:02:25.293Z"
          },
          "dimensions": {
            "width": 1800,
            "height": 1000
          }
        },
        "links": {
          "self": "https://useast.api.elasticpath.com/v2/files/ddc28c74-a7df-46be-b262-8fa69a6e7d52"
        },
        "link": {
          "href": "https://files-eu.epusercontent.com/e8c53cb0-120d-4ea5-8941-ce74dec06038/f8cf26b3-6d38-4275-937a-624a83994702.png",
          "meta": {
            "results": {
              "total": 2
            }
          }
        }
      }
    ]
  }
}

updated-product

Update a base product

{
  "data": {
    "type": "product",
    "id": "60afe403-a191-455e-b771-c510c928a308",
    "attributes": {
      "commodity_type": "physical",
      "description": "The 30 inch version of this popular electric range.",
      "mpn": "BE-R-1111-aaaa-1a1a-30",
      "name": "UPDATED BestEver Range 30 inch, Model 1a1a-30",
      "sku": "BE-Range-1a1a-30",
      "slug": "bestever-range-1a1a-30",
      "status": "draft",
      "upc_ean": "111130303030",
      "locales": {
        "fr-FR": {
          "name": "MISE À JOUR de la gamme BestEver 30 pouces, modèle 1a1a-30",
          "description": "La version 30 pouces de cette cuisinière électrique populaire"
        }
      },
      "tags": [
        "tag1",
        "tag2"
      ]
    },
    "relationships": {
      "files": {
        "data": [],
        "links": {
          "self": "/products/60afe403-a191-455e-b771-c510c928a308/relationships/files"
        }
      },
      "templates": {
        "data": [],
        "links": {
          "self": "/products/60afe403-a191-455e-b771-c510c928a308/relationships/templates"
        }
      }
    },
    "meta": {
      "created_at": "2023-09-28T10:43:41.72Z",
      "owner": "organization",
      "product_types": [
        "standard"
      ],
      "updated_at": "2023-09-28T10:43:41.72Z"
    }
  }
}

build-rules

Update a base product, configure build rules

{
  "data": {
    "type": "product",
    "id": "9214719b-17fe-4ea7-896c-d61e60fc0d05",
    "attributes": {
      "build_rules": {
        "default": "include",
        "exclude": [
          [
            "cbde9096-e0e1-43d8-a1aa-cb66cf1d299f",
            "0b261f7d-753d-4af6-b9f4-62b436cca37d",
            "994c2029-519c-43d9-9c54-14f3af4e3efd"
          ]
        ]
      },
      "commodity_type": "physical",
      "description": "T-shirt.",
      "locales": {
        "fr-FR": {
          "name": "Shirt",
          "description": "T-Shirt."
        }
      },
      "mpn": "1234-5678-SSSS",
      "name": "Shirt",
      "sku": "978055216732567",
      "slug": "978055216732567",
      "status": "live",
      "upc_ean": "135623456"
    },
    "relationships": {
      "children": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/children"
        }
      },
      "component_products": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/component_products"
        }
      },
      "files": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/files"
        }
      },
      "main_image": {
        "data": null
      },
      "templates": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/templates"
        }
      },
      "variations": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/variations"
        }
      }
    },
    "meta": {
      "created_at": "2022-08-18T12:14:52.782Z",
      "owner": "store",
      "product_types": [
        "standard"
      ],
      "updated_at": "2022-08-18T12:40:13.484Z",
      "variation_matrix": {},
      "variations": [
        {
          "id": "6c4b5caa-3819-4366-a14e-c5b85009544b",
          "name": "Shirt Size",
          "options": [
            {
              "id": "cbde9096-e0e1-43d8-a1aa-cb66cf1d299f",
              "name": "Small",
              "description": "Size Small"
            },
            {
              "id": "da9d88d0-8ea6-434c-a0dd-059caf595687",
              "name": "Medium",
              "description": "Size Medium"
            },
            {
              "id": "07493fea-74b0-40a2-972a-cd7e1d6561bd",
              "name": "Large",
              "description": "Size Large"
            }
          ]
        },
        {
          "id": "b1ae545e-3375-455f-b5ea-09669b60996f",
          "name": "Shirt Material",
          "options": [
            {
              "id": "994c2029-519c-43d9-9c54-14f3af4e3efd",
              "name": "Cotton",
              "description": "Material Cotton"
            },
            {
              "id": "7951f3d9-f628-49f8-8a43-7749d28153d6",
              "name": "Denim",
              "description": "Material Denim"
            },
            {
              "id": "58115bff-589a-4287-98d8-373112102617",
              "name": "Wool",
              "description": "Material Wool"
            }
          ]
        },
        {
          "id": "f192e114-9f8a-4284-99d0-4d9ccd8a0275",
          "name": "Shirt Color",
          "options": [
            {
              "id": "0b261f7d-753d-4af6-b9f4-62b436cca37d",
              "name": "Red",
              "description": "Color Red"
            },
            {
              "id": "55d6d785-cc52-453a-bff6-2cf9add8a580",
              "name": "Green",
              "description": "Color Green"
            },
            {
              "id": "a43d8b6f-b411-49aa-adaa-36a1a025051e",
              "name": "Blue",
              "description": "Color Blue"
            }
          ]
        }
      ]
    }
  }
}

update-product-custom-inputs

Update using custom_inputs

{
  "data": {
    "type": "product",
    "id": "9214719b-17fe-4ea7-896c-d61e60fc0d05",
    "attributes": {
      "commodity_type": "physical",
      "custom_inputs": {
        "back": {
          "name": "T-Shirt Back",
          "validation_rules": [
            {
              "type": "string",
              "options": {
                "max_length": 50
              }
            }
          ],
          "required": false
        },
        "front": {
          "name": "T-Shirt Front",
          "validation_rules": [
            {
              "type": "string",
              "options": {
                "max_length": 50
              }
            }
          ],
          "required": false
        }
      },
      "description": "T-shirt.",
      "locales": {
        "fr-FR": {
          "name": "T-Shirt",
          "description": "T-Shirt."
        }
      },
      "mpn": "1234-5678-SSSS",
      "name": "Shirt",
      "sku": "978055216732567",
      "slug": "978055216732567",
      "status": "live"
    },
    "relationships": {
      "children": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/children"
        }
      },
      "component_products": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/component_products"
        }
      },
      "files": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/files"
        }
      },
      "main_image": {
        "data": null
      },
      "templates": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/templates"
        }
      },
      "variations": {
        "data": [],
        "links": {
          "self": "/products/9214719b-17fe-4ea7-896c-d61e60fc0d05/relationships/variations"
        }
      }
    },
    "meta": {
      "created_at": "2022-08-18T12:14:52.782Z",
      "updated_at": "2022-08-19T12:28:26.343Z",
      "variation_matrix": {},
      "variations": [
        {
          "id": "6c4b5caa-3819-4366-a14e-c5b85009544b",
          "name": "Shirt Size",
          "options": [
            {
              "id": "cbde9096-e0e1-43d8-a1aa-cb66cf1d299f",
              "name": "Small",
              "description": "Size Small"
            },
            {
              "id": "da9d88d0-8ea6-434c-a0dd-059caf595687",
              "name": "Medium",
              "description": "Size Medium"
            },
            {
              "id": "07493fea-74b0-40a2-972a-cd7e1d6561bd",
              "name": "Large",
              "description": "Size Large"
            }
          ]
        },
        {
          "id": "b1ae545e-3375-455f-b5ea-09669b60996f",
          "name": "Shirt Material",
          "options": [
            {
              "id": "994c2029-519c-43d9-9c54-14f3af4e3efd",
              "name": "Cotton",
              "description": "Material Cotton"
            },
            {
              "id": "7951f3d9-f628-49f8-8a43-7749d28153d6",
              "name": "Denim",
              "description": "Material Denim"
            },
            {
              "id": "58115bff-589a-4287-98d8-373112102617",
              "name": "Wool",
              "description": "Material Wool"
            }
          ]
        },
        {
          "id": "f192e114-9f8a-4284-99d0-4d9ccd8a0275",
          "name": "Shirt Color",
          "options": [
            {
              "id": "0b261f7d-753d-4af6-b9f4-62b436cca37d",
              "name": "Red",
              "description": "Color Red"
            },
            {
              "id": "55d6d785-cc52-453a-bff6-2cf9add8a580",
              "name": "Green",
              "description": "Color Green"
            },
            {
              "id": "a43d8b6f-b411-49aa-adaa-36a1a025051e",
              "name": "Blue",
              "description": "Color Blue"
            }
          ]
        }
      ]
    }
  }
}

update-product-bundle

Update a bundle

{
  "data": {
    "type": "product",
    "id": "8a0072c0-cedf-4e53-bdc4-a14a5d6389d5",
    "attributes": {
      "commodity_type": "digital",
      "components": {
        "List 1": {
          "name": "PS5",
          "options": [
            {
              "id": "c7cf43f3-24c6-4523-8a24-3663b49b81aa",
              "type": "product",
              "quantity": 1,
              "default": true
            }
          ],
          "sort_order": 1
        },
        "List 2": {
          "name": "Controller",
          "options": [
            {
              "id": "e59ca559-37c7-4dc9-8a91-df94cd5700d3",
              "type": "product",
              "quantity": 1,
              "default": true
            }
          ],
          "sort_order": 2
        },
        "List 3": {
          "name": "PS+",
          "options": [
            {
              "id": "8ae2a7ea-f767-4af0-8486-ae203947ecc4",
              "type": "product",
              "quantity": 1,
              "default": true
            }
          ],
          "sort_order": 3
        },
        "List 4": {
          "options": [
            {
              "id": "549a291f-669c-47d0-bc04-60a3f18fc55c",
              "type": "product",
              "quantity": 1,
              "default": true
            },
            {
              "id": "071e461c-22a2-42e0-9604-c345bbc9b85c",
              "type": "product",
              "quantity": 1,
              "default": false
            },
            {
              "id": "633b8172-8aa9-4dbd-aa07-0dcefca3de74",
              "type": "product",
              "quantity": 1,
              "default": false
            },
            {
              "id": "549a291f-669c-47d0-bc04-60a3f18fc55c",
              "type": "product",
              "quantity": 1,
              "default": false
            }
          ],
          "min": 1,
          "max": 1,
          "sort_order": 4
        },
        "headsets": {
          "name": "Headsets",
          "options": [
            {
              "id": "8ae2a7ea-f767-4af0-8486-ae203947ecc4",
              "type": "product",
              "quantity": 5,
              "default": true
            }
          ]
        }
      },
      "description": "Favourite DOOM games in one bundle - Select one from four choices",
      "mpn": "1234-5678-ABCD00",
      "name": "Favourite games bundle",
      "sku": "fav23455",
      "slug": "PGH69345-B",
      "status": "live",
      "upc_ean": "123456"
    },
    "relationships": {
      "children": {
        "data": [],
        "links": {
          "self": "/products/8a0072c0-cedf-4e53-bdc4-a14a5d6389d5/children"
        }
      },
      "component_products": {
        "data": [],
        "links": {
          "self": "/products/8a0072c0-cedf-4e53-bdc4-a14a5d6389d5/relationships/component_products"
        }
      },
      "files": {
        "data": [],
        "links": {
          "self": "/products/8a0072c0-cedf-4e53-bdc4-a14a5d6389d5/relationships/files"
        }
      },
      "main_image": {
        "data": null
      },
      "templates": {
        "data": [],
        "links": {
          "self": "/products/8a0072c0-cedf-4e53-bdc4-a14a5d6389d5/relationships/templates"
        }
      },
      "variations": {
        "data": [],
        "links": {
          "self": "/products/8a0072c0-cedf-4e53-bdc4-a14a5d6389d5/relationships/variations"
        }
      }
    },
    "meta": {
      "created_at": "2022-02-03T19:38:00.602Z",
      "owner": "store",
      "updated_at": "2022-02-03T19:43:21.487Z",
      "variation_matrix": {}
    }
  }
}

update-product-bundle-quantity-config

Update Bundle with Quantity Configuration

{
  "data": {
    "type": "product",
    "id": "143e9ded-b549-4631-831c-d27f5fb2fe2e",
    "attributes": {
      "name": "Coffee Bundle",
      "description": "A customizable coffee bundle with optional syrups and coffee options",
      "sku": "COFFEE-BUNDLE-001",
      "commodity_type": "physical",
      "status": "live",
      "components": {
        "syrup": {
          "name": "Syrup Selection",
          "min": 0,
          "max": 2,
          "options": [
            {
              "id": "vanilla-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3,
              "default": true
            },
            {
              "id": "salted-caramel-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3
            },
            {
              "id": "hazelnut-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3
            },
            {
              "id": "caramel-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3
            },
            {
              "id": "toffee-nut-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3
            },
            {
              "id": "pumpkin-spice-id",
              "type": "product",
              "quantity": 1,
              "min": 1,
              "max": 3
            }
          ]
        },
        "coffee": {
          "name": "Coffee Selection",
          "min": 1,
          "max": 1,
          "options": [
            {
              "id": "cappuccino-id",
              "type": "product",
              "quantity": 1,
              "default": true
            },
            {
              "id": "espresso-id",
              "type": "product",
              "quantity": 1
            },
            {
              "id": "latte-id",
              "type": "product",
              "quantity": 1
            }
          ]
        }
      }
    },
    "relationships": {
      "children": {
        "data": [],
        "links": {
          "self": "/products/143e9ded-b549-4631-831c-d27f5fb2fe2e/children"
        }
      },
      "component_products": {
        "data": [],
        "links": {
          "self": "/products/143e9ded-b549-4631-831c-d27f5fb2fe2e/relationships/component_products"
        }
      },
      "files": {
        "data": [],
        "links": {
          "self": "/products/143e9ded-b549-4631-831c-d27f5fb2fe2e/relationships/files"
        }
      },
      "main_image": {
        "data": null
      },
      "templates": {
        "data": [],
        "links": {
          "self": "/products/143e9ded-b549-4631-831c-d27f5fb2fe2e/templates"
        }
      },
      "variations": {
        "data": [],
        "links": {
          "self": "/products/143e9ded-b549-4631-831c-d27f5fb2fe2e/relationships/variations"
        }
      }
    },
    "meta": {
      "created_at": "2024-04-14T10:34:00.000Z",
      "owner": "organization",
      "product_types": [
        "bundle"
      ],
      "updated_at": "2024-04-14T10:34:00.000Z",
      "variation_matrix": {}
    }
  },
  "included": {
    "main_images": [],
    "files": []
  }
}

403

Forbidden

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Forbidden",
      "status": "403",
      "detail": "entity owned by organization"
    }
  ]
}

404

Bad Request. Not Found.

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404"
    }
  ]
}

409

Write conflict detected

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Conflict",
      "status": "409",
      "detail": "write conflict detected"
    }
  ]
}

422

Bad request. The request failed validation.

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

failed-validation

{
  "errors": [
    {
      "title": "Failed Validation",
      "status": "422",
      "detail": "<XYZ> can not be empty"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors undefined[]required
Array [
statusstringrequired
The HTTP response code of the error.
Example: 500
titlestringrequired
A brief summary of the error.
Example: Internal server error
detailstring
Optional additional detail about the error.
Example: An internal error has occurred.
request_idstring
Internal request ID.
Example: 00000000-0000-0000-0000-000000000000
metaobject
Additional supporting meta data for the error.
Example: {"missing_ids":["e7d50bd5-1833-43c0-9848-f9d325b08be8"]}
]

Example (auto)

{
  "errors": [
    {
      "status": "500",
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "status": "500",
      "title": "Internal Server Error",
      "detail": "There was an internal server error, you can report with your request id.",
      "request_id": "635da56d-75a1-43cd-b696-7ab119756b3a"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

productID — pathrequired

Body

• Example (from schema)
• update-product
• update-product-build-rules
• update-product-custom-inputs
• update-product-bundle
• update-product-bundle-quantity-config

{
  "data": {
    "type": "product",
    "id": "00000000-0000-0000-0000-000000000000",
    "attributes": {
      "external_ref": "string",
      "name": "string",
      "description": "string",
      "slug": "string",
      "sku": "string",
      "status": "live",
      "commodity_type": "physical",
      "upc_ean": "string",
      "mpn": "string",
      "tags": [
        "string"
      ],
      "build_rules": {
        "default": "include",
        "include": [
          "string"
        ],
        "exclude": [
          "string"
        ]
      },
      "locales": {},
      "custom_inputs": {},
      "components": {}
    }
  }
}

ResponseClear

Click the Send API Request button above and see the response here!