Stocks (Inventory)

Endpoints to create, update and read stocks.

Deprecated

List articles

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentationarrow-up-right. Search articles tenant-wide based on title or tenantArticleId

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
facilityRefstringOptional
searchTermstring · min: 1Optional
localestring · enumOptional

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

ISO 3166 conform country code and ISO 639-1 conform language code (de_DE, en_US, ch_FR, etc.)

Example: de_DEPossible values:
tenantArticleIdstringOptional
Responses
chevron-right
200

Articles search result according to the request. The result is in the body.

application/json

InventoryArticlePaginatedResult

totalnumberRequired
get
/api/articles

Get article forecast

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right. Get the forecast for a specific tenantArticleId

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tenantArticleIdstringRequired
Query parameters
periodstring · enumOptionalPossible values:
Responses
chevron-right
200

Forecast for the specified tenantArticleId. The result is in the body.

application/json

ArticleStockForecast

createdstring · date-timeRequired
cumulatednumberRequired
cumulatedLowerBoundsnumber[]Required
cumulatedUpperBoundsnumber[]Required
idstringRequired
lastModifiedstring · date-timeRequired
loadTimestring · date-timeRequired
lowerBoundsnumber[]Required
periodstring · enumRequiredPossible values:
pointnumberRequired
sourceDatestring · date-timeRequired
targetDatestring · date-timeRequired
tenantArticleIdstringRequired
upperBoundsnumber[]Required
get
/api/articles/{tenantArticleId}/forecasts

Get article stock distribution

get

Stock per Facility for a specific tenantArticleId, also includes the Tenant-Wide Summary

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
tenantArticleIdstring · min: 1Required
Query parameters
facilityNamestring · min: 1Optional
facilityIdsstring[]Optional
channelRefsstring[] · max: 50Optional

The channels to included under "channelAdjusted" in each summary and facility stock. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."

Responses
chevron-right
200

Stock distribution was loaded & you were allowed to access it. The result is in the body.

application/json

StockDistribution

tenantArticleIdstringRequired
get
/api/articles/{tenantArticleId}/stockdistribution
Deprecated

List facility stocks

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentationarrow-up-right. Use Inventory Stockarrow-up-right instead

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
facilityIdstringRequired
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
Responses
chevron-right
200

Stock was loaded and you were allowed to access it.

application/json

FacilityStock

availablenumberRequired
facilityRefstringRequired
idstringRequired
reservednumberRequired
tenantArticleIdstringRequired
valuenumberRequired
get
/api/facilities/{facilityId}/stocks
Deprecated

Update facility stocks

put

This part of the API is deprecated. For details please check the api-release-life-cycle documentationarrow-up-right. Use Inventory Stockarrow-up-right instead

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

FacilityStockBulkOperations

Responses
put
/api/facilities/{facilityId}/stocks
Deprecated

List stock summaries

get

This part of the API is deprecated. For details please check the api-release-life-cycle documentationarrow-up-right. This endpoint is deprecated. Please use /api/stocks/summaries instead.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional

The stockSummaries.article.tenantArticleId value should be used for pagination.

facilityRefsstring[]Optional
allowStalebooleanOptional
tenantArticleIdsstring[]Optional
maxPageSizenumber · min: 1 · max: 100Optional

Returns stock summaries using adaptive batching to reduce latency spikes, as a consequence response time will have a more consistent upper bound but page size may be reduced below the maximum - This overrides size argument.

channelRefsstring[] · max: 50Optional

The channels to included under "channelAdjusted" in the stock summary. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."

Responses
chevron-right
200

Stock summaries was loaded & you were allowed to access it. The result is in the body.

application/json

StockSummaries

totalnumberRequired
get
/api/inventory/stocks/summaries

List safety stocks

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
tenantArticleIdstringOptional
facilityRefstringOptional
Responses
chevron-right
200

Available Safety Stocks

application/json

SafetyStocksPaginatedResult

totalnumberRequired
get
/api/safetystocks

Update safety stocks

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

SafetyStockBulkOperations

Responses
put
/api/safetystocks

Delete safety stock

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

Result of the bulk operations

No content

delete
/api/safetystocks/{safetyStockId}

No content

List stocks

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
facilityRefstringOptional
tenantFacilityIdstringOptional
tenantArticleIdstring[] · max: 500Optional
locationRefstring[] · max: 500Optional
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
Responses
chevron-right
200

Stocks

application/json

StockPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

get
/api/stocks

