Availability

Introduction

Fulfillmenttools can act as the central source for stock information. It calculates and provides:

• Stock that is physically present in a facility (Stock on Hand)

• Stock that is available to be sold (Available on Stock)

• Stock that is available to be sold & picked in a store or warehouse (Available for Picking)

• Stock that is expected to arrive based on deliveries of goods, production, transfers from other facilities, etc. (Expected)

Stock information can be:

• queried via api/stocks/summaries or api/stockdistribution

• derived from the InventoryFacilityStockChangedWebHookEvent

• viewed in the Stock Overview in the Backoffice

As an alternative, you can directly consume and operate on our stocks, i.e., get all stock entities and calculate the availabilities that you need in your software.

Stock on Hand

Describes stock which is physically located in a facility. Stock that is, for example, still booked to the facility but is already in transit to another facility is not included.

Available on Stock

Available on stock describes stock which is available for selling (not been earmarked for other purposes). In our platform it refers to stock that is accessible, reduced by:

• stock that is reserved for orders

• safety stock, i.e., stock that is held back for offline sales

Available for Picking

Available for picking describes stock which is available (not been earmarked for other purposes), and also ready to be picked. In our platform it refers to all stock that is accessible and pickable, reduced by:

• stock that is reserved for orders

• safety stock, i.e., stock that is held back for offline sales

Expected Stock

Incoming stock that is expected to arrive or to be produced. Expected stock can be communicated via our inbound process.

API Documentation

Request sum of stocks over facilities per product

We recommend to use this endpoint, for example, for listing pages in online shops.

Get the accumulated Stock for each Article

GET/api/stocks/summaries

Query parameters

Response

200401403

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

Body

application/json

total*number

stockSummaries*array of StockSummary (object)

Request

JavaScriptCurl

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

Response

{
  "total": 0,
  "stockSummaries": [
    {
      "includedFacilityRefs": [
        "text"
      ],
      "article": {
        "tenantArticleId": "text",
        "title": "text",
        "imageUrl": "text"
      },
      "details": {
        "reserved": 0,
        "totalAmount": 0,
        "safetyStock": 0,
        "expectedStocks": [
          {
            "expectedStockRef": "text",
            "expectedDate": {
              "type": "ASAP",
              "value": "2024-04-27T22:48:40.486Z"
            },
            "quantity": {
              "unit": "text"
            },
            "inboundProcessRef": "text"
          }
        ],
        "byTrait": {
          "PICKABLE": 0,
          "ACCESSIBLE": 0
        },
        "availableForPicking": 0,
        "availableOnStock": 0,
        "stockOnHand": 0,
        "channelAdjusted": [
          {
            "channelRef": "text",
            "availableForPicking": 0,
            "availableOnStock": 0
          }
        ]
      }
    }
  ]
}

Request stocks per facility for a specific product

We recommend to use this endpoint, for example, for product detail pages in online shops.

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

GET/api/articles/{tenantArticleId}/stockdistribution

Path parameters

tenantArticleId*string

Query parameters

Response

200401403

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

Body

application/json

tenantArticleId*string

summary*StockSummaryDetails (object)

facilityStocks*array of FacilityStockDistribution (object)

Request

JavaScriptCurl

const response = await fetch('/api/articles/{tenantArticleId}/stockdistribution', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "tenantArticleId": "text",
  "summary": {
    "reserved": 0,
    "totalAmount": 0,
    "safetyStock": 0,
    "expectedStocks": [
      {
        "expectedStockRef": "text",
        "expectedDate": {
          "type": "ASAP",
          "value": "2024-04-27T22:48:40.486Z"
        },
        "quantity": {
          "unit": "text"
        },
        "inboundProcessRef": "text"
      }
    ],
    "byTrait": {
      "PICKABLE": 0,
      "ACCESSIBLE": 0
    },
    "availableForPicking": 0,
    "availableOnStock": 0,
    "stockOnHand": 0,
    "channelAdjusted": [
      {
        "channelRef": "text",
        "availableForPicking": 0,
        "availableOnStock": 0
      }
    ]
  },
  "facilityStocks": [
    {
      "reserved": 0,
      "totalAmount": 0,
      "safetyStock": 0,
      "expectedStocks": [
        {
          "expectedStockRef": "text",
          "expectedDate": {
            "type": "ASAP",
            "value": "2024-04-27T22:48:40.486Z"
          },
          "quantity": {
            "unit": "text"
          },
          "inboundProcessRef": "text"
        }
      ],
      "byTrait": {
        "PICKABLE": 0,
        "ACCESSIBLE": 0
      },
      "availableForPicking": 0,
      "availableOnStock": 0,
      "stockOnHand": 0,
      "channelAdjusted": [
        {
          "channelRef": "text",
          "availableForPicking": 0,
          "availableOnStock": 0
        }
      ],
      "facilityId": "text",
      "facilityName": "text",
      "facilityServiceTypes": [
        "SHIP_FROM_STORE"
      ],
      "facilityStatus": "ONLINE",
      "price": 0
    }
  ]
}

Request all stocks

Get stocks

GET/api/stocks

Query parameters

Response

200401403

Stocks

Body

application/json

total*number

stocks*array of Stock (object)

Request

JavaScriptCurl

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

Response

{
  "total": 0,
  "stocks": [
    {
      "reserved": 0,
      "facilityWideReserved": 0,
      "available": 0,
      "id": "text",
      "version": 0,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2024-04-27T22:48:40.486Z",
      "lastModified": "2024-04-27T22:48:40.486Z",
      "value": 0,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "serializedProperties": "text",
      "receiptDate": "2024-04-27T22:48:40.486Z"
    }
  ]
}

Update all stocks

We recommend to use this endpoint, for example, to perform an inventory synchronisation with your ERP.

Update and create many stocks at once

PUT/api/stocks

Body

application/json

stocks*array of one of

Please be sure to include each stock (by ID) only once, when updating. Otherwise the whole batch is rejected with an error.

Response

200401403

Stock upsert result

Body

application/json

stock*Stock (object)

status*enum

UPDATEDCREATED

Request

JavaScriptCurl

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

Response

[
  {
    "stock": {
      "reserved": 0,
      "facilityWideReserved": 0,
      "available": 0,
      "id": "text",
      "version": 0,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2024-04-27T22:48:40.486Z",
      "lastModified": "2024-04-27T22:48:40.486Z",
      "value": 0,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "serializedProperties": "text",
      "receiptDate": "2024-04-27T22:48:40.486Z"
    },
    "status": "UPDATED"
  }
]