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.
ID of facility you want to get its listing
PUT / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 529
{
"listings": [
{
"attributes": [
{
"category": "descriptive",
"key": "%%subtitle%%",
"priority": 100,
"value": "585er Gold"
}
],
"imageUrl": "text",
"price": 1200,
"tenantArticleId": "4711",
"title": "Adidas Superstar",
"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"
}
}
]
}No content
ID of facility you want to patch a listing of
tenant ID of the articles listing you want to patch
The version of the document to be used in optimistic locking mechanisms.
42PATCH / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 576
{
"actions": [
{
"action": "ModifyListing",
"attributes": [
{
"category": "descriptive",
"key": "%%subtitle%%",
"priority": 100,
"value": "585er Gold"
}
],
"imageUrl": "text",
"price": 1200,
"status": "ACTIVE",
"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
}[
{
"attributes": [
{
"category": "descriptive",
"key": "%%subtitle%%",
"priority": 100,
"value": "585er Gold"
}
],
"imageUrl": "text",
"price": 1200,
"tenantArticleId": "4711",
"title": "Adidas Superstar",
"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"
}
]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.
Abbreviation of the unit. Maximum 4 chars long.
{"de_DE":"kg","en_US":"kg","ru_RU":"кг"}Descriptor for the measurement unit
kilogrammIndicates that the given unit need to be measured.
truePOST / HTTP/1.1
Host: %%HOST%%
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"abbreviationLocalized": {
"de_DE": "kg",
"en_US": "kg",
"ru_RU": "кг"
},
"key": "kilogramm",
"nameLocalized": {
"de_DE": "Wert",
"en_US": "Value",
"ru_RU": "значение"
},
"requiresMeasurement": true
}{
"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
}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.
Last updated
Was this helpful?