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 documentationarrow-up-right.

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
chevron-right
200

Available Availability Channels

application/json

AvailabilityChannelPaginatedResult

totalnumberRequired
get
/api/availabilitychannels

Create availability channel

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

AvailabilityChannelForCreation

namestringRequired
strategystring · enumRequiredPossible values:
Responses
chevron-right
200

The created Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired
idstringRequired
lastModifiedstring · date-timeRequired
namestringRequired
strategystring · enumRequiredPossible values:
versionnumberRequired
post
/api/availabilitychannels

Get availability channel

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
availabilityChannelIdstringRequired
Responses
chevron-right
200

The Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired
idstringRequired
lastModifiedstring · date-timeRequired
namestringRequired
strategystring · enumRequiredPossible values:
versionnumberRequired
get
/api/availabilitychannels/{availabilityChannelId}

Update availability channel

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
availabilityChannelIdstringRequired
Body

AvailabilityChannelForReplacement

namestringRequired
strategystring · enumRequiredPossible values:
versionnumberRequired
Responses
chevron-right
200

The replaced Availability Channel

application/json

AvailabilityChannel

createdstring · date-timeRequired
idstringRequired
lastModifiedstring · date-timeRequired
namestringRequired
strategystring · enumRequiredPossible values:
versionnumberRequired
put
/api/availabilitychannels/{availabilityChannelId}

Delete availability channel

delete

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

The channel has been deleted

No content

delete
/api/availabilitychannels/{availabilityChannelId}

No content

List channel groups

get

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

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
chevron-right
200

Available Groups

application/json

AvailabilityAllocationGroupPaginatedResult

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

Create channel group

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
availabilityChannelIdstringRequired
Body

AvailabilityAllocationGroupForCreationUnderChannel

activebooleanRequired
tenantArticleIdsstring[] · max: 1Required
Responses
chevron-right
200

The created Group

application/json

AvailabilityAllocationGroup

activebooleanRequired
channelRefstringRequired
createdstring · date-timeRequired
idstringRequired
lastModifiedstring · date-timeRequired
tenantArticleIdsstring[] · max: 1Required
versionnumberRequired
post
/api/availabilitychannels/{availabilityChannelId}/groups

Get channel group

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
availabilityChannelIdstringRequired
groupIdstringRequired
Responses
chevron-right
200

The Group

application/json

AvailabilityAllocationGroupPaginatedResult

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

Update channel group

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
availabilityChannelIdstringRequired
groupIdstringRequired
Body

AvailabilityAllocationGroupForReplacement

activebooleanRequired
versionnumberRequired
Responses
chevron-right
200

The replaced Group

application/json

AvailabilityAllocationGroup

activebooleanRequired
channelRefstringRequired
createdstring · date-timeRequired
idstringRequired
lastModifiedstring · date-timeRequired
tenantArticleIdsstring[] · max: 1Required
versionnumberRequired
put
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}

Delete channel group

delete

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

The Group has been deleted.

No content

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

No content

List group allocations

get

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

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
chevron-right
200

Available Allocations

application/json

AvailabilityAllocationPaginatedResult

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

Create group allocation

post

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
availabilityChannelIdstringRequired
Body

AvailabilityAllocationForCreationUnderGroup

facilityRefstringRequired
initialStockQuantitynumberRequired
Responses
chevron-right
200

The created Allocation

application/json

AvailabilityAllocation

channelRefstringRequired
createdstring · date-timeRequired
facilityRefstringRequired
groupRefstringRequired
idstringRequired
initialStockQuantitynumberRequired
lastModifiedstring · date-timeRequired
versionnumberRequired
post
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations

List group allocations

get

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
allocationIdstringRequired
availabilityChannelIdstringRequired
Responses
chevron-right
200

The Allocation

application/json

AvailabilityAllocation

channelRefstringRequired
createdstring · date-timeRequired
facilityRefstringRequired
groupRefstringRequired
idstringRequired
initialStockQuantitynumberRequired
lastModifiedstring · date-timeRequired
versionnumberRequired
get
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}

Update group allocation

put

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
groupIdstringRequired
allocationIdstringRequired
availabilityChannelIdstringRequired
Body

AvailabilityAllocationForReplacement

groupIdstringOptional
initialStockQuantitynumberRequired
versionnumberRequired
Responses
chevron-right
200

The replaced Allocation

application/json

AvailabilityAllocation

channelRefstringRequired
createdstring · date-timeRequired
facilityRefstringRequired
groupRefstringRequired
idstringRequired
initialStockQuantitynumberRequired
lastModifiedstring · date-timeRequired
versionnumberRequired
put
/api/availabilitychannels/{availabilityChannelId}/groups/{groupId}/allocations/{allocationId}

Delete group allocation

delete

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

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
allocationIdstringRequired
groupIdstringRequired
availabilityChannelIdstringRequired
Responses
chevron-right
200

The Allocation has been deleted

No content

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

No content

Last updated