Stock 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 (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 (AOS)

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
expired stock (if defined)
stock that has reached its availableUntil value (if defined)

Available for Picking (AFP)

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
expired stock (if defined)
stock that has reached its availableUntil value (if defined)

Expected Stock

Incoming stock that is expected to arrive or to be produced. Expected stock can be communicated via the inbound process. After an inboundProcess with a purchaseOrder was created, our systems automatically create expected stock for the requested items. Expected stock is visible in the stock overview in the Backoffice. Once a purchase order was created, its expected stock can be considered in the shop availability. Go here for more information.

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

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

Body

stockSummaries*array of StockSummary (object)

total*number

Request

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

Response

{
  "stockSummaries": [
    {
      "article": {
        "imageUrl": "text",
        "tenantArticleId": "text",
        "title": "text"
      },
      "details": {
        "availableForPicking": 0,
        "availableOnStock": 0,
        "byTrait": {
          "ACCESSIBLE": 0,
          "PICKABLE": 0
        },
        "channelAdjusted": [
          {
            "availableForPicking": 0,
            "availableOnStock": 0,
            "channelRef": "text"
          }
        ],
        "reserved": 0,
        "safetyStock": 0,
        "stockOnHand": 0,
        "totalAmount": 0
      },
      "includedFacilityRefs": [
        "text"
      ]
    }
  ],
  "total": 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

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

Body

facilityStocks*array of FacilityStockDistribution (object)

summary*StockSummaryDetails (object)

tenantArticleId*string

Request

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

Response

{
  "facilityStocks": [
    {
      "availableForPicking": 0,
      "availableOnStock": 0,
      "byTrait": {
        "ACCESSIBLE": 0,
        "PICKABLE": 0
      },
      "channelAdjusted": [
        {
          "availableForPicking": 0,
          "availableOnStock": 0,
          "channelRef": "text"
        }
      ],
      "facilityId": "text",
      "facilityName": "text",
      "facilityServiceTypes": [
        "SHIP_FROM_STORE"
      ],
      "facilityStatus": "ONLINE",
      "price": 0,
      "reserved": 0,
      "safetyStock": 0,
      "stockOnHand": 0,
      "totalAmount": 0
    }
  ],
  "summary": {
    "availableForPicking": 0,
    "availableOnStock": 0,
    "byTrait": {
      "ACCESSIBLE": 0,
      "PICKABLE": 0
    },
    "channelAdjusted": [
      {
        "availableForPicking": 0,
        "availableOnStock": 0,
        "channelRef": "text"
      }
    ],
    "reserved": 0,
    "safetyStock": 0,
    "stockOnHand": 0,
    "totalAmount": 0
  },
  "tenantArticleId": "text"
}

Request all stocks

Get stocks

GET/api/stocks

Query parameters

Response

Stocks

Body

stocks*array of Stock (object)

total*number

Request

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

Response

{
  "stocks": [
    {
      "available": 0,
      "availableUntil": "2024-11-21T06:28:46.734Z",
      "created": "2024-11-21T06:28:46.734Z",
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2024-11-21T06:28:46.734Z",
      "locationRef": "text",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2024-11-21T06:28:46.734Z",
      "reserved": 0,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        "text"
      ],
      "serializedProperties": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "traitConfig": [
        {
          "enabled": false,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "version": 0
    }
  ],
  "total": 0
}

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

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

Stock upsert result

Body

status*enum

UPDATEDCREATED

stock*Stock (object)

Request

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

[
  {
    "status": "UPDATED",
    "stock": {
      "available": 0,
      "availableUntil": "2024-11-21T06:28:46.734Z",
      "created": "2024-11-21T06:28:46.734Z",
      "facilityRef": "text",
      "id": "text",
      "lastModified": "2024-11-21T06:28:46.734Z",
      "locationRef": "text",
      "properties": {
        "expiry": "text"
      },
      "receiptDate": "2024-11-21T06:28:46.734Z",
      "reserved": 0,
      "scannableCodes": [
        "text"
      ],
      "scores": [
        "text"
      ],
      "serializedProperties": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "traitConfig": [
        {
          "enabled": false,
          "trait": "text"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "version": 0
    }
  }
]

PreviousGlobal Inventory NextChannel Inventory

Last updated 3 months ago