NextChapter PIM API

Interaction with the NextChapter PIM API allows you to manage products and all related entities such as brands, categories, properties, and more.

To use the NextChapter PIM API, you need to obtain a valid security token (bearer), which expires in 1 hour.

NextChapter PIM API supports REST and JSON formats for resource representation.

Http Methods and Operations

We mostly use the GET, POST, PUT and DELETE verbs for various resources:

Create a new resource or updating the entire resource with POST.
Retrieve resources with GET.
Update a resource with PUT.
Delete a resource definitively with DELETE.

Within the Products endpoint we use PATCH for updating a resource.

Removing resources

NextChapter PIM has a delete flow in order to avoid unexpected information loss:

If you no longer need a resource, you can use soft delete operations (POST) so set the resource(s) as " soft deleted".
Once the resource is soft deleted, the PIM API allows to delete it permanently (DELETE).

TimeZones

Some endpoints require TimeZone handling to provide accurate and consistent data. Make sure to follow the guidelines below when interacting with these endpoints.

1. TimeZone Format

Ensure that you send and receive TimeZone information in a standard format such as the IANA Time Zone Database. For example, "Europe/Amsterdam".

2. TimeZone Header Parameter

To get for example for "createdOn" and "lastModifiedOn" the correct values in your time zone, you have to include a TimeZone parameter in the request. Use the x-timezone header with the value of the desired time zone.

If no data is included Date times field will be returned in UTC format.

Example:

GET /api/example?date=2023-01-01T12:00:00
Headers:
  x-timezone: Europe/Amsterdam