Storage Location

Summary

A storage location is a physical location where stock can be located. Since there might be more than one product located on the same location, more than one stock can be connected to a single storage location.

Depending on the facility type, a storage location can represent different concepts, e.g., the showcase area or the supply room in stores, or a compartment on the shelf or a pallet space in warehouses.

Description

Storage locations represent the available storage space in a facility. A given stock can either be generically assigned to a facility, or it can be assigned to a specific storage location by linking the stock to the storage location.

• Storage locations can be grouped in zones.

• Storage locations can be assigned traits, which they in turn inherit to all stocks linked to them.

Running Sequence

• Storage locations can be ordered in a (running) sequence by defining the previous and next location via API.

• Depending on the sequence type that was defined, the sequence is considered in picking or restowing.

Patches the storage locations of a facility with the given ID

Adds new storage locations, updates existing ones and keeps the previously present ones in the database.

1. If a storage location exists in the patch action but not in the database it is added.
2. If a storage location exists both in the patch action and in the database it is updated and the contents merged.
3. If a storage location exists only in the database, it is left untouched.

PATCH/api/facilities/{facilityId}/storagelocations/{storageLocationId}

Path parameters

facilityId*string

ID of facility you want to patch the storage locations

storageLocationId*string

the ID of the storageLocation

Body

application/json

Patch set

actions*array of ModifyStorageLocationAction (all of)

version*integer (int64)

The version of the facility where we want to patch the storage locations to be used in optimistic locking mechanisms.

Response

200401403404

Storage location was found & you were allowed to update it.

Body

application/json

name*string

The name of this storage location

tenantLocationIdstring

The internal tenant id for this location

type*StorageLocationType (enum)

Describes the kind of a storage location:

• SINGLE_STORAGE- it is only allowed to store stock with the same tenantArticleId here
• BULK_STORAGE- stocks belonging to different tenantArticleIds can be stored here

SINGLE_STORAGEBULK_STORAGE

traitsarray of StorageLocationTrait (enum)

The traits of this storage location, includes both local config and and defaults. Do not use to write to traits, use traitConfig instead.

traitConfigStorageLocationTraitConfig (array of object)

The configuration of the traits of this storage location

scannableCodes*array of string

Barcodes representing this storage location

runningSequences*array of StorageLocationSequenceItem (object)

The Sequence item/s of this location

zoneRefstring

The id of the Zone to which this storage location belongs

zoneNamestring

The name of the Zone to which this storage location belongs

informationstring

A free text information about this storage location, max length 1024

customAttributesobject

Attributes that can be added to the storage location. These attributes cannot be used within fulfillment processes, but it could be useful to have the informations carried here.

createdstring (date-time)

The date this entity was created at the platform. This value is generated by the service.

lastModifiedstring (date-time)

The date this entity was modified last. This value is generated by the service.

version*integer (int64)

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

Request

JavaScriptCurl

const response = await fetch('/api/facilities/{facilityId}/storagelocations/{storageLocationId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "version": 42,
      "actions": [
        {
          "action": "ModifyStorageLocation"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "id": "text",
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "traits": [
    "PICKABLE"
  ],
  "traitConfig": [
    {
      "trait": "PICKABLE",
      "enabled": false
    }
  ],
  "schemaVersion": 0
}

  "runningSequences": [
    {
      "type": "PICKING_SEQUENCE",
      "previousStorageLocationRef": "string",
      "nextStorageLocationRef": "string"
    }
  ],

The running sequence defined for a storage location is prioritized over the running sequence that can be set on listing or order line item level.

Storage Location Types

Storage locations can either have the type "single storage" or the type "bulk storage".

• On locations with type "single storage", several items of the same product can be stored, e.g., 100 apples. If a product is already placed on a single-storage location, stowing of a different product on the same location is forbidden.

• On locations with type "bulk storage", different products can be stored, e.g., 100 apples and 100 bananas.

Custom Attributes

The customAttributes field is a JSON object that carries information that might be relevant to the Storage Location. The form and content of this object is completely free, but its JSON serialized size is limited. Check out the Custom Attributes section for more details.