Channel Availability (Inventory)

Endpoints to configure and get channel availability.

List availability channels

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTermstringOptional

searchTermExactstringOptional

strategystring · enumOptionalPossible values:

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

Responses

200

Available Availability Channels

application/json

AvailabilityChannelPaginatedResult

totalnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

get

/api/availabilitychannels

GET /api/availabilitychannels HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "channels": [
    {
      "created": "2026-03-13T17:17:46.876Z",
      "id": "text",
      "lastModified": "2026-03-13T17:17:46.876Z",
      "name": "text",
      "strategy": "REGULAR",
      "version": 1
    }
  ],
  "total": 1
}

Create availability channel

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

AvailabilityChannelForCreation

namestringRequired

strategystring · enumRequiredPossible values:

Responses

200

The created Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired

idstringRequired

lastModifiedstring · date-timeRequired

namestringRequired

strategystring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

post

/api/availabilitychannels

POST /api/availabilitychannels HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "text",
  "strategy": "REGULAR"
}

{
  "created": "2026-03-13T17:17:46.876Z",
  "id": "text",
  "lastModified": "2026-03-13T17:17:46.876Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Get availability channel

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Responses

200

The Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired

idstringRequired

lastModifiedstring · date-timeRequired

namestringRequired

strategystring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/availabilitychannels/{availabilityChannelId}

GET /api/availabilitychannels/{availabilityChannelId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "created": "2026-03-13T17:17:46.876Z",
  "id": "text",
  "lastModified": "2026-03-13T17:17:46.876Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Update availability channel

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Body

AvailabilityChannelForReplacement

namestringRequired

strategystring · enumRequiredPossible values:

versionnumberRequired

Responses

200

The replaced Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired

idstringRequired

lastModifiedstring · date-timeRequired

namestringRequired

strategystring · enumRequiredPossible values:

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

put

/api/availabilitychannels/{availabilityChannelId}

PUT /api/availabilitychannels/{availabilityChannelId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

{
  "created": "2026-03-13T17:17:46.876Z",
  "id": "text",
  "lastModified": "2026-03-13T17:17:46.876Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Delete availability channel

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Delete an existing Availability Channel. PLEASE NOTE: This will also delete all groups and allocations under this channel.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Responses

200

The channel has been deleted

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/availabilitychannels/{availabilityChannelId}

DELETE /api/availabilitychannels/{availabilityChannelId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List channel groups

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Query parameters

searchTermstringOptional

searchTermExactstringOptional

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

Responses

200

Available Groups

application/json

AvailabilityAllocationGroupPaginatedResult

totalnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/availabilitychannels/{availabilityChannelId}/groups

GET /api/availabilitychannels/{availabilityChannelId}/groups HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "groups": [
    {
      "active": true,
      "activePeriod": {
        "end": "2026-03-13T17:17:46.876Z",
        "start": "2026-03-13T17:17:46.876Z"
      },
      "channelRef": "text",
      "created": "2026-03-13T17:17:46.876Z",
      "id": "text",
      "lastModified": "2026-03-13T17:17:46.876Z",
      "tenantArticleIds": [
        "text"
      ],
      "version": 1
    }
  ],
  "total": 1
}

Create channel group

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Body

AvailabilityAllocationGroupForCreationUnderChannel

activebooleanRequired

tenantArticleIdsstring[] · max: 1Required

Responses

200

The created Group

application/json

AvailabilityAllocationGroup

activebooleanRequired

channelRefstringRequired

createdstring · date-timeRequired

idstringRequired

lastModifiedstring · date-timeRequired

tenantArticleIdsstring[] · max: 1Required

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

post

/api/availabilitychannels/{availabilityChannelId}/groups

POST /api/availabilitychannels/{availabilityChannelId}/groups HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 128

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-13T17:17:46.876Z",
    "start": "2026-03-13T17:17:46.876Z"
  },
  "tenantArticleIds": [
    "text"
  ]
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-13T17:17:46.876Z",
    "start": "2026-03-13T17:17:46.876Z"
  },
  "channelRef": "text",
  "created": "2026-03-13T17:17:46.876Z",
  "id": "text",
  "lastModified": "2026-03-13T17:17:46.876Z",
  "tenantArticleIds": [
    "text"
  ],
  "version": 1
}

Get channel group

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get Groups under Channel by its ID

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

groupIdstringRequired

Responses

200

The Group

application/json

AvailabilityAllocationGroupPaginatedResult

totalnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}

GET /api/availabilitychannels/{availabilityChannelId}/groups/{groupId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "groups": [
    {
      "active": true,
      "activePeriod": {
        "end": "2026-03-13T17:17:46.876Z",
        "start": "2026-03-13T17:17:46.876Z"
      },
      "channelRef": "text",
      "created": "2026-03-13T17:17:46.876Z",
      "id": "text",
      "lastModified": "2026-03-13T17:17:46.876Z",
      "tenantArticleIds": [
        "text"
      ],
      "version": 1
    }
  ],
  "total": 1
}

