Measurement Units

Define what each element of a stock represents.

This page is outdated. Please go to our new documentation under https://docs.fulfillmenttools.com/documentation.

In the fulfillmenttools platform each product (identified by one tenantArticleId in a facility) is tracked in one unit. The meaning of a unit is completely arbitrary but will commonly represent a physical unit like "g" or "kg" or for countable goods something like "pieces" or "pcs". Since each product is kept in just one measurement unit, operations like adding or moving stock do not need to validate or convert units between stocks.

Defining measurement unit keys for a listing

Units can be defined in the measurementUnitKey in the Iisting. The key that is defined will be displayed in our clients, e.g., during picking if no measurementUnit is defined for the key. It is not required to define units for products. When no unit is set in the listing, no validation will take place and our clients will default to a localized version of "pieces".

Both a missing "measurementUnitKey" field and "measurementUnitKey: null" are treated as no unit.

If you want to track one product in different units (for example as bulk by weight and also by prepackaged quantity) please create two Listings with different tenantArticleIds: "xyz-123-bulk" and "xyz-123-packaged". Any such setup should reflect the reality of the goods handling in your warehouse / facility.

Create or Update listings of a facility with the given ID

put

Authorizations

Path parameters

facilityIdstringrequired

ID of facility you want to get its listing

Body

listingsall of[] · min: 1 · max: 500required

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://%%HOST%%//api/facilities/{facilityId}/listings' \
  --header 'Content-Type: application/json' \
  --data '{
    "listings": [
      {
        "attributes": [
          {
            "category": "descriptive",
            "key": "%%subtitle%%",
            "priority": 100,
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "price": 1200,
        "stockinformation": {
          "reserved": 24,
          "stock": 42
        },
        "tenantArticleId": "4711",
        "title": "Adidas Superstar",
        "partialStocks": [
          {
            "tenantPartialStockId": "text",
            "stockinformation": {
              "reserved": 24,
              "stock": 42
            },
            "scores": [
              {
                "scoreType": "RATING",
                "scoreName": "ZONE",
                "scoreValue": 1
              }
            ],
            "location": {
              "locationRef": "text",
              "scannableCodes": [
                "text"
              ]
            }
          }
        ],
        "weight": 1,
        "scanningRule": {
          "values": []
        },
        "scannableCodes": [
          "text"
        ],
        "outOfStockBehaviour": "BACKORDER",
        "availabilityTimeframe": {
          "start": "2020-02-03T08:45:50.525Z"
        },
        "tags": [],
        "measurementUnitKey": "liter",
        "stockProperties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "inputType": "DATE",
            "required": true,
            "defaultValue": "text"
          }
        },
        "legal": {
          "hsCode": "text"
        }
      }
    ]
  }'

200

401

403

404

200

No body

Facility listing was found & you were allowed to access it.

Update a listing with the given ID of a facility with the given ID

patch

Authorizations

Path parameters

facilityIdstringrequired

ID of facility you want to patch a listing of

tenantArticleIdstringrequired

tenant ID of the articles listing you want to patch

Body

actionsall of[] · min: 1required

versioninteger · int64required

The version of the document to be used in optimistic locking mechanisms.

Example: 42

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://%%HOST%%//api/facilities/{facilityId}/listings/{tenantArticleId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "actions": [
      {
        "action": "ModifyListing",
        "attributes": [
          {
            "category": "descriptive",
            "key": "%%subtitle%%",
            "priority": 100,
            "value": "585er Gold"
          }
        ],
        "imageUrl": "text",
        "price": 1200,
        "status": "ACTIVE",
        "stockinformation": {
          "reserved": 24,
          "stock": 42
        },
        "subtitle": "44 2/3",
        "title": "Adidas Superstar",
        "tags": [],
        "scanningRule": {
          "values": []
        },
        "scannableCodes": [
          "text"
        ],
        "weight": 1,
        "outOfStockBehaviour": "BACKORDER",
        "availabilityTimeframe": {
          "start": "2020-02-03T08:45:50.525Z"
        },
        "measurementUnitKey": "kg",
        "stockProperties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "inputType": "DATE",
            "required": true,
            "defaultValue": "text"
          }
        },
        "legal": {
          "hsCode": "text"
        }
      }
    ],
    "version": 42
  }'

200

400

401

403

404

409

200

