Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
Category API
  • /product-information/category/tree
  • GET
Categories are a part of the product information management system.
Media API
  • /product-information/media/medias
  • GET POST
Provides REST methods for managing media.
Price API
  • /product-information/price/prices
  • PATCH
Prices are an integral part of the product information management system.
Product API
  • /product-information/product/packages
  • /product-information/product/products
  • /product-information/product/related-products
  • /product-information/product/deactivate/{productId}
  • /product-information/product/related-products/delete
  • POST
  • GET POST
  • POST
  • POST
  • POST
Products is the heart of the product information management system that ties everything together. A product has stock keeping unit with attributes, prices and stock balances. A product also has brands, properties and much more. Note that stock balances are not included in the "product information management" API.

Data Types

type description
ArticleType
Attribute1Changes Contains changes that applies to attribute1.
Attribute1TranslationChanges Contains changes to attribute1 translations.
Attribute2Changes Contains changes that applies to attribute2.
Attribute2TranslationChanges Contains changes to attribute2 translations.
Attribute3Changes Contains changes that applies to attribute3.
Attribute3TranslationChanges Contains changes to attribute3 translations.
CategoriesToReplaceExisting Contains changes that applies to a product.
Category Defines a category node in the category tree. A category can contain zero or more child categories.
Content Contains the sub-products.
ContentGroup Contains grouped content
Group Contains a groups of content to add to the package
Language Defines a translation of a category name in a specific language.
Language Defines the languages that can be used in ETM.

The values of languages are from the ISO 639-1 standard.

MediaChanges Contains information about a new or updated medias.
MediaResult Holds a search result of media for stock keeping units.
MediaScale The data related to the image.
MediaToConnect Contains changes that applies to a product medias.
MediaType
MediaType Represents media row_id (image type) used in web shops.
PackageToAddOrUpdate Contains a package to add or update
PackagesToAddOrUpdate Contains packages to add or update
Price Defines a single price of a stock keeping unit.
PriceChanges Contains information about price changes.
Product Contains information about a new or updated products.
ProductCategory A category the product is connected to.
ProductChanges Contains changes that applies to a product.
ProductPriceUpdate Contains information about product-price update.
ProductPriceUpdateOrAdd Contains information about product price to update or add.
ProductPropertyTranslationToChange Contains changes that applies to a product property translation.
ProductResult Holds a search result of products.
ProductToAddOrUpdate Contains changes that applies to a product.
ProductTranslation Defines a translation of a product in a specific language.
Property Defines a property of a stock keeping unit.
PropertyKeyNameTranslationToChange Contains changes that applies to a property translation.
PropertyToAddOrUpdate Contains changes that applies to a product property.
PropertyToReplace Contains changes that applies to a product property.
PropertyValue Defines a property value of a property.
PropertyValueTranslation Contains changes that applies to a product properties value and translation.
RelatedProduct Related product information
RelatedProductChanges Contains new or changed related products for a given product.
RelatedProductDeletes Contains related products for deletion.
RelatedProductId Related product information
RelatedProductToAddOrUpdate Related products to add or update.
RelatedProductToDelete Related products to delete.
RelationTranslation
RelationType
Scale The different media scales/sizes. Scale is typically only defined for images, for other types of media it's undefined how a size is to be interpreted.
StockKeepingUnit The purchasable unit of a product.
StockKeepingUnit The collection of media for a product.
StockKeepingUnitMedia The specific media details for a product.
StockKeepingUnitStockBalancesChanges Contains changes that applies to a stockkeepingunit balances.
StockKeepingUnitSupplierChanges Contains changes that applies to a stockkeepingunit supplier.
StockKeepingUnitToAddOrUpdate Contains changes that applies to a product variant.
StockKeepingUnitTranslation Defines a translation of a stock keeping unit in a specific language.
SubProduct A product to be added to a package, the sub-product must already exist in the system.
Supplier Defines a supplier of a stock keeping unit.
Translation Contains translations for the package.
TranslationToAddOrUpdate Contains changes that applies to a product.
TranslationToAddOrUpdate Product relation translations.
TranslationToDelete Product relation translations.
Type Represents media type