Items API

The items API allows users to get an item by id. This API does not use the search engine. Searching is therefore not enabled here. The items API fetches an item directly from the source which is why a key must be provided.

The source can be different depending on the type of the item that is requested. Therefore the type parameter must be provided. Each type can have another source system.

Parameters

The items API can have multiple parameters specified, some of them must be in the URL, others can be passed in the body of the request depending on the action (GET or POST).

Following parameters must always be provided:

  • Type

  • Key

Type

Different item types are supported in the APIs. Each type can have a different source system. Providing the type is required to fetch the item from the right source. The type can be:

  • product

  • design

  • collection

  • designyarn

  • customer

  • businesspartner

  • asset

Key

The key value must always be provided as it uniquely identifies the item. The format of this key depends on the type that is chosen. An asset can have another key format than a product for example.

The asset key format should be a GUID and looks like 15e99210-f1e4-45e2-8d6b-422df70750a8. The key can either be fetched from a search result in the search API or can be looked up in the original source system.

Partition

Partitions are not supported for assets. The endpoint without the partition parameter should be used when requesting assets.