Update channel group

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

groupIdstringRequired

Body

AvailabilityAllocationGroupForReplacement

activebooleanRequired

versionnumberRequired

Responses

200

The replaced Group

application/json

AvailabilityAllocationGroup

activebooleanRequired

channelRefstringRequired

createdstring · date-timeRequired

idstringRequired

lastModifiedstring · date-timeRequired

tenantArticleIdsstring[] · max: 1Required

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

put

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}

PUT /api/availabilitychannels/{availabilityChannelId}/groups/{groupId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-13T17:17:46.876Z",
    "start": "2026-03-13T17:17:46.876Z"
  },
  "version": 1
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-13T17:17:46.876Z",
    "start": "2026-03-13T17:17:46.876Z"
  },
  "channelRef": "text",
  "created": "2026-03-13T17:17:46.876Z",
  "id": "text",
  "lastModified": "2026-03-13T17:17:46.876Z",
  "tenantArticleIds": [
    "text"
  ],
  "version": 1
}

Delete channel group

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Delete an existing Group and all its allocations under Channel

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

availabilityChannelIdstringRequired

Responses

200

The Group has been deleted.

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}

DELETE /api/availabilitychannels/{availabilityChannelId}/groups/{groupId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

List group allocations

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

availabilityChannelIdstringRequired

Query parameters

searchTermstringOptional

searchTermExactstringOptional

sizenumber · min: 1 · max: 100OptionalDefault: 25

startAfterIdstringOptional

Responses

200

Available Allocations

application/json

AvailabilityAllocationPaginatedResult

totalnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations

GET /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "allocations": [
    {
      "created": "2026-03-13T17:17:46.876Z",
      "id": "text",
      "lastModified": "2026-03-13T17:17:46.876Z",
      "name": "text",
      "strategy": "REGULAR",
      "version": 1
    }
  ],
  "total": 1
}

Create group allocation

post

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

availabilityChannelIdstringRequired

Body

AvailabilityAllocationForCreationUnderGroup

facilityRefstringRequired

initialStockQuantitynumberRequired

Responses

200

The created Allocation

application/json

AvailabilityAllocation

channelRefstringRequired

createdstring · date-timeRequired

facilityRefstringRequired

groupRefstringRequired

idstringRequired

initialStockQuantitynumberRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

post

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations

POST /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "facilityRef": "text",
  "initialStockQuantity": 1
}

{
  "channelRef": "text",
  "created": "2026-03-13T17:17:46.876Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-03-13T17:17:46.876Z",
  "version": 1
}

List group allocations

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

allocationIdstringRequired

availabilityChannelIdstringRequired

Responses

200

The Allocation

application/json

AvailabilityAllocation

channelRefstringRequired

createdstring · date-timeRequired

facilityRefstringRequired

groupRefstringRequired

idstringRequired

initialStockQuantitynumberRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

get

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}

GET /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "channelRef": "text",
  "created": "2026-03-13T17:17:46.876Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-03-13T17:17:46.876Z",
  "version": 1
}

Update group allocation

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

allocationIdstringRequired

availabilityChannelIdstringRequired

Body

AvailabilityAllocationForReplacement

groupIdstringOptional

initialStockQuantitynumberRequired

versionnumberRequired

Responses

200

The replaced Allocation

application/json

AvailabilityAllocation

channelRefstringRequired

createdstring · date-timeRequired

facilityRefstringRequired

groupRefstringRequired

idstringRequired

initialStockQuantitynumberRequired

lastModifiedstring · date-timeRequired

versionnumberRequired

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

put

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}

PUT /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "groupId": "text",
  "initialStockQuantity": 1,
  "version": 1
}

{
  "channelRef": "text",
  "created": "2026-03-13T17:17:46.876Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-03-13T17:17:46.876Z",
  "version": 1
}

Delete group allocation

delete

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

allocationIdstringRequired

groupIdstringRequired

availabilityChannelIdstringRequired

Responses

200

The Allocation has been deleted

No content

401

Your user is not allowed to operate against this API instance

application/json

403

Your user, although recognized, is not authorized to use this

application/json

404

The requested entity was not found

application/json

delete

/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}

DELETE /api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Last updated 3 hours ago

hashtagList availability channels

hashtagCreate availability channel

hashtagGet availability channel

hashtagUpdate availability channel

hashtagDelete availability channel

hashtagList channel groups

hashtagCreate channel group

hashtagGet channel group

hashtagUpdate channel group

hashtagDelete channel group

hashtagList group allocations

hashtagCreate group allocation

hashtagList group allocations

hashtagUpdate group allocation

hashtagDelete group allocation

List availability channels

Create availability channel

Get availability channel

Update availability channel

Delete availability channel

List channel groups

Create channel group

Get channel group

Update channel group

Delete channel group

List group allocations

Create group allocation

List group allocations

Update group allocation

Delete group allocation