Channel inventory

More channel inventory API information can be found here: REST API documentation - Channel Availability

Channel inventory allows reserving stock for specific sales channels or other purposes. The below steps must be followed when introducing channel inventory:

1. Create availability channels

2. Create allocation groups

3. Create allocations for channels

Create a channel

A channel can be created by performing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.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 please refer to "Products – Channel inventory".

If the request was successful, a 200 CREATED response is received with a body like this:

{
    "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 are used to organize allocations in facilities for a specific article and channel.

A channel allocation group can be created by performing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/availabilitychannels/{availabilityChannelId}/groups

{
  "active": true,
  "activePeriod": {
    "end": "2025-08-01T15:00:00.000Z",
    "start": "2025-06-01T15:00:00.000Z"
  },
  "tenantArticleIds": [
    "12345"
  ]
}

If the request was successful, a HTTP 200 CREATED response is received with a body like this:

{
    "id": "a8768f84-3a50-4298-be36-e587989c7971",
    "active": true,
    "activePeriod": {
        "end": "2025-08-01T15:00:00.000Z",
        "start": "2025-06-01T15:00:00.000Z"
    },
    "channelRef": "e892b0b2-6a10-4d84-81d4-848dd4b78334",
    "created": "2025-01-01T15:00:00.000Z",
    "lastModified": "2025-01-01T15:00:00.000Z",
    "tenantArticleIds": [
        "12345"
    ],
    "version": 1
}

Create a channel allocation under a group

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

A channel allocation can be created by performing the following POST call with the JSON body:

POST https://{YOUR-TENANT-NAME}.fulfillmenttools.com/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations

{
  "facilityRef": "CGN_01",
  "initialStockQuantity": 100
}

If the request was successful, a HTTP 200 CREATED response is received with a body like this:

{
    "channelRef": "e892b0b2-6a10-4d84-81d4-848dd4b78334",
    "created": "2025-01-01T15:00:00.000Z",
    "facilityRef": "CGN_01",
    "groupRef": "a8768f84-3a50-4298-be36-e587989c7971",
    "id": "3e3412bf-9181-42e2-9300-b9f68dcc5f5c",
    "initialStockQuantity": 100,
    "lastModified": "2025-01-01T15:00:00.000Z",
    "version": 1
}