Stock

Summary

Stocks represent items in a facility and carry information on how much of a product is present as well as metadata and operational data. Stock is typically linked to a listing which holds information on the attributes of the item within the facility. Only stock-specific information, which differs from item to item, like best-before-dates or storage locations is tracked via stocks. Stocks can exist without listings and the other way around. However, we advise to always create listings for stocks so that stocks are assigned to the corresponding item and item information can be displayed in clients.

Description

Stock represents one or more items with the exact same attributes, e.g., items with the same best-before-date, lying on the same storage location. Two stocks can be merged, if all information on the respective stocks is identical, adding up their amounts. However, our systems still allow having two separate stocks with identical attributes.

The example below shows a listing with tenantArticleId "9999". As stocks for that item are firstly, distributed over two locations and secondly, have different attributes, three stocks were created.

Stock Properties

Attributes which are relevant for operational processes are handled via Stock Properties. A common example for properties are values such as expiry date or batch number.

Stock Receipt Date

Stocks have the attribute receiptDate: This represents the time and date, when a stock enters a facility. The information can be used for various purposes, e.g., to ensure that picking follows a first-in-first-out strategy. This ensures that the timestamp is set to the value when the stock is accepted in the Inbound process and not changed afterwards.

When the stock is set via API, it is the responsibility of the integration layer to provide the correct time point. If no receiptDate is provided, the platform defaults to the moment when the stock is created.

Stocks with amount 0

The fact that there is no stock left for an item in a facility can be represented in two ways:

1. Having no stock entities

2. Having stock entities with amount 0

A stock with amount 0 that is assigned to a storage location can be used to indicate that the product should always be stored there. This is, for example, helpful when using our Inventory App and/or our storage location recommendations. If stock is set to 0, our systems will remove the stock entity by default. This can be prevented by adding the trait KEEP_ON_ZERO to a storage location.

API documentation

Creating stock

Mandatory values when creating stock:

• facilityRef: facility in which the stock should be created

• tenantArticleId: the item that the stock belongs to

• value: quantity that should be created

Optional values when creating stock:

• locationRef: location on which the stock is placed on (when using our storage locations)

• properties: Attributes which are relevant for operational processes. See stock properties for more information

• receiptDate: Time and date when the stock entered the facility

• availableUntil: Defines until when a stock is included in the stock availability which is, e.g., used to communicate available stock to shop systems. See the corresponding listing configuration for more information.

• customAttributes: can be used to carry custom information that might be in interest to connectors or services outside of fulfillmenttools. For more information see custom attributes.

Create stock

POSThttps://%%HOST%%//api/stocks

Authorization

firebase

Body

application/json

facilityRef*string

tenantArticleId*string

value*integer (int32)

locationRefstring

propertiesall of

receiptDatestring (date-time)

Response

201401403

Stock was created.

Body

application/json

reserved*number

facilityWideReserved*number

available*number

id*string

version*number

facilityRef*string

tenantArticleId*string

tenantStockIdstring

created*string (date-time)

lastModified*string (date-time)

value*number

locationRefstring

traits*array of enum

scoresarray of string

scannableCodesarray of string

propertiesobject

serializedProperties*string

receiptDate*string (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "facilityRef": "text",
      "tenantArticleId": "text"
    }),
});
const data = await response.json();

Response

201401403

{
  "reserved": 0,
  "facilityWideReserved": 0,
  "available": 0,
  "id": "text",
  "version": 0,
  "facilityRef": "text",
  "tenantArticleId": "text",
  "tenantStockId": "text",
  "created": "2024-11-21T06:23:45.029Z",
  "lastModified": "2024-11-21T06:23:45.029Z",
  "value": 0,
  "locationRef": "text",
  "traits": [
    "PICKABLE"
  ],
  "scores": [
    "text"
  ],
  "scannableCodes": [
    "text"
  ],
  "serializedProperties": "text",
  "receiptDate": "2024-11-21T06:23:45.029Z"
}

Get all stocks

Get stocks

GEThttps://%%HOST%%//api/stocks

Authorization

firebase

Query parameters

Response

200401403

Stocks