[
  {
    "attributes": [
      {
        "category": "descriptive",
        "key": "%%subtitle%%",
        "priority": 100,
        "value": "585er Gold"
      }
    ],
    "imageUrl": "text",
    "price": 1200,
    "stockinformation": {
      "reserved": 24,
      "stock": 42,
      "available": 24
    },
    "tenantArticleId": "4711",
    "title": "Adidas Superstar",
    "partialStocks": [
      {
        "tenantPartialStockId": "text",
        "stockinformation": {
          "reserved": 24,
          "stock": 42
        },
        "scores": [
          {
            "scoreType": "RATING",
            "scoreName": "ZONE",
            "scoreValue": 1
          }
        ],
        "location": {
          "locationRef": "text",
          "scannableCodes": [
            "text"
          ]
        }
      }
    ],
    "weight": 1,
    "scanningRule": {
      "values": []
    },
    "scannableCodes": [
      "text"
    ],
    "outOfStockBehaviour": "BACKORDER",
    "availabilityTimeframe": {
      "start": "2020-02-03T08:45:50.525Z"
    },
    "tags": [],
    "measurementUnitKey": "liter",
    "stockProperties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "inputType": "DATE",
        "required": true,
        "defaultValue": "text"
      }
    },
    "legal": {
      "hsCode": "text"
    },
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z",
    "version": 42,
    "facilityId": "4711",
    "id": "fsfdsf87fsd",
    "status": "ACTIVE"
  }
]

Facility listing was found and successfully patched

curl --location --request PUT 'https://<apiHostname>/api/facilities/8f5bd918-ad32-4800-9818-54d3f4209b03/listings' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <authToken>' \
--data '{
    "listings": [
        {
            "tenantArticleId": "flour",
            "price": 0.8,
            "version": 1,
            "title": "Sacks of flour",
            "scannableCodes": [],
            "attributes": [],
            "measurementUnitKey": "stone"
        }
    ]
}
'

Defining translations for measurement units

To localize the long-name and abbreviation of a unit for the client applications you can create MeasurementUnit entities corresponding to the listing.measurementUnitKey. If no MeasurementUnit is defined for a key, the key will be displayed in the apps.

Create measurementUnit

post

Authorizations

Body

abbreviationLocalizedall ofrequired

Abbreviation of the unit. Maximum 4 chars long.

Example: {"de_DE":"kg","en_US":"kg","ru_RU":"кг"}

keystringrequired

Descriptor for the measurement unit

Example: kilogramm

nameLocalizedobjectrequired

Example: {"de_DE":"Wert","en_US":"Value","ru_RU":"значение"}

requiresMeasurementbooleanoptional

Indicates that the given unit need to be measured.

Example: true

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://%%HOST%%//api/measurementunits' \
  --header 'Content-Type: application/json' \
  --data '{
    "abbreviationLocalized": {
      "de_DE": "kg",
      "en_US": "kg",
      "ru_RU": "кг"
    },
    "key": "kilogramm",
    "nameLocalized": {
      "de_DE": "Wert",
      "en_US": "Value",
      "ru_RU": "значение"
    },
    "requiresMeasurement": true
  }'

201

401

403

404

201

{
  "abbreviation": "kg",
  "id": "c5300790-9477-475c-bd6d-98e5d61f6413",
  "name": "kilogramm",
  "abbreviationLocalized": {
    "de_DE": "kg",
    "en_US": "kg",
    "ru_RU": "кг"
  },
  "key": "kilogramm",
  "nameLocalized": {
    "de_DE": "Wert",
    "en_US": "Value",
    "ru_RU": "значение"
  },
  "requiresMeasurement": true,
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z",
  "version": 42
}

Successfully created the measurementUnit.

curl --location 'https://<apiHostname>/api/measurementunits' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <authToken>' \
--data '{
    "key": "stone",
    "nameLocalized": { "de_DE": "Stone", "en_US": "Stone" },
    "abbreviationLocalized": { "de_DE": "st", "en_US": "st" },
    "requiresMeasurement": false
}'

Unit validation in inbound processes

If you are using our system for goods receipts, we highly recommend defining units for each product in the respective listing of this product's facility.

Since no conversion between units take place automatically it is important to specify the correct unit when new goods are accepted into the system. This eliminates a common source of critical errors in stock levels.

When a measurementUnitKey is set on the corresponding listing each new line item in inboundProcess.purchaseOrder.requestedItems and inboundProcess.receipts.receivedItems is validated against it: All quantities MUST match the unit of the Listing.

Attention: When creating an InboundProcess with a PurchaseOrder with unit "xyz" and changing the listing.measurementUnitKey to something else ("qwe") the inboundProcess.purchaseOrder must now be patched/replaced to reflect the correct unit again before a receipt can created in the inventory app. This is intentional and ensures the consistency of new stock levels in the facility. In general it is not advised to change the unit of a product in a facility without careful consideration, but in some cases it might be desired to start with no unit on the listing (= no validation) and transition to stricter rules later.