Reference - Product and Catalog Management REST API 1.2.0 (Beta)

Document View

This API specification is available for download as an Open API 3.0 YAML file:

icm-pim-management-1x2x0.yaml

References

The following page lists available REST APIs for ICM 11 and their version dependencies:

Reference - Intershop Commerce Management 11 REST API

API Specification

Introduction

OpenAPI Version: 3.0.1

Product and Catalog Management Version: 1.2.0-beta

The Product and Catalog Management REST API contains resources that allow to execute all major actions required for managing products and catalogs in Intershop Commerce Management.

The Product and Catalog Management REST API is subject to changes and potential breaking updates in future releases.

For more information on product information management, refer to Overview - Product Information Management.
Please contact our Intershop experts at Support - Intershop Communications if you have any questions about this API.

API Versioning & Accept Header

Media type based versioning is used to distinguish between different API versions. For requests to the PIM Management REST API 1.x, the REST client must set the following HTTP Accept header:

Accept: application/vnd.intershop.admin.pim.v1+json

Changelog

Version 1.2.0

Added this changelog
Added REST endpoints to handle catalog categories
Added REST endpoints to GET and PUT product links of a product for a product link type.
Version 1.1.0
Added REST endpoints to handle explicitly assigned product for categories
Added new attribute images to ProductAspectContentRO_v1
Version 1.0.0
Initial version of the Product and Catalog Management REST API

Catalog API

/catalogs

GET: [BETA] Returns the list of catalogs

Description

