fulfillmenttools
  • Welcome to the fulfillmenttools Platform Documentation
  • Getting Started
    • Setup your access to fulfillmenttools
    • Make your first API Calls
      • Add your first facility
      • Add your first listing
      • Place your first order
    • Core concepts & terminology
      • Order Flow
    • Postman Collection
    • Client SDKs
    • FAQ
  • Clients
    • Backoffice
      • First steps - Registration
      • Network view
        • Home
        • Orders
          • Unroutable orders
          • Pre-orders & Backorders
          • Order History
        • Inventory Management
          • Stock Overview
          • Channel Inventory
        • Facilities
        • Users
        • Returns
        • DOMS configuration
        • Settings
        • Analytics
          • DOMS Pages
          • Fulfillment Operations Pages
          • Inventory Pages
          • Downloads Page
      • Facility view
        • Home
        • Inbound
        • Tasks
        • Listings
        • Storage Locations
        • Facility
        • Users
    • Inventory app
      • Registration Inventory App
      • App sections
        • Inbound
        • Storage and relocation
    • Operations app
      • Android
        • Manual Registration
        • Android Enterprise Registration
        • Sections
          • Picking
            • Load Units (legacy)
            • Substitute items
            • Weighed or measured products
            • Scanning configuration
            • Picking Methods
              • Batch Picking
              • Multi Order Picking
          • Packing
          • Handover
          • Returns (legacy)
        • Printing
        • Notifications
      • Webapp
        • Packing
      • Overview features Android & Webapp
    • Technical requirements
      • Zebra Hardware Scanner Configuration
      • Honeywell Hardware Scanner Configuration
      • Supported barcodes for camera scanning
      • Requirements for fft applications
      • Zebra printer
    • Returns app
      • Handle unannounced returns
      • Handle announced returns
  • Products
    • Core Functionality
      • Process
        • External actions
      • Add and manage facilities
      • Notification Center
      • Checking on features
      • Tags and Stickers Concept
      • GDPR
      • Remote Configuration
      • Expiry
      • Target time
      • Time calculation for queries of future availabilities (LPS-calculation)
      • Interfacility Transfer
    • Carrier Management
      • Overview
        • Available Carriers
      • Concepts
        • Carrier Country Service Mapping (CCSM)
        • Non-delivery-days
        • Custom Carrier & Headless operation of Carriers
      • Providing needed data
    • Fulfillment Options
      • Fulfillability Check
      • Checkout Options
        • Available fulfillment options based on basket
        • Earliest possible delivery date
        • Available delivery dates within time-period
        • Availability for delivery date
      • Delivery Promise
    • Inventory Management
      • Configurations
      • Entities
        • Listing
        • Stock
          • Stock Properties
        • Storage Location
        • Zone
      • Global Inventory
        • Stock availability
        • Channel Inventory
        • Expected stock
        • Inbound Process
        • Reservations
        • Safety Stock
      • Inventory Control
        • Inventory Traits
        • Measurement Units
        • Outbound Inventory Tracking
        • Storage Location Recommendations
    • Order Fulfillment
      • Headless Order Fulfillment
      • Pick Jobs
      • Zone picking
      • Load Units
      • Custom Service
      • Handover Jobs
      • Add External Documents
      • Configurations
        • Picking Configuration
          • Picking methods
          • Short Pick Reasons
        • Packing Configuration
          • Packing Container Types
        • Print / Document Configuration
        • Tag Configurations
          • Parcel Tag Configuration
        • Handover Configuration
        • Operative Container Types
    • Order Routing
      • Entities
        • Ship-from-Store Orders
        • Click-and-Collect Orders
        • Locked Orders
        • Custom Services Orders
          • Simple Custom Service Order
          • Complex Custom Service Order
      • Fences
      • Ratings
      • Order Split
        • Order split - initial routing
        • Order split after shortpick
        • Item bundles
      • Reroute
      • Shape the routing with the DOMS Toolkit
      • Decision logs
    • Returns Management
      • Returns legacy
        • Available status
      • Returns 2.0
        • Return Reasons
        • Item Conditions
        • Integrating Returns with Events
    • Use Cases
      • Demand-Driven Replenishment
      • Expected stock in availability
      • Multi Order Picking
      • Interfacility transfer
      • Assigned Users
  • Connecting to fulfillmenttools
    • General Topics
      • Use external identity providers to authenticate to fulfillmenttools
        • Microsoft Entra ID / Azure Active Directory (AD)
      • Public Event Export
      • Available Regions
      • Backup Policies
    • GraphQL API
    • RESTful API
      • General Topics
        • API Release Life Cycle
        • Versioning
        • Authorization
        • Customization via Attributes
        • Update Guarantees
        • Rate Limits
        • Resource Timestamps
        • Pagination Interface
        • Localization
        • Custom Attributes
      • OpenAPI Specification
        • Swagger UI
        • OpenAPI 3.0 Spec
    • Eventing
      • Structure of an Event
      • Available Events
      • Tutorial
    • commercetools Connect
    • Integration Tutorial
      • Adding facilities
      • Adding listings to facilities
      • Configuring stocks
      • Carrier configuration
      • Placing orders
      • Checkout Options
      • Distributed Order Management System (Routing)
      • Local fulfillment configuration
  • Incident Reporting
    • How to report incidents in fulfillmenttools
    • How to define incident priorities
  • Release Notes
    • Release Summary – May 2024
    • Release Summary – June 2024
    • Release Summary – July 2024
    • Release Summary – August 2024
    • Release Summary – September 2024
    • Release Summary – October 2024
