API documentationIncident ManagementFeedback
Edit

Channel inventory

Additional details are available in the Channel Availability API documentation.

Channel inventory allows reserving stock for specific sales channels or other purposes. Introducing channel inventory involves the following steps:

  1. Create a channel

  2. Create an allocation group under a channel

  3. Create a channel allocation under a group

Create a channel

To create a channel, send a POST request to the following endpoint with a JSON body:

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/availabilitychannels
{
  "name": "CHANNEL_NAME",
  "strategy": "REGULAR"
}

Depending on the priority of the sales channel, different strategies can be defined for stock reduction. For more information, refer to "Products – Channel inventory".

A successful request returns a 200 CREATED response with a body similar to the following example:

{
    "created": "2025-01-01T15:00:00.000Z",
    "id": "e892b0b2-6a10-4d84-81d4-848dd4b78334",
    "lastModified": "2025-01-01T15:00:00.000Z",
    "name": "CHANNEL_NAME",
    "strategy": "REGULAR",
    "version": 1
}

Create an allocation group under a channel

Each allocation must belong to a group. Groups organize allocations in facilities for a specific article and channel.

To create a channel allocation group, send a POST request to the following endpoint with a JSON body:

A successful request returns a 200 CREATED response with a body similar to the following example:

Create a channel allocation under a group

The core functionality of channels is implemented through availabilityAllocation entities. These entities link channels to specific products, identified by tenantArticleIds, and assign a predetermined quantity of stock to each channel.

To create a channel allocation, send a POST request to the following endpoint with a JSON body:

A successful request returns a 200 CREATED response with a body similar to the following example:

Last updated