This operation returns a list of all top-level categories (catalogs). The sorting is as defined in Intershop Commerce Management (manual or dynamic sorting).

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogListResource.getCatalogList(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in query	offset	integer `int32`	`0`	`2`	An offset for a specific set of results. Allows to offset the result list by the specified number of items. Can be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of catalogs is returned.

CatalogListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog with the given ID could not be found.

/catalogs/{catalogId}

GET: [BETA] Returns the catalog with the given ID

Description

This operation returns the catalog with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.getCatalog()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required

Response

200 - OK - The catalog with the given ID is returned.

CatalogRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog with the given ID could not be found.

PUT: [BETA] Creates the catalog with the given ID

Description

This operation creates the catalog with the given ID and all the provided information. Missing information can be added later via PATCH.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.createCatalog(java.lang.String)

Request Body

CatalogDataRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required

Response

201 - Created OK - The catalog was successfully created.

CatalogRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

409 - Conflict - A catalog with the given ID already exists.

422 - Unprocessable Entity Unprocessable - The catalog is not correctly specified.

PATCH: [BETA] Partially updates the catalog with the given ID

Description

This operation updates the catalog with the all the provided information.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.updateCatalog(java.lang.String)

Request Body

CatalogPatchRO application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required

Response

200 - OK - The catalog was successfully updated.

CatalogRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog with the given ID could not be found.

422 - Unprocessable Entity Unprocessable - The catalog is not correctly specified.

/catalogs/{catalogId}/categories

GET: [BETA] Returns the list of catalog categories

Description

This operation returns a list of catalog categories (sub categories, level 1).

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryListResource.getCategoryList(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required
in query	offset	integer `int32`	`0`	`2`	An offset for a specific result set. Allows to offset the result list by the specified number of items. May be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of catalog categories is returned.

CategoryListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

/catalogs/{catalogId}/categories/{categoryId}

GET: [BETA] Returns the catalog category with the given ID

Description

This operation returns the catalog category with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryItemResource.getCategory()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required

Response

200 - OK - The catalog category with the given ID is returned.

CategoryRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or a parent catalog category with the given ID could not be found.

PUT: [BETA] Creates or Replaces the category with the given ID.

Description

This operation creates or replaces the category with the given ID and all the provided information.

Missing information can be added later via PATCH.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryItemResource.createCategory(java.lang.String)

Request Body

CategoryDataRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required

Response

200 - OK - The category was successfully created.

CategoryRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing or incorrect.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or a parent catalog category with the given ID could not be found.

409 - Conflict

422 - Unprocessable Entity Unprocessable - The category is not correctly specified.

DELETE: [BETA] Deletes the category with the given ID.

Description

This operation deletes the category with the given ID along with all its nested sub categories. All products, category links and product links which are mapped to and from this category and its sub-categories will also be unassigned.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryItemResource.deleteCategory()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required

Response

200 - OK - Information message describing success status.

CategoryRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A category with the given ID could not be found.

PATCH: [BETA] Partially updates the category with the given ID.

Description

This operation updates the category with the all the provided information.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryItemResource.updateCategory(java.lang.String)

Request Body

CategoryPatchRO application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required

Response

200 - OK - The category was successfully updated.

CategoryRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The json body is missing or incorrect.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A category with the given ID could not be found.

422 - Unprocessable Entity Unprocessable - The category is not correctly specified.

/catalogs/{catalogId}/categories/{categoryId}/explicitlyAssignedProducts

GET: [BETA] Returns the list of explicitly assigned products of a catalog category

Description

This operation returns the list of explicitly assigned products of a catalog category. The sorting is as defined in Intershop Commerce Management (manual or automatic sorting).

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.getExplicitlyAssignedProductList(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required
in query	offset	integer `int32`	`0`	`2`	An offset for a specific result set. Allows to offset the result list by the specified number of items. May be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of explicitly assigned products is returned.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

PUT: [BETA] Sets the list of explicitly assigned products of a catalog category

Description

This operation sets the list of explicitly assigned products of a catalog category. The sorting is as defined in Intershop Commerce Management (manual or automatic sorting). New product assignments in this category will always use automatic sorting.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.setExplicitlyAssignedProductList(java.util.List,java.lang.Integer,java.lang.Integer)

Request Body

Array of ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required
in query	offset	integer `int32`	`0`	`2`	An offset for a specific result set. Allows to offset the result list by the specified number of items. May be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of explicitly assigned products is returned.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

422 - Unprocessable Entity Unprocessable - The product reference list is not correctly specified.

/catalogs/{catalogId}/categories/{categoryId}/explicitlyAssignedProducts/appendAll

POST: [BETA] Appends the list of explicitly assigned products of a catalog category

Description

This operation appends the list of explicitly assigned products of a catalog category. New product assignments in this category will always use automatic sorting.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListAppendAllResource.appendExplicitlyAssignedProducts(java.util.List)

Request Body

Array of ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	categoryId	string			Required
in path	catalogId	string			Required

Response

200 - OK - The list of explicitly assigned products is appended.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

207 - Multi-Status Multi Status - The list of explicitly assigned products is appended, some items could not be processed.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

/catalogs/{catalogId}/categories/{categoryId}/explicitlyAssignedProducts/{productId}

DELETE: [BETA] Deletes an explicit product assignment

Description

This operation deletes an explicit product assignemnt with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductItemResource.deleteExplicitlyProductAssignment()

Request Body

Request Parameters

Location	Name	Format	Description
in path	productId	string	Required
in path	categoryId	string	Required
in path	catalogId	string	Required

Response

200 - OK - The product assignment has been deleted.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category, parent catalog category, the product or the product assignment with the given ID could not be found.

/catalogs/{catalogId}/explicitlyAssignedProducts

GET: [BETA] Returns the list of explicitly assigned products of a catalog category

Description

This operation returns the list of explicitly assigned products of a catalog category. The sorting is as defined in Intershop Commerce Management (manual or automatic sorting).

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.getExplicitlyAssignedProductList(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required
in query	offset	integer `int32`	`0`	`2`	An offset for a specific result set. Allows to offset the result list by the specified number of items. May be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of explicitly assigned products is returned.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

PUT: [BETA] Sets the list of explicitly assigned products of a catalog category

Description

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.setExplicitlyAssignedProductList(java.util.List,java.lang.Integer,java.lang.Integer)

Request Body

Array of ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required
in query	offset	integer `int32`	`0`	`2`	An offset for a specific result set. Allows to offset the result list by the specified number of items. May be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	Number of items to be returned. The default maximum number of items is 200. Requesting more items is not possible.

Response

200 - OK - The list of explicitly assigned products is returned.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

422 - Unprocessable Entity Unprocessable - The product reference list is not correctly specified.

/catalogs/{catalogId}/explicitlyAssignedProducts/appendAll

POST: [BETA] Appends the list of explicitly assigned products of a catalog category

Description

This operation appends the list of explicitly assigned products of a catalog category. New product assignments in this category will always use automatic sorting.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListAppendAllResource.appendExplicitlyAssignedProducts(java.util.List)

Request Body

Array of ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	catalogId	string			Required

Response

200 - OK - The list of explicitly assigned products is appended.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

207 - Multi-Status Multi Status - The list of explicitly assigned products is appended, some items could not be processed.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category or parent catalog category with the given ID could not be found.

/catalogs/{catalogId}/explicitlyAssignedProducts/{productId}

DELETE: [BETA] Deletes an explicit product assignment

Description

This operation deletes an explicit product assignemnt with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductItemResource.deleteExplicitlyProductAssignment()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productId	string			Required
in path	catalogId	string			Required

Response

200 - OK - The product assignment has been deleted.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A catalog category, parent catalog category, the product or the product assignment with the given ID could not be found.

Product API

/products

GET: [BETA] Returns the list of products

Description

This operation returns a list of products for the given parameters.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductListResource.getProductList(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in query	offset	integer `int32`	`0`	`2`	An offset for a specific set of results. Allows to offset the result list by the specified number of items. Can be combined with `limit`.
in query	limit	integer `int32`	`20`	`2`	my Description

Response

200 - OK - The list of products is returned.

ProductListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

/products/{productId}

GET: [BETA] Returns the product with the given ID.

Description

This operation returns the product with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.getProduct()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productId	string			Required

Response

200 - OK - The product with the given ID is returned.

ProductRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A product with the given ID could not be found.

PUT: [BETA] Creates the product with the given ID.

Description

This operation creates the product with the given ID and all the provided information.

Missing information can be added later via PATCH.
Be aware that not all combinations of product types work. See the table below for valid combinations:

is a ... / can also be (another) ...	Variation Master	Retail Set (Master)	Variation Product (Variant)	Part of Retail Set
Variation Master	no	no	no	no
Retail Set (Master)	no	no	yes	no
Variation Product (Variant)	no	yes	no	yes
Part of Retail Set	no	no	yes	yes

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.createProduct(java.lang.String)

Request Body

ProductDataRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productId	string			Required

Response

200 - OK

ProductRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

409 - Conflict - A product with the given ID already exists.

422 - Unprocessable Entity Unprocessable - The product is not correctly specified.

DELETE: [BETA] Deletes the product with the given ID.

Description

This operation deletes the product with the given ID.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.deleteProduct()

Request Body

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productId	string			Required

Response

200 - OK - The product has been deleted.

ProductRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A product with the given ID could not be found.

PATCH: [BETA] Partially updates the product with the given ID.

Description

This operation updates the product with the all the provided information.

Be aware that not all combinations of product types work. See the table below for valid combinations:

is a ... / can also be (another) ...	Variation Master	Retail Set (Master)	Variation Product (Variant)	Part of Retail Set
Variation Master	no	no	no	no
Retail Set (Master)	no	no	yes	no
Variation Product (Variant)	no	yes	no	yes
Part of Retail Set	no	no	yes	yes

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.updateProduct(java.lang.String)

Request Body

ProductPatchRO application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productId	string			Required

Response

200 - OK - The product was successfully updated.

ProductRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

400 - Bad Request - The JSON body is missing.

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A product with the given ID could not be found.

422 - Unprocessable Entity Unprocessable - The product is not correctly specified.

/products/{productId}/linkedProducts/{productLinkType}

GET: [BETA]

Description

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductLinkTypeListResource.getProductLinkedProductListByProductLinkType(java.lang.Integer,java.lang.Integer)

Request Body

Request Parameters

Location	Name	Format	Default	Description
in path	productLinkType	string		Required
in path	productId	string		Required
in query	offset	integer `int32`	`0`
in query	limit	integer `int32`	`20`

Response

200 - OK

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized

403 - Forbidden

404 - Not Found

PUT: [BETA]

Description

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductLinkTypeListResource.createProductLinksByType(java.util.List)

Request Body

Array of ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

Request Parameters

Location	Name	Format	Default	Example	Description
in path	productLinkType	string			Required
in path	productId	string			Required

Response

200 - OK

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized

403 - Forbidden

404 - Not Found

/products/{productId}/linkedProducts/{productLinkType}/{targetProductId}

DELETE: [BETA] Deletes the product link between two products

Description

This operation deletes a product link for a product link type.

Java Method

public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductLinkTypeItemResource.deleteProductLink()

Request Body

Request Parameters

Location	Name	Format	Description
in path	targetProductId	string	Required
in path	productLinkType	string	Required
in path	productId	string	Required

Response

200 - OK - The product links were created or recreated.

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

401 - Unauthorized - The user could not be authenticated.

403 - Forbidden - The user is not allowed to access this resource.

404 - Not Found - A product or product link type could not be found.

Request and Response Object Schemata

CatalogDataRO_v1 application/vnd.intershop.admin.pim.v1+json

{

"attributes":
array
An array of Attribute_v1 objects. The (custom) attributes of an object.
[
Either IntegerAttribute_v1
{}
Or DoubleAttribute_v1
{}
Or StringAttribute_v1
{}
Or IntegerListAttribute_v1
{}
Or DoubleListAttribute_v1
{}
Or StringListAttribute_v1
{}
Or LongAttribute_v1
{}
Or BooleanAttribute_v1
{}
Or DateAttribute_v1
{}
Or DecimalAttribute_v1
{}
Or MoneyAttribute_v1
{}
Or QuantityAttribute_v1
{}
Or LongListAttribute_v1
{}
Or BooleanListAttribute_v1
{}
Or DateListAttribute_v1
{}
Or DecimalListAttribute_v1
{}
Or LocalizedIntegerAttribute_v1
{}
Or LocalizedDoubleAttribute_v1
{}
Or LocalizedStringAttribute_v1
{}
Or LocalizedIntegerListAttribute_v1
{}
Or LocalizedDoubleListAttribute_v1
{}
Or LocalizedStringListAttribute_v1
{}
Or LocalizedLongAttribute_v1
{}
Or LocalizedBooleanAttribute_v1
{}
Or LocalizedDateAttribute_v1
{}
Or LocalizedDecimalAttribute_v1
{}
Or LocalizedMoneyAttribute_v1
{}
Or LocalizedQuantityAttribute_v1
{}
Or LocalizedLongListAttribute_v1
{}
Or LocalizedBooleanListAttribute_v1
{}
Or LocalizedDateListAttribute_v1
{}
Or LocalizedDecimalListAttribute_v1
{}
]
"content":
object
A CatalogAspectContentRO_v1 object. The content information about the catalog
{
- "image":
  object
  A BasicImageRefRO_v1 object. The category image
  {
  - "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  }
- "longDescription":
  array
  An array of LocalizedValueString objects.
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "name":
  array
  An array of LocalizedValueString objects. The localized name of the catalog
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "shortDescription":
  array
  An array of LocalizedValueString objects. The localized short description of the catalog
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
}
"visibility":
object
A CatalogAspectVisibilityRO_v1 object. Visibility information about the catalog
{
- "onlineStatusDefinition":
  string
  The online status definition of the catalog | Example: ONLINE | Possible Values: ONLINEOFFLINE
- "showInMenu":
  boolean
  Determines whether the catalog is displayed in the menu | Example: true
}

}

CatalogListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"data":
array
An array of CatalogRESTResponse_v1 objects. The data of the response object
[
CatalogRESTResponse_v1: The core data of the response object.
{
- "id":
  string
  The identifier of the response object | Example: catalogID
- "data":
  object
  A CatalogDataRO_v1 object. The core data of the response object.
  {
  "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
  "content":
  object
  A CatalogAspectContentRO_v1 object. The content information about the catalog
  {
  "image":
  object
  A BasicImageRefRO_v1 object. The category image
  {
  "imagePath":
  string
  The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  }
  "longDescription":
  array
  An array of LocalizedValueString objects.
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  array
  An array of LocalizedValueString objects. The localized name of the catalog
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "shortDescription":
  array
  An array of LocalizedValueString objects. The localized short description of the catalog
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  }
  "visibility":
  object
  A CatalogAspectVisibilityRO_v1 object. Visibility information about the catalog
  {
  "onlineStatusDefinition":
  string
  The online status definition of the catalog | Example: ONLINE | Possible Values: ONLINEOFFLINE
  "showInMenu":
  boolean
  Determines whether the catalog is displayed in the menu | Example: true
  }
  }
- "info":
  object
  A CatalogInfoRO_v1 object. The optional info of the response object
  {
  "shared":
  boolean
  Readonly | Determines whether the catalog is shared | Example: true
  "type":
  string
  Readonly | The type of the catalog | Example: STANDARD | Possible Values: STANDARDCLASSIFICATION
  }
- "messages":
  array
  Readonly | An array of FeedbackRO_v1 objects. A list of messages related to the request, such as value adjustments
  [
  FeedbackRO_v1: An error or piece of information related to the current request
  {
  "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
  "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
  }
  ]
}
]
"info":
object
A ListInfoRO_v1 object. The optional information about the response object. All values are also optional.
{
- "hasMoreElements":
  boolean
  Readonly | Flag that expresses if there more entries available. | Example: true
- "limit":
  integer
  Readonly | The limit of list entries to be shown. | Format: int32 | Example: 20
- "offset":
  integer
  Readonly | Excludes the first N items from the list. | Format: int32 | Example: 10
- "total":
  integer
  Readonly | The total amount of entries in the list. | Format: int32 | Example: 30
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects.
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

CatalogPatchRO application/vnd.intershop.admin.pim.v1+json

{

"data":
object
A CatalogDataRO_v1 object. The core data of the response object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A CatalogAspectContentRO_v1 object. The content information about the catalog
  {
  - "image":
    object
    A BasicImageRefRO_v1 object. The category image
    {
    "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    }
  - "longDescription":
    array
    An array of LocalizedValueString objects.
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. The localized name of the catalog
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "shortDescription":
    array
    An array of LocalizedValueString objects. The localized short description of the catalog
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "visibility":
  object
  A CatalogAspectVisibilityRO_v1 object. Visibility information about the catalog
  {
  - "onlineStatusDefinition":
    string
    The online status definition of the catalog | Example: ONLINE | Possible Values: ONLINEOFFLINE
  - "showInMenu":
    boolean
    Determines whether the catalog is displayed in the menu | Example: true
  }
}
"keys":
array
An array of string literals.
"declaredKeys":
array
An array of string literals.
"empty":
boolean

}

CatalogRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"id":
string
The identifier of the response object | Example: catalogID
"data":
object
A CatalogDataRO_v1 object. The core data of the response object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A CatalogAspectContentRO_v1 object. The content information about the catalog
  {
  - "image":
    object
    A BasicImageRefRO_v1 object. The category image
    {
    "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    }
  - "longDescription":
    array
    An array of LocalizedValueString objects.
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. The localized name of the catalog
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "shortDescription":
    array
    An array of LocalizedValueString objects. The localized short description of the catalog
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "visibility":
  object
  A CatalogAspectVisibilityRO_v1 object. Visibility information about the catalog
  {
  - "onlineStatusDefinition":
    string
    The online status definition of the catalog | Example: ONLINE | Possible Values: ONLINEOFFLINE
  - "showInMenu":
    boolean
    Determines whether the catalog is displayed in the menu | Example: true
  }
}
"info":
object
A CatalogInfoRO_v1 object. The optional info of the response object
{
- "shared":
  boolean
  Readonly | Determines whether the catalog is shared | Example: true
- "type":
  string
  Readonly | The type of the catalog | Example: STANDARD | Possible Values: STANDARDCLASSIFICATION
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects. A list of messages related to the request, such as value adjustments
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

CategoryDataRO_v1 application/vnd.intershop.admin.pim.v1+json

{

"attributes":
array
An array of Attribute_v1 objects. The (custom) attributes of an object.
[
Either IntegerAttribute_v1
{}
Or DoubleAttribute_v1
{}
Or StringAttribute_v1
{}
Or IntegerListAttribute_v1
{}
Or DoubleListAttribute_v1
{}
Or StringListAttribute_v1
{}
Or LongAttribute_v1
{}
Or BooleanAttribute_v1
{}
Or DateAttribute_v1
{}
Or DecimalAttribute_v1
{}
Or MoneyAttribute_v1
{}
Or QuantityAttribute_v1
{}
Or LongListAttribute_v1
{}
Or BooleanListAttribute_v1
{}
Or DateListAttribute_v1
{}
Or DecimalListAttribute_v1
{}
Or LocalizedIntegerAttribute_v1
{}
Or LocalizedDoubleAttribute_v1
{}
Or LocalizedStringAttribute_v1
{}
Or LocalizedIntegerListAttribute_v1
{}
Or LocalizedDoubleListAttribute_v1
{}
Or LocalizedStringListAttribute_v1
{}
Or LocalizedLongAttribute_v1
{}
Or LocalizedBooleanAttribute_v1
{}
Or LocalizedDateAttribute_v1
{}
Or LocalizedDecimalAttribute_v1
{}
Or LocalizedMoneyAttribute_v1
{}
Or LocalizedQuantityAttribute_v1
{}
Or LocalizedLongListAttribute_v1
{}
Or LocalizedBooleanListAttribute_v1
{}
Or LocalizedDateListAttribute_v1
{}
Or LocalizedDecimalListAttribute_v1
{}
]
"content":
object
A CategoryAspectContentRO_v1 object. The content information about the catalog category
{
- "image":
  object
  A BasicImageRefRO_v1 object. The category image
  {
  - "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  }
- "longDescription":
  array
  An array of LocalizedValueString objects.
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "name":
  array
  An array of LocalizedValueString objects. The localized name of the catalog category
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "shortDescription":
  array
  An array of LocalizedValueString objects. The localized description of the catalog category
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
}
"visibility":
object
A CategoryAspectVisibilityRO_v1 object. Visibility information about the category
{
- "onlineStatusDefinition":
  string
  The online status definition of the category | Example: ONLINE | Possible Values: ONLINEOFFLINE
}

}

CategoryListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"data":
array
An array of CategoryRESTResponse_v1 objects. The core data of the response object
[
CategoryRESTResponse_v1
{
- "id":
  string
  The identifier of the response object | Example: categoryID
- "data":
  object
  A CategoryDataRO_v1 object.
  {
  "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
  "content":
  object
  A CategoryAspectContentRO_v1 object. The content information about the catalog category
  {
  "image":
  object
  A BasicImageRefRO_v1 object. The category image
  {
  "imagePath":
  string
  The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  }
  "longDescription":
  array
  An array of LocalizedValueString objects.
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  array
  An array of LocalizedValueString objects. The localized name of the catalog category
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "shortDescription":
  array
  An array of LocalizedValueString objects. The localized description of the catalog category
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  }
  "visibility":
  object
  A CategoryAspectVisibilityRO_v1 object. Visibility information about the category
  {
  "onlineStatusDefinition":
  string
  The online status definition of the category | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
  }
- "info":
  object
  A CategoryInfoRO_v1 object. Optional information of the response object
  {}
- "messages":
  array
  Readonly | An array of FeedbackRO_v1 objects. List of messages regarding the request (e.g. value adjustments)
  [
  FeedbackRO_v1: An error or piece of information related to the current request
  {
  "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
  "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
  }
  ]
}
]
"info":
object
A ListInfoRO_v1 object. The optional information about the response object. All values are also optional.
{
- "hasMoreElements":
  boolean
  Readonly | Flag that expresses if there more entries available. | Example: true
- "limit":
  integer
  Readonly | The limit of list entries to be shown. | Format: int32 | Example: 20
- "offset":
  integer
  Readonly | Excludes the first N items from the list. | Format: int32 | Example: 10
- "total":
  integer
  Readonly | The total amount of entries in the list. | Format: int32 | Example: 30
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects.
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

CategoryPatchRO application/vnd.intershop.admin.pim.v1+json

{

"data":
object
A CategoryDataRO_v1 object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A CategoryAspectContentRO_v1 object. The content information about the catalog category
  {
  - "image":
    object
    A BasicImageRefRO_v1 object. The category image
    {
    "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    }
  - "longDescription":
    array
    An array of LocalizedValueString objects.
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. The localized name of the catalog category
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "shortDescription":
    array
    An array of LocalizedValueString objects. The localized description of the catalog category
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "visibility":
  object
  A CategoryAspectVisibilityRO_v1 object. Visibility information about the category
  {
  - "onlineStatusDefinition":
    string
    The online status definition of the category | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
}
"keys":
array
An array of string literals.
"declaredKeys":
array
An array of string literals.
"empty":
boolean

}

CategoryRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"id":
string
The identifier of the response object | Example: categoryID
"data":
object
A CategoryDataRO_v1 object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A CategoryAspectContentRO_v1 object. The content information about the catalog category
  {
  - "image":
    object
    A BasicImageRefRO_v1 object. The category image
    {
    "imagePath":
    string
    The image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    }
  - "longDescription":
    array
    An array of LocalizedValueString objects.
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. The localized name of the catalog category
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "shortDescription":
    array
    An array of LocalizedValueString objects. The localized description of the catalog category
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "visibility":
  object
  A CategoryAspectVisibilityRO_v1 object. Visibility information about the category
  {
  - "onlineStatusDefinition":
    string
    The online status definition of the category | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
}
"info":
object
A CategoryInfoRO_v1 object. Optional information of the response object
{}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects. List of messages regarding the request (e.g. value adjustments)
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

ProductDataRO_v1 application/vnd.intershop.admin.pim.v1+json

{

"attributes":
array
An array of Attribute_v1 objects. The (custom) attributes of an object.
[
Either IntegerAttribute_v1
{}
Or DoubleAttribute_v1
{}
Or StringAttribute_v1
{}
Or IntegerListAttribute_v1
{}
Or DoubleListAttribute_v1
{}
Or StringListAttribute_v1
{}
Or LongAttribute_v1
{}
Or BooleanAttribute_v1
{}
Or DateAttribute_v1
{}
Or DecimalAttribute_v1
{}
Or MoneyAttribute_v1
{}
Or QuantityAttribute_v1
{}
Or LongListAttribute_v1
{}
Or BooleanListAttribute_v1
{}
Or DateListAttribute_v1
{}
Or DecimalListAttribute_v1
{}
Or LocalizedIntegerAttribute_v1
{}
Or LocalizedDoubleAttribute_v1
{}
Or LocalizedStringAttribute_v1
{}
Or LocalizedIntegerListAttribute_v1
{}
Or LocalizedDoubleListAttribute_v1
{}
Or LocalizedStringListAttribute_v1
{}
Or LocalizedLongAttribute_v1
{}
Or LocalizedBooleanAttribute_v1
{}
Or LocalizedDateAttribute_v1
{}
Or LocalizedDecimalAttribute_v1
{}
Or LocalizedMoneyAttribute_v1
{}
Or LocalizedQuantityAttribute_v1
{}
Or LocalizedLongListAttribute_v1
{}
Or LocalizedBooleanListAttribute_v1
{}
Or LocalizedDateListAttribute_v1
{}
Or LocalizedDecimalListAttribute_v1
{}
]
"content":
object
A ProductAspectContentRO_v1 object. The content of the product
{
- "attachments":
  array
  An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
  [
  ProductAttachmentRO_v1: The content of a product attachment
  {
  "locale":
  string
  The locale of the product attachment
  "type":
  string
  The type of product attachment [Information,Contract,Manual,Other]
  "name":
  string
  The product attachment name
  "description":
  string
  The product attachment description
  "includeInEMail":
  boolean
  A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
  "location":
  string
  The product attachment location
  }
  ]
- "images":
  array
  An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
  [
  ImageRO_v1: The content of an image
  {
  "imagePath":
  string
  image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  "type":
  string
  The type id of the image e.g. thumbnail, image etc.
  "view":
  string
  The view id of the image e.g. front, back, default etc.
  }
  ]
- "longDescription":
  array
  An array of LocalizedValueString objects. A list of localized long descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "name":
  array
  An array of LocalizedValueString objects. A list of localized product names
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
- "primaryImageView":
  string
  The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
- "shortDescription":
  array
  An array of LocalizedValueString objects. A list of localized short descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
}
"fulfillment":
object
A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
{
- "freightClass":
  object
  A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
  {
  - "id":
    string
    The identifier of the freight class reference | Example: FREIGHT_CLASS
  }
- "readyForShipmentMax":
  object
  The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
  {
  - "seconds":
    integer
    Format: int64
  - "zero":
    boolean
  - "nano":
    integer
    Format: int32
  - "negative":
    boolean
  - "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
  }
- "readyForShipmentMin":
  object
  The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
  {
  - "seconds":
    integer
    Format: int64
  - "zero":
    boolean
  - "nano":
    integer
    Format: int32
  - "negative":
    boolean
  - "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
  }
}
"identification":
object
A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
{
- "eanCode":
  string
  The EAN code of the product | Example: 1234567890123
}
"inventory":
object
A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
{
- "alwaysInStock":
  boolean
  Indicates that the product is always available and can be sold without explicit inventory checks, if true | Example: true
}
"lifecycle":
object
A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
{
- "onlineStatusDefinition":
  string
  The status of the product | Example: ONLINE | Possible Values: ONLINEOFFLINE
}
"manufacturer":
object
A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
{
- "name":
  string
  The name of an element
- "sku":
  string
}
"pricing":
object
A ProductAspectPricingRO_v1 object. The pricing aspect of the product
{
- "taxClass":
  object
  A ProductTaxClassRefRO_v1 object. The reference to a tax class of a product
  {
  - "id":
    string
    The identifier of the tax class reference | Example: FULL_TAX_CLASS
  }
}
"quoting":
object
A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
{
- "quoteRequired":
  boolean
  Defines if the product requires quotation | Example: true
}
"retailSet":
object
A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
{
- "products":
  array
  An array of ProductRetailSetItemRO_v1 objects. The retail set items of the retail set
  [
  ProductRetailSetItemRO_v1
  {
  "quantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "product":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  }
  ]
}
"sales":
object
A ProductAspectSalesRO_v1 object. The sales aspect of the product.
{
- "maxOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  - "amount":
    number
    The amount of the quantity. | Example: 10
  - "unit":
    string
    The unit of the quantity. | Example: kg
  }
- "minOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  - "amount":
    number
    The amount of the quantity. | Example: 10
  - "unit":
    string
    The unit of the quantity. | Example: kg
  }
- "packingQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  - "amount":
    number
    The amount of the quantity. | Example: 10
  - "unit":
    string
    The unit of the quantity. | Example: kg
  }
- "stepQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  - "amount":
    number
    The amount of the quantity. | Example: 10
  - "unit":
    string
    The unit of the quantity. | Example: kg
  }
}
"search":
object
A ProductAspectSearchRO_v1 object. The search aspect of the product
{
- "searchIndexKeywords":
  array
  An array of LocalizedValueListString objects. The indexing keywords for search
  [
  LocalizedValueListString: A localized string list.
  {
  "locale":
  string
  The locale of the string list entry. | Example: en_US
  "value":
  array
  An array of string literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
  }
  ]
}
"supplier":
object
A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
{
- "name":
  string
  The name of an element
- "sku":
  string
}
"variationMaster":
object
A ProductAspectVariationMasterRO_v1 object.
{
- "defaultVariation":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  - "id":
    string
    The identifier of the product reference | Example: productID
  }
- "variationAttributes":
  array
  An array of ProductVariationAttributeRO_v1 objects. The variation attributes of the variation master
  [
  ProductVariationAttributeRO_v1
  {
  "displayName":
  array
  An array of LocalizedValueString objects. The localized display name of the variation attribute
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  string
  The name of the variation attribute | Example: color
  "variationSelection":
  string
  The selected variation | Example: colorCode | Possible Values: defaultcolorCodedefaultAndColorCodeswatchImagedefaultAndSwatchImage
  "productAttributeName":
  string
  The product attribute name of the product variation attribute | Example: ExampleAttributeName
  }
  ]
- "variations":
  array
  An array of ProductRefRO_v1 objects. The variations of the variation master
  [
  ProductRefRO_v1: The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  ]
}

}

ProductListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"data":
array
An array of ProductRESTResponse_v1 objects. The core data of the response object
[
ProductRESTResponse_v1: The core data of the response object.
{
- "id":
  string
  The identifier of the response object | Example: productID
- "data":
  object
  A ProductDataRO_v1 object.
  {
  "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
  "content":
  object
  A ProductAspectContentRO_v1 object. The content of the product
  {
  "attachments":
  array
  An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
  [
  ProductAttachmentRO_v1: The content of a product attachment
  {
  "locale":
  string
  The locale of the product attachment
  "type":
  string
  The type of product attachment [Information,Contract,Manual,Other]
  "name":
  string
  The product attachment name
  "description":
  string
  The product attachment description
  "includeInEMail":
  boolean
  A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
  "location":
  string
  The product attachment location
  }
  ]
  "images":
  array
  An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
  [
  ImageRO_v1: The content of an image
  {
  "imagePath":
  string
  image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  "type":
  string
  The type id of the image e.g. thumbnail, image etc.
  "view":
  string
  The view id of the image e.g. front, back, default etc.
  }
  ]
  "longDescription":
  array
  An array of LocalizedValueString objects. A list of localized long descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  array
  An array of LocalizedValueString objects. A list of localized product names
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "primaryImageView":
  string
  The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
  "shortDescription":
  array
  An array of LocalizedValueString objects. A list of localized short descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  }
  "fulfillment":
  object
  A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
  {
  "freightClass":
  object
  A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
  {
  "id":
  string
  The identifier of the freight class reference | Example: FREIGHT_CLASS
  }
  "readyForShipmentMax":
  object
  The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  "units":
  array
  An array of object literals.
  [
  {
  "durationEstimated":
  boolean
  "timeBased":
  boolean
  "dateBased":
  boolean
  }
  ]
  }
  "readyForShipmentMin":
  object
  The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  "units":
  array
  An array of object literals.
  [
  {
  "durationEstimated":
  boolean
  "timeBased":
  boolean
  "dateBased":
  boolean
  }
  ]
  }
  }
  "identification":
  object
  A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
  {
  "eanCode":
  string
  The EAN code of the product | Example: 1234567890123
  }
  "inventory":
  object
  A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
  {
  "alwaysInStock":
  boolean
  Indicates that the product is always available and can be sold without explicit inventory checks, if true | Example: true
  }
  "lifecycle":
  object
  A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
  {
  "onlineStatusDefinition":
  string
  The status of the product | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
  "manufacturer":
  object
  A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
  {
  "name":
  string
  The name of an element
  "sku":
  string
  }
  "pricing":
  object
  A ProductAspectPricingRO_v1 object. The pricing aspect of the product
  {
  "taxClass":
  object
  A ProductTaxClassRefRO_v1 object. The reference to a tax class of a product
  {
  "id":
  string
  The identifier of the tax class reference | Example: FULL_TAX_CLASS
  }
  }
  "quoting":
  object
  A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
  {
  "quoteRequired":
  boolean
  Defines if the product requires quotation | Example: true
  }
  "retailSet":
  object
  A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
  {
  "products":
  array
  An array of ProductRetailSetItemRO_v1 objects. The retail set items of the retail set
  [
  ProductRetailSetItemRO_v1
  {
  "quantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "product":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  }
  ]
  }
  "sales":
  object
  A ProductAspectSalesRO_v1 object. The sales aspect of the product.
  {
  "maxOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "minOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "packingQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "stepQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  }
  "search":
  object
  A ProductAspectSearchRO_v1 object. The search aspect of the product
  {
  "searchIndexKeywords":
  array
  An array of LocalizedValueListString objects. The indexing keywords for search
  [
  LocalizedValueListString: A localized string list.
  {
  "locale":
  string
  The locale of the string list entry. | Example: en_US
  "value":
  array
  An array of string literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
  }
  ]
  }
  "supplier":
  object
  A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
  {
  "name":
  string
  The name of an element
  "sku":
  string
  }
  "variationMaster":
  object
  A ProductAspectVariationMasterRO_v1 object.
  {
  "defaultVariation":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  "variationAttributes":
  array
  An array of ProductVariationAttributeRO_v1 objects. The variation attributes of the variation master
  [
  ProductVariationAttributeRO_v1
  {
  "displayName":
  array
  An array of LocalizedValueString objects. The localized display name of the variation attribute
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  string
  The name of the variation attribute | Example: color
  "variationSelection":
  string
  The selected variation | Example: colorCode | Possible Values: defaultcolorCodedefaultAndColorCodeswatchImagedefaultAndSwatchImage
  "productAttributeName":
  string
  The product attribute name of the product variation attribute | Example: ExampleAttributeName
  }
  ]
  "variations":
  array
  An array of ProductRefRO_v1 objects. The variations of the variation master
  [
  ProductRefRO_v1: The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  ]
  }
  }
- "info":
  object
  A ProductInfoRO_v1 object. The optional info of the response object. This section is read-only.
  {
  "images":
  array
  An array of ImageInfoRO_v1 objects. A list of images providing the effectiveURL.
  [
  ImageInfoRO_v1: The info of an image
  {
  "effectiveUrl":
  string
  }
  ]
  "lastModified":
  string
  The date the product was last modified. | Format: date-time
  "partOfRetailSets":
  array
  An array of ProductRefRO_v1 objects. The references to the retail sets the product is part of.
  [
  ProductRefRO_v1: The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  ]
  "sourceProduct":
  object
  A ProductDataRO_v1 object.
  {
  "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
  "content":
  object
  A ProductAspectContentRO_v1 object. The content of the product
  {
  "attachments":
  array
  An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
  [
  ProductAttachmentRO_v1: The content of a product attachment
  {
  "locale":
  string
  The locale of the product attachment
  "type":
  string
  The type of product attachment [Information,Contract,Manual,Other]
  "name":
  string
  The product attachment name
  "description":
  string
  The product attachment description
  "includeInEMail":
  boolean
  A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
  "location":
  string
  The product attachment location
  }
  ]
  "images":
  array
  An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
  [
  ImageRO_v1: The content of an image
  {
  "imagePath":
  string
  image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
  "type":
  string
  The type id of the image e.g. thumbnail, image etc.
  "view":
  string
  The view id of the image e.g. front, back, default etc.
  }
  ]
  "longDescription":
  array
  An array of LocalizedValueString objects. A list of localized long descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  array
  An array of LocalizedValueString objects. A list of localized product names
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "primaryImageView":
  string
  The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
  "shortDescription":
  array
  An array of LocalizedValueString objects. A list of localized short descriptions of the product
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  }
  "fulfillment":
  object
  A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
  {
  "freightClass":
  object
  A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
  {
  "id":
  string
  The identifier of the freight class reference | Example: FREIGHT_CLASS
  }
  "readyForShipmentMax":
  object
  The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  "units":
  array
  An array of object literals.
  [
  {
  "durationEstimated":
  boolean
  "timeBased":
  boolean
  "dateBased":
  boolean
  }
  ]
  }
  "readyForShipmentMin":
  object
  The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
  {
  "seconds":
  integer
  Format: int64
  "zero":
  boolean
  "nano":
  integer
  Format: int32
  "negative":
  boolean
  "units":
  array
  An array of object literals.
  [
  {
  "durationEstimated":
  boolean
  "timeBased":
  boolean
  "dateBased":
  boolean
  }
  ]
  }
  }
  "identification":
  object
  A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
  {
  "eanCode":
  string
  The EAN code of the product | Example: 1234567890123
  }
  "inventory":
  object
  A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
  {
  "alwaysInStock":
  boolean
  Indicates that the product is always available and can be sold without explicit inventory checks, if true | Example: true
  }
  "lifecycle":
  object
  A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
  {
  "onlineStatusDefinition":
  string
  The status of the product | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
  "manufacturer":
  object
  A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
  {
  "name":
  string
  The name of an element
  "sku":
  string
  }
  "pricing":
  object
  A ProductAspectPricingRO_v1 object. The pricing aspect of the product
  {
  "taxClass":
  object
  A ProductTaxClassRefRO_v1 object. The reference to a tax class of a product
  {
  "id":
  string
  The identifier of the tax class reference | Example: FULL_TAX_CLASS
  }
  }
  "quoting":
  object
  A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
  {
  "quoteRequired":
  boolean
  Defines if the product requires quotation | Example: true
  }
  "retailSet":
  object
  A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
  {
  "products":
  array
  An array of ProductRetailSetItemRO_v1 objects. The retail set items of the retail set
  [
  ProductRetailSetItemRO_v1
  {
  "quantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "product":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  }
  ]
  }
  "sales":
  object
  A ProductAspectSalesRO_v1 object. The sales aspect of the product.
  {
  "maxOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "minOrderQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "packingQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  "stepQuantity":
  object
  A QuantityRO_v1 object. The quantity of a business entity.
  {
  "amount":
  number
  The amount of the quantity. | Example: 10
  "unit":
  string
  The unit of the quantity. | Example: kg
  }
  }
  "search":
  object
  A ProductAspectSearchRO_v1 object. The search aspect of the product
  {
  "searchIndexKeywords":
  array
  An array of LocalizedValueListString objects. The indexing keywords for search
  [
  LocalizedValueListString: A localized string list.
  {
  "locale":
  string
  The locale of the string list entry. | Example: en_US
  "value":
  array
  An array of string literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
  }
  ]
  }
  "supplier":
  object
  A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
  {
  "name":
  string
  The name of an element
  "sku":
  string
  }
  "variationMaster":
  object
  A ProductAspectVariationMasterRO_v1 object.
  {
  "defaultVariation":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  "variationAttributes":
  array
  An array of ProductVariationAttributeRO_v1 objects. The variation attributes of the variation master
  [
  ProductVariationAttributeRO_v1
  {
  "displayName":
  array
  An array of LocalizedValueString objects. The localized display name of the variation attribute
  [
  LocalizedValueString: A localized string value.
  {
  "locale":
  string
  The locale of the string. | Example: en_US
  "value":
  string
  The value of the localized string. | Example: LocString
  }
  ]
  "name":
  string
  The name of the variation attribute | Example: color
  "variationSelection":
  string
  The selected variation | Example: colorCode | Possible Values: defaultcolorCodedefaultAndColorCodeswatchImagedefaultAndSwatchImage
  "productAttributeName":
  string
  The product attribute name of the product variation attribute | Example: ExampleAttributeName
  }
  ]
  "variations":
  array
  An array of ProductRefRO_v1 objects. The variations of the variation master
  [
  ProductRefRO_v1: The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  ]
  }
  }
  "variationMasterProduct":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  }
- "messages":
  array
  Readonly | An array of FeedbackRO_v1 objects. List of messages regarding the request (e.g. value adjustments)
  [
  FeedbackRO_v1: An error or piece of information related to the current request
  {
  "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
  "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
  }
  ]
}
]
"info":
object
A ListInfoRO_v1 object. The optional information about the response object. All values are also optional.
{
- "hasMoreElements":
  boolean
  Readonly | Flag that expresses if there more entries available. | Example: true
- "limit":
  integer
  Readonly | The limit of list entries to be shown. | Format: int32 | Example: 20
- "offset":
  integer
  Readonly | Excludes the first N items from the list. | Format: int32 | Example: 10
- "total":
  integer
  Readonly | The total amount of entries in the list. | Format: int32 | Example: 30
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects.
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

ProductPatchRO application/vnd.intershop.admin.pim.v1+json

{

"data":
object
A ProductDataRO_v1 object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A ProductAspectContentRO_v1 object. The content of the product
  {
  - "attachments":
    array
    An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
    [
    ProductAttachmentRO_v1: The content of a product attachment
    {
    "locale":
    string
    The locale of the product attachment
    "type":
    string
    The type of product attachment [Information,Contract,Manual,Other]
    "name":
    string
    The product attachment name
    "description":
    string
    The product attachment description
    "includeInEMail":
    boolean
    A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
    "location":
    string
    The product attachment location
    }
    ]
  - "images":
    array
    An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
    [
    ImageRO_v1: The content of an image
    {
    "imagePath":
    string
    image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    "type":
    string
    The type id of the image e.g. thumbnail, image etc.
    "view":
    string
    The view id of the image e.g. front, back, default etc.
    }
    ]
  - "longDescription":
    array
    An array of LocalizedValueString objects. A list of localized long descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. A list of localized product names
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "primaryImageView":
    string
    The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
  - "shortDescription":
    array
    An array of LocalizedValueString objects. A list of localized short descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "fulfillment":
  object
  A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
  {
  - "freightClass":
    object
    A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
    {
    "id":
    string
    The identifier of the freight class reference | Example: FREIGHT_CLASS
    }
  - "readyForShipmentMax":
    object
    The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
  - "readyForShipmentMin":
    object
    The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
  }
- "identification":
  object
  A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
  {
  - "eanCode":
    string
    The EAN code of the product | Example: 1234567890123
  }
- "inventory":
  object
  A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
- "lifecycle":
  object
  A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
- "manufacturer":
  object
  A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
- "pricing":
  object
  A ProductAspectPricingRO_v1 object. The pricing aspect of the product
- "quoting":
  object
  A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
- "retailSet":
  object
  A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
- "sales":
  object
  A ProductAspectSalesRO_v1 object. The sales aspect of the product.
- "search":
  object
  A ProductAspectSearchRO_v1 object. The search aspect of the product
- "supplier":
  object
  A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
- "variationMaster":
  object
  A ProductAspectVariationMasterRO_v1 object.
}
"keys":
array
An array of string literals.
"declaredKeys":
array
An array of string literals.
"empty":
boolean

}

ProductRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"id":
string
The identifier of the response object | Example: productID
"data":
object
A ProductDataRO_v1 object.
{
- "attributes":
  array
  An array of Attribute_v1 objects. The (custom) attributes of an object.
  [
  Either IntegerAttribute_v1
  {}
  Or DoubleAttribute_v1
  {}
  Or StringAttribute_v1
  {}
  Or IntegerListAttribute_v1
  {}
  Or DoubleListAttribute_v1
  {}
  Or StringListAttribute_v1
  {}
  Or LongAttribute_v1
  {}
  Or BooleanAttribute_v1
  {}
  Or DateAttribute_v1
  {}
  Or DecimalAttribute_v1
  {}
  Or MoneyAttribute_v1
  {}
  Or QuantityAttribute_v1
  {}
  Or LongListAttribute_v1
  {}
  Or BooleanListAttribute_v1
  {}
  Or DateListAttribute_v1
  {}
  Or DecimalListAttribute_v1
  {}
  Or LocalizedIntegerAttribute_v1
  {}
  Or LocalizedDoubleAttribute_v1
  {}
  Or LocalizedStringAttribute_v1
  {}
  Or LocalizedIntegerListAttribute_v1
  {}
  Or LocalizedDoubleListAttribute_v1
  {}
  Or LocalizedStringListAttribute_v1
  {}
  Or LocalizedLongAttribute_v1
  {}
  Or LocalizedBooleanAttribute_v1
  {}
  Or LocalizedDateAttribute_v1
  {}
  Or LocalizedDecimalAttribute_v1
  {}
  Or LocalizedMoneyAttribute_v1
  {}
  Or LocalizedQuantityAttribute_v1
  {}
  Or LocalizedLongListAttribute_v1
  {}
  Or LocalizedBooleanListAttribute_v1
  {}
  Or LocalizedDateListAttribute_v1
  {}
  Or LocalizedDecimalListAttribute_v1
  {}
  ]
- "content":
  object
  A ProductAspectContentRO_v1 object. The content of the product
  {
  - "attachments":
    array
    An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
    [
    ProductAttachmentRO_v1: The content of a product attachment
    {
    "locale":
    string
    The locale of the product attachment
    "type":
    string
    The type of product attachment [Information,Contract,Manual,Other]
    "name":
    string
    The product attachment name
    "description":
    string
    The product attachment description
    "includeInEMail":
    boolean
    A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
    "location":
    string
    The product attachment location
    }
    ]
  - "images":
    array
    An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
    [
    ImageRO_v1: The content of an image
    {
    "imagePath":
    string
    image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    "type":
    string
    The type id of the image e.g. thumbnail, image etc.
    "view":
    string
    The view id of the image e.g. front, back, default etc.
    }
    ]
  - "longDescription":
    array
    An array of LocalizedValueString objects. A list of localized long descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "name":
    array
    An array of LocalizedValueString objects. A list of localized product names
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  - "primaryImageView":
    string
    The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
  - "shortDescription":
    array
    An array of LocalizedValueString objects. A list of localized short descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
  }
- "fulfillment":
  object
  A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
  {
  - "freightClass":
    object
    A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
    {
    "id":
    string
    The identifier of the freight class reference | Example: FREIGHT_CLASS
    }
  - "readyForShipmentMax":
    object
    The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
  - "readyForShipmentMin":
    object
    The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
  }
- "identification":
  object
  A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
  {
  - "eanCode":
    string
    The EAN code of the product | Example: 1234567890123
  }
- "inventory":
  object
  A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
  {
  - "alwaysInStock":
    boolean
    Indicates that the product is always available and can be sold without explicit inventory checks, if true | Example: true
  }
- "lifecycle":
  object
  A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
  {
  - "onlineStatusDefinition":
    string
    The status of the product | Example: ONLINE | Possible Values: ONLINEOFFLINE
  }
- "manufacturer":
  object
  A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
  {
  - "name":
    string
    The name of an element
  - "sku":
    string
  }
- "pricing":
  object
  A ProductAspectPricingRO_v1 object. The pricing aspect of the product
  {
  - "taxClass":
    object
    A ProductTaxClassRefRO_v1 object. The reference to a tax class of a product
    {
    "id":
    string
    The identifier of the tax class reference | Example: FULL_TAX_CLASS
    }
  }
- "quoting":
  object
  A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
  {
  - "quoteRequired":
    boolean
    Defines if the product requires quotation | Example: true
  }
- "retailSet":
  object
  A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
  {
  - "products":
    array
    An array of ProductRetailSetItemRO_v1 objects. The retail set items of the retail set
    [
    ProductRetailSetItemRO_v1
    {
    "quantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    "product":
    object
    A ProductRefRO_v1 object. The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
    }
    ]
  }
- "sales":
  object
  A ProductAspectSalesRO_v1 object. The sales aspect of the product.
  {
  - "maxOrderQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
  - "minOrderQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
  - "packingQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
  - "stepQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
  }
- "search":
  object
  A ProductAspectSearchRO_v1 object. The search aspect of the product
  {
  - "searchIndexKeywords":
    array
    An array of LocalizedValueListString objects. The indexing keywords for search
    [
    LocalizedValueListString: A localized string list.
    {
    "locale":
    string
    The locale of the string list entry. | Example: en_US
    "value":
    array
    An array of string literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
    }
    ]
  }
- "supplier":
  object
  A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
  {
  - "name":
    string
    The name of an element
  - "sku":
    string
  }
- "variationMaster":
  object
  A ProductAspectVariationMasterRO_v1 object.
  {
  - "defaultVariation":
    object
    A ProductRefRO_v1 object. The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
  - "variationAttributes":
    array
    An array of ProductVariationAttributeRO_v1 objects. The variation attributes of the variation master
    [
    ProductVariationAttributeRO_v1
    {
    "displayName":
    array
    An array of LocalizedValueString objects. The localized display name of the variation attribute
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
    "name":
    string
    The name of the variation attribute | Example: color
    "variationSelection":
    string
    The selected variation | Example: colorCode | Possible Values: defaultcolorCodedefaultAndColorCodeswatchImagedefaultAndSwatchImage
    "productAttributeName":
    string
    The product attribute name of the product variation attribute | Example: ExampleAttributeName
    }
    ]
  - "variations":
    array
    An array of ProductRefRO_v1 objects. The variations of the variation master
    [
    ProductRefRO_v1: The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
    ]
  }
}
"info":
object
A ProductInfoRO_v1 object. The optional info of the response object. This section is read-only.
{
- "images":
  array
  An array of ImageInfoRO_v1 objects. A list of images providing the effectiveURL.
  [
  ImageInfoRO_v1: The info of an image
  {
  "effectiveUrl":
  string
  }
  ]
- "lastModified":
  string
  The date the product was last modified. | Format: date-time
- "partOfRetailSets":
  array
  An array of ProductRefRO_v1 objects. The references to the retail sets the product is part of.
  [
  ProductRefRO_v1: The reference to a product
  {
  "id":
  string
  The identifier of the product reference | Example: productID
  }
  ]
- "sourceProduct":
  object
  A ProductDataRO_v1 object.
  {
  - "attributes":
    array
    An array of Attribute_v1 objects. The (custom) attributes of an object.
    [
    Either IntegerAttribute_v1
    {}
    Or DoubleAttribute_v1
    {}
    Or StringAttribute_v1
    {}
    Or IntegerListAttribute_v1
    {}
    Or DoubleListAttribute_v1
    {}
    Or StringListAttribute_v1
    {}
    Or LongAttribute_v1
    {}
    Or BooleanAttribute_v1
    {}
    Or DateAttribute_v1
    {}
    Or DecimalAttribute_v1
    {}
    Or MoneyAttribute_v1
    {}
    Or QuantityAttribute_v1
    {}
    Or LongListAttribute_v1
    {}
    Or BooleanListAttribute_v1
    {}
    Or DateListAttribute_v1
    {}
    Or DecimalListAttribute_v1
    {}
    Or LocalizedIntegerAttribute_v1
    {}
    Or LocalizedDoubleAttribute_v1
    {}
    Or LocalizedStringAttribute_v1
    {}
    Or LocalizedIntegerListAttribute_v1
    {}
    Or LocalizedDoubleListAttribute_v1
    {}
    Or LocalizedStringListAttribute_v1
    {}
    Or LocalizedLongAttribute_v1
    {}
    Or LocalizedBooleanAttribute_v1
    {}
    Or LocalizedDateAttribute_v1
    {}
    Or LocalizedDecimalAttribute_v1
    {}
    Or LocalizedMoneyAttribute_v1
    {}
    Or LocalizedQuantityAttribute_v1
    {}
    Or LocalizedLongListAttribute_v1
    {}
    Or LocalizedBooleanListAttribute_v1
    {}
    Or LocalizedDateListAttribute_v1
    {}
    Or LocalizedDecimalListAttribute_v1
    {}
    ]
  - "content":
    object
    A ProductAspectContentRO_v1 object. The content of the product
    {
    "attachments":
    array
    An array of ProductAttachmentRO_v1 objects. A list of attachments described by locale, type, name, description, includeInEMail and location;
    [
    ProductAttachmentRO_v1: The content of a product attachment
    {
    "locale":
    string
    The locale of the product attachment
    "type":
    string
    The type of product attachment [Information,Contract,Manual,Other]
    "name":
    string
    The product attachment name
    "description":
    string
    The product attachment description
    "includeInEMail":
    boolean
    A true or false value to indicate whether or not to add the product attachment to the order confirmation email.
    "location":
    string
    The product attachment location
    }
    ]
    "images":
    array
    An array of ImageRO_v1 objects. A list of images described by imagePath, type and view
    [
    ImageRO_v1: The content of an image
    {
    "imagePath":
    string
    image location (usually consists of file name, path parts or url parts) example: L/3740178-1748.jpg
    "type":
    string
    The type id of the image e.g. thumbnail, image etc.
    "view":
    string
    The view id of the image e.g. front, back, default etc.
    }
    ]
    "longDescription":
    array
    An array of LocalizedValueString objects. A list of localized long descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
    "name":
    array
    An array of LocalizedValueString objects. A list of localized product names
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
    "primaryImageView":
    string
    The optional primaryImageView field allows a specific view to be set as the default view for the product, overriding the organization-level primary image view | Example: primaryImageID
    "shortDescription":
    array
    An array of LocalizedValueString objects. A list of localized short descriptions of the product
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
    }
  - "fulfillment":
    object
    A ProductAspectFulfillmentRO_v1 object. The fulfillment aspect of the product.
    {
    "freightClass":
    object
    A ProductFreightClassRefRO_v1 object. The reference to a freight class of a product
    {
    "id":
    string
    The identifier of the freight class reference | Example: FREIGHT_CLASS
    }
    "readyForShipmentMax":
    object
    The maximum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P10D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
    "readyForShipmentMin":
    object
    The minimum duration (in ISO-8601 duration format) until the product is ready for shipment | Example: P1D
    {
    "seconds":
    integer
    Format: int64
    "zero":
    boolean
    "nano":
    integer
    Format: int32
    "negative":
    boolean
    "units":
    array
    An array of object literals.
    [
    {
    "durationEstimated":
    boolean
    "timeBased":
    boolean
    "dateBased":
    boolean
    }
    ]
    }
    }
  - "identification":
    object
    A ProductAspectIdentificationRO_v1 object. The identification aspect of the product
    {
    "eanCode":
    string
    The EAN code of the product | Example: 1234567890123
    }
  - "inventory":
    object
    A ProductAspectInventoryRO_v1 object. The inventory aspect of the product
    {
    "alwaysInStock":
    boolean
    Indicates that the product is always available and can be sold without explicit inventory checks, if true | Example: true
    }
  - "lifecycle":
    object
    A ProductAspectLifecycleRO_v1 object. The lifecycle aspect of the product
    {
    "onlineStatusDefinition":
    string
    The status of the product | Example: ONLINE | Possible Values: ONLINEOFFLINE
    }
  - "manufacturer":
    object
    A ProductAspectManufacturerRO_v1 object. The manufacturer aspect of the product
    {
    "name":
    string
    The name of an element
    "sku":
    string
    }
  - "pricing":
    object
    A ProductAspectPricingRO_v1 object. The pricing aspect of the product
    {
    "taxClass":
    object
    A ProductTaxClassRefRO_v1 object. The reference to a tax class of a product
    {
    "id":
    string
    The identifier of the tax class reference | Example: FULL_TAX_CLASS
    }
    }
  - "quoting":
    object
    A ProductAspectQuotingRO_v1 object. The quoting aspect of the product
    {
    "quoteRequired":
    boolean
    Defines if the product requires quotation | Example: true
    }
  - "retailSet":
    object
    A ProductAspectRetailSetRO_v1 object. The retail set aspect of the product
    {
    "products":
    array
    An array of ProductRetailSetItemRO_v1 objects. The retail set items of the retail set
    [
    ProductRetailSetItemRO_v1
    {
    "quantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    "product":
    object
    A ProductRefRO_v1 object. The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
    }
    ]
    }
  - "sales":
    object
    A ProductAspectSalesRO_v1 object. The sales aspect of the product.
    {
    "maxOrderQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    "minOrderQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    "packingQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    "stepQuantity":
    object
    A QuantityRO_v1 object. The quantity of a business entity.
    {
    "amount":
    number
    The amount of the quantity. | Example: 10
    "unit":
    string
    The unit of the quantity. | Example: kg
    }
    }
  - "search":
    object
    A ProductAspectSearchRO_v1 object. The search aspect of the product
    {
    "searchIndexKeywords":
    array
    An array of LocalizedValueListString objects. The indexing keywords for search
    [
    LocalizedValueListString: A localized string list.
    {
    "locale":
    string
    The locale of the string list entry. | Example: en_US
    "value":
    array
    An array of string literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
    }
    ]
    }
  - "supplier":
    object
    A ProductAspectSupplierRO_v1 object. The supplier aspect of the product
    {
    "name":
    string
    The name of an element
    "sku":
    string
    }
  - "variationMaster":
    object
    A ProductAspectVariationMasterRO_v1 object.
    {
    "defaultVariation":
    object
    A ProductRefRO_v1 object. The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
    "variationAttributes":
    array
    An array of ProductVariationAttributeRO_v1 objects. The variation attributes of the variation master
    [
    ProductVariationAttributeRO_v1
    {
    "displayName":
    array
    An array of LocalizedValueString objects. The localized display name of the variation attribute
    [
    LocalizedValueString: A localized string value.
    {
    "locale":
    string
    The locale of the string. | Example: en_US
    "value":
    string
    The value of the localized string. | Example: LocString
    }
    ]
    "name":
    string
    The name of the variation attribute | Example: color
    "variationSelection":
    string
    The selected variation | Example: colorCode | Possible Values: defaultcolorCodedefaultAndColorCodeswatchImagedefaultAndSwatchImage
    "productAttributeName":
    string
    The product attribute name of the product variation attribute | Example: ExampleAttributeName
    }
    ]
    "variations":
    array
    An array of ProductRefRO_v1 objects. The variations of the variation master
    [
    ProductRefRO_v1: The reference to a product
    {
    "id":
    string
    The identifier of the product reference | Example: productID
    }
    ]
    }
  }
- "variationMasterProduct":
  object
  A ProductRefRO_v1 object. The reference to a product
  {
  - "id":
    string
    The identifier of the product reference | Example: productID
  }
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects. List of messages regarding the request (e.g. value adjustments)
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

ProductRefListRESTResponse_v1 application/vnd.intershop.admin.pim.v1+json

{

"data":
array
An array of ProductRefRO_v1 objects. The core data of the response object
[
ProductRefRO_v1: The reference to a product
{
- "id":
  string
  The identifier of the product reference | Example: productID
}
]
"info":
object
A ListInfoRO_v1 object. The optional information about the response object. All values are also optional.
{
- "hasMoreElements":
  boolean
  Readonly | Flag that expresses if there more entries available. | Example: true
- "limit":
  integer
  Readonly | The limit of list entries to be shown. | Format: int32 | Example: 20
- "offset":
  integer
  Readonly | Excludes the first N items from the list. | Format: int32 | Example: 10
- "total":
  integer
  Readonly | The total amount of entries in the list. | Format: int32 | Example: 30
}
"messages":
array
Readonly | An array of FeedbackRO_v1 objects.
[
FeedbackRO_v1: An error or piece of information related to the current request
{
- "causes":
  array
  An array of FeedbackCauseRO_v1 objects. A collection of errors/warnings/infos that caused the feedback
  [
  FeedbackCauseRO_v1: A representation for the common feedback information
  {
  "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
  "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
  "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
  "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
  }
  ]
- "code":
  string
  Required | A unique identifier for this particular occurrence of the problem (may be used for localization on client-side) | Example: product.name.required.error
- "message":
  string
  Required | A human readable message in the request's locale | Example: The product name must be specified.
- "parameters":
  array
  An array of object literals. A map of several parameters that are used to assemble the message
- "paths":
  array
  An array of string literals. A collection of JSON paths to the associated entities. Unless otherwise specified, this always refers to the request entity. | Documentation: https://github.com/json-path/JsonPath | Example: ["\"$.name (position: 1)\""]
- "level":
  string
  The level of the feedback | Example: ERROR | Possible Values: INFOWARNERROR
- "status":
  string
  The HTTP status code that is applicable to this problem | Example: 422
}
]

}

ProductRefRO_v1 application/vnd.intershop.admin.pim.v1+json

[

ProductRefRO_v1: The reference to a product
{

"id":
string
The identifier of the product reference | Example: productID

}

]

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

References

API Specification

API Versioning & Accept Header

Changelog

Version 1.2.0

Version 1.1.0

Version 1.0.0

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body

Request Parameters

Response

Description

Java Method

Request Body