Channel Availability (Inventory)

Endpoints to configure and get channel availability.

Deprecated

List availability channels

get

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

searchTermstringOptional

searchTermExactstringOptional

strategystring · enumOptionalPossible values:

sizenumber · min: 1 · max: 100OptionalDefault: 25Example: 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 endpoint

application/json

get/api/availabilitychannels

HTTPcURLJavaScriptPython

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

{
  "channels": [
    {
      "created": "2026-07-22T22:02:00.263Z",
      "id": "text",
      "lastModified": "2026-07-22T22:02:00.263Z",
      "name": "text",
      "strategy": "REGULAR",
      "version": 1
    }
  ],
  "total": 1
}

Deprecated

Create availability channel

post

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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 endpoint

application/json

post/api/availabilitychannels

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
  "id": "text",
  "lastModified": "2026-07-22T22:02:00.263Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Deprecated

Get availability channel

get

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

get/api/availabilitychannels/{availabilityChannelId}

HTTPcURLJavaScriptPython

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

{
  "created": "2026-07-22T22:02:00.263Z",
  "id": "text",
  "lastModified": "2026-07-22T22:02:00.263Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Deprecated

Update availability channel

put

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Body

application/json

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 endpoint

application/json

404

The requested entity was not found

application/json

put/api/availabilitychannels/{availabilityChannelId}

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
  "id": "text",
  "lastModified": "2026-07-22T22:02:00.263Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

Deprecated

Delete availability channel

delete

This part of the API is deprecated. For details, see the API release lifecycle documentation. Delete an existing Availability Channel. PLEASE NOTE: This will also delete all groups and allocations under this channel.

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

delete/api/availabilitychannels/{availabilityChannelId}

HTTPcURLJavaScriptPython

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

No content

Deprecated

List channel groups

get

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Query parameters

searchTermstringOptional

searchTermExactstringOptional

sizenumber · min: 1 · max: 100OptionalDefault: 25Example: 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 endpoint

application/json

404

The requested entity was not found

application/json

get/api/availabilitychannels/{availabilityChannelId}/groups

HTTPcURLJavaScriptPython

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-06-17T12:00:00.000Z",
        "start": "2026-06-17T12:00:00.000Z"
      },
      "channelRef": "text",
      "created": "2026-07-22T22:02:00.263Z",
      "id": "text",
      "lastModified": "2026-07-22T22:02:00.263Z",
      "tenantArticleIds": [
        "text"
      ],
      "version": 1
    }
  ],
  "total": 1
}

Deprecated

Create channel group

post

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

Body

application/json

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 endpoint

application/json

404

The requested entity was not found

application/json

post/api/availabilitychannels/{availabilityChannelId}/groups

HTTPcURLJavaScriptPython

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-06-17T12:00:00.000Z",
    "start": "2026-06-17T12:00:00.000Z"
  },
  "tenantArticleIds": [
    "text"
  ]
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-06-17T12:00:00.000Z",
    "start": "2026-06-17T12:00:00.000Z"
  },
  "channelRef": "text",
  "created": "2026-07-22T22:02:00.263Z",
  "id": "text",
  "lastModified": "2026-07-22T22:02:00.263Z",
  "tenantArticleIds": [
    "text"
  ],
  "version": 1
}

Deprecated

Get channel group

get

This part of the API is deprecated. For details, see the API release lifecycle documentation. Get Groups under Channel by its ID

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-06-17T12:00:00.000Z",
        "start": "2026-06-17T12:00:00.000Z"
      },
      "channelRef": "text",
      "created": "2026-07-22T22:02:00.263Z",
      "id": "text",
      "lastModified": "2026-07-22T22:02:00.263Z",
      "tenantArticleIds": [
        "text"
      ],
      "version": 1
    }
  ],
  "total": 1
}

Deprecated

Update channel group

put

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

availabilityChannelIdstringRequired

groupIdstringRequired

Body

application/json

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-06-17T12:00:00.000Z",
    "start": "2026-06-17T12:00:00.000Z"
  },
  "version": 1
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-06-17T12:00:00.000Z",
    "start": "2026-06-17T12:00:00.000Z"
  },
  "channelRef": "text",
  "created": "2026-07-22T22:02:00.263Z",
  "id": "text",
  "lastModified": "2026-07-22T22:02:00.263Z",
  "tenantArticleIds": [
    "text"
  ],
  "version": 1
}

Deprecated

Delete channel group

delete

This part of the API is deprecated. For details, see the API release lifecycle documentation. Delete an existing Group and all its allocations under Channel

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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

No content

Deprecated

List group allocations

get

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

availabilityChannelIdstringRequired

Query parameters

searchTermstringOptional

searchTermExactstringOptional

sizenumber · min: 1 · max: 100OptionalDefault: 25Example: 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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
      "id": "text",
      "lastModified": "2026-07-22T22:02:00.263Z",
      "name": "text",
      "strategy": "REGULAR",
      "version": 1
    }
  ],
  "total": 1
}

Deprecated

Create group allocation

post

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

availabilityChannelIdstringRequired

Body

application/json

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-07-22T22:02:00.263Z",
  "version": 1
}

Deprecated

List group allocations

get

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-07-22T22:02:00.263Z",
  "version": 1
}

Deprecated

Update group allocation

put

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

allocationIdstringRequired

availabilityChannelIdstringRequired

Body

application/json

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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-07-22T22:02:00.263Z",
  "facilityRef": "text",
  "groupRef": "text",
  "id": "text",
  "initialStockQuantity": 1,
  "lastModified": "2026-07-22T22:02:00.263Z",
  "version": 1
}

Deprecated

Delete group allocation

delete

This part of the API is deprecated. For details, see the API release lifecycle documentation.

Authorizations

BearerToken

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 endpoint

application/json

404

The requested entity was not found

application/json

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

HTTPcURLJavaScriptPython

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