Powered by GitBook
On this page

Was this helpful?

  1. Products
  2. Inventory Management
  3. Entities

Stock

PreviousListingNextStock Properties

Last updated 5 months ago

Was this helpful?

This page is outdated. Please go to our new documentation under .

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

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

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:

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

Get all stocks

Updating stock

Deleting stock

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

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

Move stock to another location

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

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 and/or our . If stock is set to 0, our systems will remove the stock entity by default. This can be prevented by adding the trait to a storage location.

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

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

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 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 .

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 all stocks before updating.

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 is active on the respective location.

Stock Properties
Inventory App
storage location recommendations
KEEP_ON_ZERO
storage locations
stock properties
custom attributes
KEEP_ON_ZERO trait
get
https://docs.fulfillmenttools.com/documentation
listing configuration

Get stocks

get
Authorizations
Query parameters
facilityRefstringOptional
tenantArticleIdstring[] · max: 500Optional
locationRefstring[] · max: 500Optional
sizenumber · min: 1 · max: 100OptionalDefault: 25
startAfterIdstringOptional
Responses
200
Stocks
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
get
GET / HTTP/1.1
Host: %%HOST%%
Accept: */*
{
  "total": 1,
  "stocks": [
    {
      "reserved": 1,
      "facilityWideReserved": 1,
      "available": 1,
      "id": "text",
      "version": 1,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2025-05-12T10:37:36.518Z",
      "lastModified": "2025-05-12T10:37:36.518Z",
      "value": 1,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "serializedProperties": "text",
      "receiptDate": "2025-05-12T10:37:36.518Z"
    }
  ]
}

Delete stock

delete
Authorizations
Path parameters
stockIdstringRequired
Responses
200
Stock was deleted.
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
delete
DELETE / HTTP/1.1
Host: %%HOST%%
Accept: */*

No content

  • Summary
  • Description
  • Stock Properties
  • Stock Receipt Date
  • Stocks with amount 0
  • API documentation
  • Creating stock
  • POSTCreate stock
  • Get all stocks
  • GETGet stocks
  • Updating stock
  • PUTUpdate and create many stocks at once
  • Deleting stock
  • DELETEDelete stock
  • Deleting stock by product / location / id in batch
  • POSTPerform stocks actions
  • Move stock to another location
  • POSTPerform stocks actions

Create stock

post
Authorizations
Body
facilityRefstringRequired
tenantArticleIdstringRequired
valueinteger · int32Required
locationRefstringOptional
propertiesall ofOptional
receiptDatestring · date-timeOptional
Responses
201
Stock was created.
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
post
POST / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "facilityRef": "text",
  "tenantArticleId": "text",
  "value": 1,
  "locationRef": "text",
  "properties": {
    "expiry": "text",
    "receiptDate": "text"
  },
  "receiptDate": "2025-05-12T10:37:36.518Z"
}
{
  "reserved": 1,
  "facilityWideReserved": 1,
  "available": 1,
  "id": "text",
  "version": 1,
  "facilityRef": "text",
  "tenantArticleId": "text",
  "tenantStockId": "text",
  "created": "2025-05-12T10:37:36.518Z",
  "lastModified": "2025-05-12T10:37:36.518Z",
  "value": 1,
  "locationRef": "text",
  "traits": [
    "PICKABLE"
  ],
  "scores": [
    "text"
  ],
  "scannableCodes": [
    "text"
  ],
  "properties": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "serializedProperties": "text",
  "receiptDate": "2025-05-12T10:37:36.518Z"
}

Update and create many stocks at once

put
Authorizations
Body
Responses
200
Stock upsert result
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
put
PUT / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 184

{
  "stocks": [
    {
      "facilityRef": "text",
      "tenantArticleId": "text",
      "value": 1,
      "locationRef": "text",
      "properties": {
        "expiry": "text",
        "receiptDate": "text"
      },
      "receiptDate": "2025-05-12T10:37:36.518Z"
    }
  ]
}
[
  {
    "stock": {
      "reserved": 1,
      "facilityWideReserved": 1,
      "available": 1,
      "id": "text",
      "version": 1,
      "facilityRef": "text",
      "tenantArticleId": "text",
      "tenantStockId": "text",
      "created": "2025-05-12T10:37:36.518Z",
      "lastModified": "2025-05-12T10:37:36.518Z",
      "value": 1,
      "locationRef": "text",
      "traits": [
        "PICKABLE"
      ],
      "scores": [
        "text"
      ],
      "scannableCodes": [
        "text"
      ],
      "properties": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "serializedProperties": "text",
      "receiptDate": "2025-05-12T10:37:36.518Z"
    },
    "status": "UPDATED"
  }
]

Perform stocks actions

post
Authorizations
Body
actionone ofOptional
or
or
or
Responses
200
Stock action result
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
post
POST / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 65

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

Perform stocks actions

post
Authorizations
Body
actionone ofOptional
or
or
or
Responses
200
Stock action result
application/json
401
Your user is not allowed to operate against this API instance
application/json
403
Your user, although recognized, is not authorized to use this
application/json
post
POST / HTTP/1.1
Host: %%HOST%%
Content-Type: application/json
Accept: */*
Content-Length: 65

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