This API specification is available for download as an Open API 3.0 YAML file:
The following page lists available REST APIs for ICM 11 and their version dependencies:
This section covers various catalog-related operations, such as retrieving, creating and updating catalogs and catalog categories.
/catalogs
This operation returns a list of all top-level categories (catalogs). The sorting is as defined in Intershop Commerce Management (manual or dynamic sorting).
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogListResource.getCatalogList(java.lang.Integer,java.lang.Integer)
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. |
200 - OK - The list of catalogs is returned.
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}
This operation returns the catalog with the given ID.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.getCatalog()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | catalogId | string | Required |
200 - OK - The catalog with the given ID is returned.
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.
This operation creates the catalog with the given ID and all the provided information. Missing information can be added later via PATCH.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.createCatalog(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | catalogId | string | Required |
201 - Created OK - The catalog was successfully created.
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.
This operation updates the catalog with the all the provided information.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CatalogItemResource.updateCatalog(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | catalogId | string | Required |
200 - OK - The catalog was successfully updated.
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
This operation returns a list of catalog categories (sub categories, level 1).
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryListResource.getCategoryList(java.lang.Integer,java.lang.Integer)
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. |
200 - OK - The list of catalog categories is returned.
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}
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.CategoryItemResource.getCategory()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | categoryId | string | Required | ||
in path | catalogId | string | Required |
200 - OK - The catalog category with the given ID is returned.
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
This operation returns a list of explicitly assigned products of a catalog category. The sorting is as defined in Intershop Commerce Management (manual or automatic sorting).
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.getExplicitlyAssignedProductList(java.lang.Integer,java.lang.Integer)
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. |
200 - OK - The list of explicitly assigned products is returned.
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.
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.
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)
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. |
200 - OK - The list of explicitly assigned products is returned.
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
This operation appends the list of explicitly assigned products of a catalog category. New product assignments in this category will always use automatic sorting.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListAppendAllResource.appendExplicitlyAssignedProducts(java.util.List)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | categoryId | string | Required | ||
in path | catalogId | string | Required |
200 - OK - The list of explicitly assigned products is appended.
207 - Multi-Status Multi Status - The list of explicitly assigned products is appended, some items unprocessable.
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}
This operation deletes the catalog category explicitly product assignment with the given ID.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductItemResource.deleteExplicitlyProductAssignment()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required | ||
in path | categoryId | string | Required | ||
in path | catalogId | string | Required |
200 - OK - Information message describing success status.
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
This operation returns a list of explicitly assigned products of a catalog category. The sorting is as defined in Intershop Commerce Management (manual or automatic sorting).
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListResource.getExplicitlyAssignedProductList(java.lang.Integer,java.lang.Integer)
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. |
200 - OK - The list of explicitly assigned products is returned.
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.
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.
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)
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. |
200 - OK - The list of explicitly assigned products is returned.
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
This operation appends the list of explicitly assigned products of a catalog category. New product assignments in this category will always use automatic sorting.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductListAppendAllResource.appendExplicitlyAssignedProducts(java.util.List)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | catalogId | string | Required |
200 - OK - The list of explicitly assigned products is appended.
207 - Multi-Status Multi Status - The list of explicitly assigned products is appended, some items unprocessable.
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}
This operation deletes the catalog category explicitly product assignment with the given ID.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.catalog.ExplicitlyAssignedProductItemResource.deleteExplicitlyProductAssignment()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required | ||
in path | catalogId | string | Required |
200 - OK - Information message describing success status.
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.
/products
This operation returns a list of products for the given parameters.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductListResource.getProductList(java.lang.Integer,java.lang.Integer)
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 |
200 - OK - The list of products is returned.
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.
/products/{productId}
This operation returns the product with the given ID.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.getProduct()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required |
200 - OK - The product with the given ID is returned.
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.
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 |
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.createProduct(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required |
200 - OK
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.
This operation deletes the product with the given ID.
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.deleteProduct()
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required |
200 - OK - Information message describing success status.
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.
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 |
public jakarta.ws.rs.core.Response com.intershop.application.rest.pim.v1.capi.resource.product.ProductItemResource.updateProduct(java.lang.String)
Location | Name | Format | Default | Example | Description |
---|---|---|---|---|---|
in path | productId | string | Required |
200 - OK - The product was successfully updated.
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.
Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
CatalogRESTResponse_v1
objects. The data of the response object.CatalogRESTResponse_v1
: The core data of the response object.catalogID
CatalogDataRO_v1
object. The core data of the response object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
CatalogInfoRO_v1
object. The optional info of the response object.true
STANDARD
| Possible Values: STANDARD
CLASSIFICATION
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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ListInfoRO_v1
object. The optional information about the response object. All values are also optional.true
int32
| Example: 20
int32
| Example: 10
int32
| Example: 30
FeedbackRO_v1
objects.FeedbackRO_v1
: An error or piece of information related to the current request.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
CatalogDataRO_v1
object. The core data of the response object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
string
literals.string
literals.catalogID
CatalogDataRO_v1
object. The core data of the response object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
CatalogInfoRO_v1
object. The optional info of the response object.true
STANDARD
| Possible Values: STANDARD
CLASSIFICATION
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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
CategoryRESTResponse_v1
objects. The core data of the response object.CategoryRESTResponse_v1
categoryID
CategoryDataRO_v1
object. The core data of the response object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
CategoryInfoRO_v1
object. Optional information of the response object.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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ListInfoRO_v1
object. The optional information about the response object. All values are also optional.true
int32
| Example: 20
int32
| Example: 10
int32
| Example: 30
FeedbackRO_v1
objects.FeedbackRO_v1
: An error or piece of information related to the current request.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
categoryID
CategoryDataRO_v1
object. The core data of the response object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
CatalogAspectContentRO
object.LocalizedValueString
objects. The name of an elementLocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects.LocalizedValueString
: A localized string value.en_US
LocString
CatalogAspectVisibilityRO_v1
object. Visibility information about the catalog.ONLINE
| Possible Values: ONLINE
OFFLINE
true
CategoryInfoRO_v1
object. Optional information of the response object.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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductRetailSetItemRO_v1
objects. The retail set items of the retail set.ProductRetailSetItemRO_v1
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductRefRO_v1
object. The reference to a product.productID
ProductAspectSalesRO_v1
object. The sales aspect of the product.QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductAspectSearchRO_v1
object. The search aspect of the product.LocalizedValueListString
objects. The indexing keywords for search.LocalizedValueListString
: A localized string list.en_US
string
literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.ProductRefRO_v1
object. The reference to a product.productID
ProductVariationAttributeRO_v1
objects. The variation attributes of the variation master.ProductVariationAttributeRO_v1
LocalizedValueString
objects. The localized display name of the variation attribute.LocalizedValueString
: A localized string value.en_US
LocString
color
colorCode
| Possible Values: default
colorCode
defaultAndColorCode
swatchImage
defaultAndSwatchImage
ExampleAttributeName
ProductRefRO_v1
objects. The variations of the variation master.ProductRefRO_v1
: The reference to a product.productID
ProductRESTResponse_v1
objects. The core data of the response object.ProductRESTResponse_v1
: The core data of the response object.productID
ProductDataRO_v1
object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductRetailSetItemRO_v1
objects. The retail set items of the retail set.ProductRetailSetItemRO_v1
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductRefRO_v1
object. The reference to a product.productID
ProductAspectSalesRO_v1
object. The sales aspect of the product.QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductAspectSearchRO_v1
object. The search aspect of the product.LocalizedValueListString
objects. The indexing keywords for search.LocalizedValueListString
: A localized string list.en_US
string
literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.ProductRefRO_v1
object. The reference to a product.productID
ProductVariationAttributeRO_v1
objects. The variation attributes of the variation master.ProductVariationAttributeRO_v1
LocalizedValueString
objects. The localized display name of the variation attribute.LocalizedValueString
: A localized string value.en_US
LocString
color
colorCode
| Possible Values: default
colorCode
defaultAndColorCode
swatchImage
defaultAndSwatchImage
ExampleAttributeName
ProductRefRO_v1
objects. The variations of the variation master.ProductRefRO_v1
: The reference to a product.productID
ProductInfoRO_v1
object. The optional info of the response object. This section is read-only.ImageInfoRO_v1
objects. A list of images providing the effectiveURLImageInfoRO_v1
: The info of an image.date-time
ProductRefRO_v1
objects. The references to the retail sets the product is part of.ProductRefRO_v1
: The reference to a product.productID
ProductDataRO_v1
object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductRetailSetItemRO_v1
objects. The retail set items of the retail set.ProductRetailSetItemRO_v1
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductRefRO_v1
object. The reference to a product.productID
ProductAspectSalesRO_v1
object. The sales aspect of the product.QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductAspectSearchRO_v1
object. The search aspect of the product.LocalizedValueListString
objects. The indexing keywords for search.LocalizedValueListString
: A localized string list.en_US
string
literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.ProductRefRO_v1
object. The reference to a product.productID
ProductVariationAttributeRO_v1
objects. The variation attributes of the variation master.ProductVariationAttributeRO_v1
LocalizedValueString
objects. The localized display name of the variation attribute.LocalizedValueString
: A localized string value.en_US
LocString
color
colorCode
| Possible Values: default
colorCode
defaultAndColorCode
swatchImage
defaultAndSwatchImage
ExampleAttributeName
ProductRefRO_v1
objects. The variations of the variation master.ProductRefRO_v1
: The reference to a product.productID
ProductRefRO_v1
object. The reference to a product.productID
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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ListInfoRO_v1
object. The optional information about the response object. All values are also optional.true
int32
| Example: 20
int32
| Example: 10
int32
| Example: 30
FeedbackRO_v1
objects.FeedbackRO_v1
: An error or piece of information related to the current request.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ProductDataRO_v1
object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductAspectSalesRO_v1
object. The sales aspect of the product.ProductAspectSearchRO_v1
object. The search aspect of the product.ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.string
literals.string
literals.productID
ProductDataRO_v1
object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductRetailSetItemRO_v1
objects. The retail set items of the retail set.ProductRetailSetItemRO_v1
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductRefRO_v1
object. The reference to a product.productID
ProductAspectSalesRO_v1
object. The sales aspect of the product.QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductAspectSearchRO_v1
object. The search aspect of the product.LocalizedValueListString
objects. The indexing keywords for search.LocalizedValueListString
: A localized string list.en_US
string
literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.ProductRefRO_v1
object. The reference to a product.productID
ProductVariationAttributeRO_v1
objects. The variation attributes of the variation master.ProductVariationAttributeRO_v1
LocalizedValueString
objects. The localized display name of the variation attribute.LocalizedValueString
: A localized string value.en_US
LocString
color
colorCode
| Possible Values: default
colorCode
defaultAndColorCode
swatchImage
defaultAndSwatchImage
ExampleAttributeName
ProductRefRO_v1
objects. The variations of the variation master.ProductRefRO_v1
: The reference to a product.productID
ProductInfoRO_v1
object. The optional info of the response object. This section is read-only.ImageInfoRO_v1
objects. A list of images providing the effectiveURLImageInfoRO_v1
: The info of an image.date-time
ProductRefRO_v1
objects. The references to the retail sets the product is part of.ProductRefRO_v1
: The reference to a product.productID
ProductDataRO_v1
object.Attribute_v1
objects. The (custom) attributes of an object.IntegerAttribute_v1
DoubleAttribute_v1
StringAttribute_v1
IntegerListAttribute_v1
DoubleListAttribute_v1
StringListAttribute_v1
LongAttribute_v1
BooleanAttribute_v1
DateAttribute_v1
DecimalAttribute_v1
MoneyAttribute_v1
QuantityAttribute_v1
LongListAttribute_v1
BooleanListAttribute_v1
DateListAttribute_v1
DecimalListAttribute_v1
LocalizedIntegerAttribute_v1
LocalizedDoubleAttribute_v1
LocalizedStringAttribute_v1
LocalizedIntegerListAttribute_v1
LocalizedDoubleListAttribute_v1
LocalizedStringListAttribute_v1
LocalizedLongAttribute_v1
LocalizedBooleanAttribute_v1
LocalizedDateAttribute_v1
LocalizedDecimalAttribute_v1
LocalizedMoneyAttribute_v1
LocalizedQuantityAttribute_v1
LocalizedLongListAttribute_v1
LocalizedBooleanListAttribute_v1
LocalizedDateListAttribute_v1
LocalizedDecimalListAttribute_v1
ProductAspectContentRO_v1
object. The content of the product.ImageRO_v1
objects. A list of images described by imagePath, type and viewImageRO_v1
: The content of an image.LocalizedValueString
objects. A list of localized long descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
LocalizedValueString
objects. A list of localized product names.LocalizedValueString
: A localized string value.en_US
LocString
primaryImageID
LocalizedValueString
objects. A list of localized short descriptions of the product.LocalizedValueString
: A localized string value.en_US
LocString
ProductAspectFulfillmentRO_v1
object. The fulfillment aspect of the product.ProductFreightClassRefRO_v1
object. The reference to a freight class of a product.FREIGHT_CLASS
P10D
int64
int32
object
literals.P1D
int64
int32
object
literals.ProductAspectIdentificationRO_v1
object. The identification aspect of the product.1234567890123
ProductAspectInventoryRO_v1
object. The inventory aspect of the product.true
ProductAspectLifecycleRO_v1
object. The lifecycle aspect of the product.ONLINE
| Possible Values: ONLINE
OFFLINE
ProductAspectManufacturerRO_v1
object. The manufacturer aspect of the product.ProductAspectPricingRO_v1
object. The pricing aspect of the product.ProductTaxClassRefRO_v1
object. The reference to a tax class of a product.FULL_TAX_CLASS
ProductAspectQuotingRO_v1
object. The quoting aspect of the product.true
ProductAspectRetailSetRO_v1
object. The retail set aspect of the product.ProductRetailSetItemRO_v1
objects. The retail set items of the retail set.ProductRetailSetItemRO_v1
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductRefRO_v1
object. The reference to a product.productID
ProductAspectSalesRO_v1
object. The sales aspect of the product.QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
QuantityRO_v1
object. The quantity of a business entity.10
kg
ProductAspectSearchRO_v1
object. The search aspect of the product.LocalizedValueListString
objects. The indexing keywords for search.LocalizedValueListString
: A localized string list.en_US
string
literals. The value of the localized string list entry. | Example: ["LocString1","LocString2"]
ProductAspectSupplierRO_v1
object. The supplier aspect of the product.ProductAspectVariationMasterRO_v1
object.ProductRefRO_v1
object. The reference to a product.productID
ProductVariationAttributeRO_v1
objects. The variation attributes of the variation master.ProductVariationAttributeRO_v1
LocalizedValueString
objects. The localized display name of the variation attribute.LocalizedValueString
: A localized string value.en_US
LocString
color
colorCode
| Possible Values: default
colorCode
defaultAndColorCode
swatchImage
defaultAndSwatchImage
ExampleAttributeName
ProductRefRO_v1
objects. The variations of the variation master.ProductRefRO_v1
: The reference to a product.productID
ProductRefRO_v1
object. The reference to a product.productID
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.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ProductRefRO_v1
objects. The core data of the response object.ProductRefRO_v1
: The reference to a product.productID
ListInfoRO_v1
object. The optional information about the response object. All values are also optional.true
int32
| Example: 20
int32
| Example: 10
int32
| Example: 30
FeedbackRO_v1
objects.FeedbackRO_v1
: An error or piece of information related to the current request.FeedbackCauseRO_v1
objects. A collection of errors/warnings/infos that caused the feedback.FeedbackCauseRO_v1
: A representation for the common feedback information.product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
product.name.required.error
The product name must be specified.
object
literals. A map of several parameters that are used to assemble the message.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)\""]
ERROR
| Possible Values: INFO
WARN
ERROR
422
ProductRefRO_v1
: The reference to a product.productID