Channel inventory endpoints

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

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

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-03-02T21:57:16.324Z",
        "start": "2026-03-02T21:57:16.324Z"
      },
      "channelRef": "text",
      "created": "2026-03-02T21:57:16.324Z",
      "id": "text",
      "lastModified": "2026-03-02T21:57:16.324Z",
      "tenantArticleIds": [
        "text"
      ],
      "version": 1
    }
  ],
  "total": 1
}

List channel groups

get

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

Authorizations

BearerToken

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

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-03-02T21:57:16.324Z",
        "start": "2026-03-02T21:57:16.324Z"
      },
      "channelRef": "text",
      "created": "2026-03-02T21:57:16.324Z",
      "id": "text",
      "lastModified": "2026-03-02T21:57:16.324Z",
      "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

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

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-03-02T21:57:16.324Z",
    "start": "2026-03-02T21:57:16.324Z"
  },
  "tenantArticleIds": [
    "text"
  ]
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-02T21:57:16.324Z",
    "start": "2026-03-02T21:57:16.324Z"
  },
  "channelRef": "text",
  "created": "2026-03-02T21:57:16.324Z",
  "id": "text",
  "lastModified": "2026-03-02T21:57:16.324Z",
  "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

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

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

Update channel group

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle 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

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-03-02T21:57:16.324Z",
    "start": "2026-03-02T21:57:16.324Z"
  },
  "version": 1
}

{
  "active": true,
  "activePeriod": {
    "end": "2026-03-02T21:57:16.324Z",
    "start": "2026-03-02T21:57:16.324Z"
  },
  "channelRef": "text",
  "created": "2026-03-02T21:57:16.324Z",
  "id": "text",
  "lastModified": "2026-03-02T21:57:16.324Z",
  "tenantArticleIds": [
    "text"
  ],
  "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

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

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-03-02T21:57:16.324Z",
  "id": "text",
  "lastModified": "2026-03-02T21:57:16.324Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}

List availability channels

get

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

Authorizations

BearerToken

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

HTTPcURLJavaScriptPython

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

{
  "channels": [
    {
      "created": "2026-03-02T21:57:16.324Z",
      "id": "text",
      "lastModified": "2026-03-02T21:57:16.324Z",
      "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

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

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-03-02T21:57:16.324Z",
  "id": "text",
  "lastModified": "2026-03-02T21:57:16.324Z",
  "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

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

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

Update availability channel

put

This part of the API is in Alpha status. For details please check the api-release-life-cycle 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

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-03-02T21:57:16.324Z",
  "id": "text",
  "lastModified": "2026-03-02T21:57:16.324Z",
  "name": "text",
  "strategy": "REGULAR",
  "version": 1
}