POST /Themes

GENERAL INFORMATION

Purpose

This endpoint is used for sharing product theme information.

How the data is used

The theme information is shown throughout the customer portal so users are quick to identify the theme of the products in the overview:

This enables users to gain insights into the products associated with that theme so they are able to make decisions and/or create (automated) actions in the customer portal based on the theme information. This makes it a highly recommended dataset to share.

Best practices

1. Make sure to update the theme on a regular basis, recommended minimum once a day, to ensure the theme information is complete and in-line with the themes assigned to the items in POST /Items

2. Ensure that the id you are using in this endpoint aligns with the themeId you are assigning to the items in the POST /Items endpoint.

3. For the description use a clear, short description of the theme, for example “Back to School” or “Holiday Collection”.

Common pitfalls

1. Do not generate a random id for the themeId field in the integration; only use system-generated IDs that are fixed in the source system, as you need the same ID to also be able to update the theme information.

2. A common pitfall is to send a system-generated value like a UUID in the code field, which can make it unclear for users in our customer portal to see which theme they are looking at.

Example use cases

1. As a merchandiser I want to give a push to the replenishment of all the T-Shirts in the Festival theme.

2. As a merchandiser I want to redistribute all the Back to School Shorts.

TECHNICAL INFORMATION

Authentication

Bearer token, information on page POST /Token

Headers

QueryParameters:

Body example:

{
  "themes": [
    {
      "themeId": "595b232e-abd8-4bcb-8a2d-e9f907a73015",
      "code": "B2S",
      "description": "Back to School"
    }
  ]
}

Additional information:

RESPONSE

StatusCodes:

200 = OK

401 = Unauthorized, which means an expired/missing/invalid token

400 = Bad request, see body of the response to check which validation errors have occured

500 = System error, see body of the response to check which error has occured or contact integration support

Body Example:

No body in the response