Create stock

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

StockForCreation

availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityone ofOptional

Selector for the facility. Either a facility reference or a tenant facility ID must be provided.

or
facilityRefstringOptionalDeprecated

facility in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead

locationRefstringOptional

location on which the stock is placed

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

tenantFacilityIdstringOptionalDeprecated

tenantFacilityId in which the stock is located - fill with either facilityRef or tenantFacilityId - Deprecated: use facility object instead

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

valueinteger · int32Required
Responses
post
/api/stocks

Update stocks

put

Update and create many stocks at once

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

StocksForUpsert

Responses
chevron-right
200

Stock upsert result

application/json

StockUpsertOperationResult

statusstring · enumRequiredPossible values:
put
/api/stocks

Get stock

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

Stock

application/json

Stock

availablenumberRequired
availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

createdstring · date-timeRequired
customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

facility in which the stock is located

facilityWideReservednumberRequiredDeprecated
idstringRequired
lastModifiedstring · date-timeRequired
locationRefstringOptional

location on which the stock is placed

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

reservednumberRequired

amount of this stock reserved for customer orders

scannableCodesstring[]Optional

scannableCodes such as barcodes that identify this stock

scoresstring[]Optional

stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.

serializedPropertiesstringRequired

properties object serialized as JSON string, sorted alphabetically by key

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

valueinteger · int32Required
versionnumberRequired
get
/api/stocks/{stockId}

Update stock

put
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
stockIdstringRequired
Body
or
Responses
chevron-right
200

Stock

application/json

Stock

availablenumberRequired
availableUntilstring · date-timeOptional

defines until when a stock is included in the stock availability as available and used for routing

createdstring · date-timeRequired
customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

facilityRefstringRequired

facility in which the stock is located

facilityWideReservednumberRequiredDeprecated
idstringRequired
lastModifiedstring · date-timeRequired
locationRefstringOptional

location on which the stock is placed

receiptDatestring · date-timeOptional

date-time when stock has entered the system, defaults to the creation date

reservednumberRequired

amount of this stock reserved for customer orders

scannableCodesstring[]Optional

scannableCodes such as barcodes that identify this stock

scoresstring[]Optional

stock with a high score can used preferably over stock with a lower score in routing, depending on configuration. The score can represent different attributes of the stock like zone, storage location, expiry date or receipt date.

serializedPropertiesstringRequired

properties object serialized as JSON string, sorted alphabetically by key

tenantArticleIdstring · min: 1Required

tenantArticleId of the stock

tenantStockIdstringOptional

tenantStockId is an optional identifier for the stock in the tenant system.

valueinteger · int32Required
versionnumberRequired
put
/api/stocks/{stockId}

Delete stock

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

Stock was deleted.

No content

delete
/api/stocks/{stockId}

No content

Get stock recommendations

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentationarrow-up-right. Get the Storage Location recommendations for a specific Stock.

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

List of Storage Locations sorted by the stock sum ascending. The result is in the body.

application/json

StorageLocationRecommendation

stockCountnumberRequired
get
/api/stocks/{stockId}/locationrecommendations

Call stock action

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

StockAction

actionone ofOptional

Action to be performed on the stock. If a user has specific facility context limitations, only stocks located in the referenced facilities will be affected

or
or
or
or
Responses
chevron-right
200

Stock action result

application/json

StockActionResult

namestring · enumRequiredPossible values:
resultone ofRequired
or
or
post
/api/stocks/actions

List stocks (search)

post

Search for Stock

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

StockSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses
chevron-right
200

Your search result

application/json

StockPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

post
/api/stocks/search

List stock summaries

get

Get the accumulated Stock for each Article

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional

The stockSummaries.article.tenantArticleId value should be used for pagination.

facilityRefsstring[]Optional
allowStalebooleanOptional
tenantArticleIdsstring[]Optional
maxPageSizenumber · min: 1 · max: 100Optional

Returns stock summaries using adaptive batching to reduce latency spikes, as a consequence response time will have a more consistent upper bound but page size may be reduced below the maximum - This overrides size argument.

channelRefsstring[] · max: 50Optional

The channels to included under "channelAdjusted" in the stock summary. Provide up to 50 channelRefs, specify "UNALLOCATED for unallocated stock."

Responses
chevron-right
200

Stock summaries was loaded & you were allowed to access it. The result is in the body.

application/json

StockSummaries

totalnumberRequired
get
/api/stocks/summaries

Last updated