Body

application/json

total*number

stocks*array of Stock (object)

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403

{
  "total": 0,
  "stocks": [
    {
      "reserved": 0,
      "facilityWideReserved": 0,
      "available": 0,
      "id": "text",
      "version": 0,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2024-11-21T06:23:45.029Z",
      "lastModified": "2024-11-21T06:23:45.029Z",
      "value": 0,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "serializedProperties": "text",
      "receiptDate": "2024-11-21T06:23:45.029Z"
    }
  ]
}

Updating stock

Each stock created in our system receives a unique ID. This ID must be specified when updating stock. Therefore, we advise to either temporarily store stock Ids or get all stocks before updating.

Update and create many stocks at once

PUThttps://%%HOST%%//api/stocks

Authorization

firebase

Body

application/json

stocks*array of one of

Response

200401403

Stock upsert result

Body

application/json

stock*Stock (object)

status*enum

UPDATEDCREATED

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "stocks": [
        {
          "facilityRef": "text",
          "tenantArticleId": "text"
        }
      ]
    }),
});
const data = await response.json();

Response

200401403

[
  {
    "stock": {
      "reserved": 0,
      "facilityWideReserved": 0,
      "available": 0,
      "id": "text",
      "version": 0,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2024-11-21T06:23:45.029Z",
      "lastModified": "2024-11-21T06:23:45.029Z",
      "value": 0,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "serializedProperties": "text",
      "receiptDate": "2024-11-21T06:23:45.029Z"
    },
    "status": "UPDATED"
  }
]

Deleting stock

Each stock created in our system receives a unique ID. This ID must be specified when deleting stock.

Delete stock

DELETEhttps://%%HOST%%//api/stocks/{stockId}

Authorization

firebase

Path parameters

stockId*string

Response

200401403

Stock was deleted.

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks/{stockId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

401403

[
  {
    "description": "Missing attributes were name, address, items",
    "requestVersion": 41,
    "summary": "One or more mandatory attributes were not provided.",
    "version": 42
  }
]

Deleting stock by product / location / id in batch

• For deleting all stocks for a product in a facility, use the DELETE_BY_PRODUCTS action

• For deleting all stocks on a storage location in a facility, use the DELETE_BY_LOCATIONS action

• For deleting multiple stocks in a facility in one call, use the DELETE_BY_IDS action

Perform stocks actions

POSThttps://%%HOST%%//api/stocks/actions

Authorization

firebase

Body

application/json

actionone of

StockDeleteByLocations (object)StockDeleteByProducts (object)StockDeleteByIds (object)StockMoveToLocation (object)

Response

200401403

Stock action result

Body

application/json

name*enum

DELETE_BY_LOCATIONSDELETE_BY_PRODUCTSDELETE_BY_IDSMOVE_TO_LOCATION

result*one of

StockDeleteActionResult (object)StockMoveToLocationActionResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401403

{
  "name": "DELETE_BY_LOCATIONS",
  "result": {
    "ids": [
      "text"
    ]
  }
}

Move stock to another location

For moving a stock from one location to another, specify the respective stockId as well as the toLocationRef to which the stock should be moved. When setting deleteFromStockIfZero to true, the stock on the start location is deleted when value reaches 0 after move action was completed. Attention: If deleteFromStockIfZero is set to true, the stock entity is deleted even when the KEEP_ON_ZERO trait is active on the respective location.

Perform stocks actions

POSThttps://%%HOST%%//api/stocks/actions

Authorization

firebase

Body

application/json

actionone of

StockDeleteByLocations (object)StockDeleteByProducts (object)StockDeleteByIds (object)StockMoveToLocation (object)

Response

200401403

Stock action result

Body

application/json

name*enum

DELETE_BY_LOCATIONSDELETE_BY_PRODUCTSDELETE_BY_IDSMOVE_TO_LOCATION

result*one of

StockDeleteActionResult (object)StockMoveToLocationActionResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://%%HOST%%//api/stocks/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200401403

{
  "name": "DELETE_BY_LOCATIONS",
  "result": {
    "ids": [
      "text"
    ]
  }
}