Storage locations endpoints

List storage locations (search)

post

Search for StorageLocation

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

StorageLocationSearchPayload

afterstringOptional

The cursor to start after for forward pagination. The value is provided in the pageInfo.endCursor field of the response. Cannot be used with before or last.

beforestringOptional

The cursor to start before for backward pagination. The value is provided in the pageInfo.startCursor field of the response. Cannot be used with after or size (first).

lastnumber · min: 1 · max: 250Optional

Number of items to return for backward pagination. Cannot be used with 'size' (first). Default: 20.

sizenumber · min: 1 · max: 250Optional

Number of items to return for forward pagination. Cannot be used with 'last'. Default: 20.

startAfterIdstringOptionalDeprecated

The ID to start after. Deprecated, use after with the value provided in pageInfo.endCursor instead.

Responses

200

Your search result

application/json

StorageLocationPaginatedResult

totalnumberOptional

The total number of items matching the search criteria. Only filled, if withTotal is set to true in the search options.

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

/api/storagelocations/search

HTTPcURLJavaScriptPython

POST /api/storagelocations/search HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 5603

{
  "after": "text",
  "before": "text",
  "last": 1,
  "options": {
    "withTotal": true
  },
  "query": {
    "and": [
      {
        "and": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-28T08:42:05.394Z",
              "gt": "2026-03-28T08:42:05.394Z",
              "gte": "2026-03-28T08:42:05.394Z",
              "lt": "2026-03-28T08:42:05.394Z",
              "lte": "2026-03-28T08:42:05.394Z",
              "notEq": "2026-03-28T08:42:05.394Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "referenced": {
              "stock": {
                "hasStocks": {
                  "eq": true,
                  "notEq": true
                },
                "sumOfValues": {
                  "eq": 1,
                  "gt": 1,
                  "gte": 1,
                  "in": [
                    1
                  ],
                  "lt": 1,
                  "lte": 1,
                  "notEq": 1,
                  "notIn": [
                    1
                  ]
                }
              }
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantLocationId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "type": {
              "eq": "SINGLE_STORAGE",
              "in": [
                "SINGLE_STORAGE"
              ],
              "notEq": "SINGLE_STORAGE"
            },
            "zoneRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-28T08:42:05.394Z",
          "gt": "2026-03-28T08:42:05.394Z",
          "gte": "2026-03-28T08:42:05.394Z",
          "lt": "2026-03-28T08:42:05.394Z",
          "lte": "2026-03-28T08:42:05.394Z",
          "notEq": "2026-03-28T08:42:05.394Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": [
          {
            "and": "[Circular Reference]",
            "created": {
              "after": "text",
              "before": "text",
              "eq": "2026-03-28T08:42:05.394Z",
              "gt": "2026-03-28T08:42:05.394Z",
              "gte": "2026-03-28T08:42:05.394Z",
              "lt": "2026-03-28T08:42:05.394Z",
              "lte": "2026-03-28T08:42:05.394Z",
              "notEq": "2026-03-28T08:42:05.394Z"
            },
            "customAttributes": {
              "ANY_ADDITIONAL_PROPERTY": {
                "eq": true,
                "notEq": true
              }
            },
            "facilityRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "id": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "name": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "or": "[Circular Reference]",
            "referenced": {
              "stock": {
                "hasStocks": {
                  "eq": true,
                  "notEq": true
                },
                "sumOfValues": {
                  "eq": 1,
                  "gt": 1,
                  "gte": 1,
                  "in": [
                    1
                  ],
                  "lt": 1,
                  "lte": 1,
                  "notEq": 1,
                  "notIn": [
                    1
                  ]
                }
              }
            },
            "scannableCodes": {
              "contains": {
                "eq": "text",
                "notEq": "text"
              }
            },
            "tenantLocationId": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            },
            "traits": {
              "contains": {
                "eq": "PICKABLE",
                "in": [
                  "PICKABLE"
                ],
                "notEq": "PICKABLE"
              }
            },
            "type": {
              "eq": "SINGLE_STORAGE",
              "in": [
                "SINGLE_STORAGE"
              ],
              "notEq": "SINGLE_STORAGE"
            },
            "zoneRef": {
              "eq": "text",
              "in": [
                "text"
              ],
              "notEq": "text",
              "notIn": [
                "text"
              ]
            }
          }
        ],
        "referenced": {
          "stock": {
            "hasStocks": {
              "eq": true,
              "notEq": true
            },
            "sumOfValues": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            }
          }
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantLocationId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "type": {
          "eq": "SINGLE_STORAGE",
          "in": [
            "SINGLE_STORAGE"
          ],
          "notEq": "SINGLE_STORAGE"
        },
        "zoneRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "created": {
      "after": "text",
      "before": "text",
      "eq": "2026-03-28T08:42:05.394Z",
      "gt": "2026-03-28T08:42:05.394Z",
      "gte": "2026-03-28T08:42:05.394Z",
      "lt": "2026-03-28T08:42:05.394Z",
      "lte": "2026-03-28T08:42:05.394Z",
      "notEq": "2026-03-28T08:42:05.394Z"
    },
    "customAttributes": {
      "ANY_ADDITIONAL_PROPERTY": {
        "eq": true,
        "notEq": true
      }
    },
    "facilityRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "id": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "name": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "or": [
      {
        "and": "[Circular Reference]",
        "created": {
          "after": "text",
          "before": "text",
          "eq": "2026-03-28T08:42:05.394Z",
          "gt": "2026-03-28T08:42:05.394Z",
          "gte": "2026-03-28T08:42:05.394Z",
          "lt": "2026-03-28T08:42:05.394Z",
          "lte": "2026-03-28T08:42:05.394Z",
          "notEq": "2026-03-28T08:42:05.394Z"
        },
        "customAttributes": {
          "ANY_ADDITIONAL_PROPERTY": {
            "eq": true,
            "notEq": true
          }
        },
        "facilityRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "id": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "name": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "or": "[Circular Reference]",
        "referenced": {
          "stock": {
            "hasStocks": {
              "eq": true,
              "notEq": true
            },
            "sumOfValues": {
              "eq": 1,
              "gt": 1,
              "gte": 1,
              "in": [
                1
              ],
              "lt": 1,
              "lte": 1,
              "notEq": 1,
              "notIn": [
                1
              ]
            }
          }
        },
        "scannableCodes": {
          "contains": {
            "eq": "text",
            "notEq": "text"
          }
        },
        "tenantLocationId": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        },
        "traits": {
          "contains": {
            "eq": "PICKABLE",
            "in": [
              "PICKABLE"
            ],
            "notEq": "PICKABLE"
          }
        },
        "type": {
          "eq": "SINGLE_STORAGE",
          "in": [
            "SINGLE_STORAGE"
          ],
          "notEq": "SINGLE_STORAGE"
        },
        "zoneRef": {
          "eq": "text",
          "in": [
            "text"
          ],
          "notEq": "text",
          "notIn": [
            "text"
          ]
        }
      }
    ],
    "referenced": {
      "stock": {
        "hasStocks": {
          "eq": true,
          "notEq": true
        },
        "sumOfValues": {
          "eq": 1,
          "gt": 1,
          "gte": 1,
          "in": [
            1
          ],
          "lt": 1,
          "lte": 1,
          "notEq": 1,
          "notIn": [
            1
          ]
        }
      }
    },
    "scannableCodes": {
      "contains": {
        "eq": "text",
        "notEq": "text"
      }
    },
    "tenantLocationId": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    },
    "traits": {
      "contains": {
        "eq": "PICKABLE",
        "in": [
          "PICKABLE"
        ],
        "notEq": "PICKABLE"
      }
    },
    "type": {
      "eq": "SINGLE_STORAGE",
      "in": [
        "SINGLE_STORAGE"
      ],
      "notEq": "SINGLE_STORAGE"
    },
    "zoneRef": {
      "eq": "text",
      "in": [
        "text"
      ],
      "notEq": "text",
      "notIn": [
        "text"
      ]
    }
  },
  "size": 1,
  "sort": [
    {
      "created": "ASC",
      "customAttributes": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "lastModified": "ASC",
      "name": "ASC",
      "tenantLocationId": "ASC",
      "zoneRef": "ASC"
    }
  ]
}

{
  "pageInfo": {
    "endCursor": "text",
    "hasNextPage": true,
    "hasPreviousPage": true,
    "startCursor": "text"
  },
  "storageLocations": [
    {
      "version": 42,
      "information": "text",
      "name": "text",
      "runningSequences": [
        {
          "nextStorageLocationRef": "text",
          "previousStorageLocationRef": "text",
          "type": "PICKING_SEQUENCE"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tenantLocationId": "text",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "PICKABLE"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "type": "SINGLE_STORAGE",
      "zoneName": "text",
      "zoneRef": "Esb20gpHBL94X5NdMp3C",
      "customAttributes": {},
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z"
    }
  ],
  "total": 1
}

Get facility storage location

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility from which you want to get the storage locations. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})

storageLocationIdstringRequired

the ID of the storageLocation

Responses

200

Facility was found & you are allowed to get the storage locations. The result is in the body.

application/json

StorageLocation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptionalDeprecated

Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

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

Example: 2020-02-03T09:45:51.525Z

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

idstringRequired

The id of this storage location

schemaVersionnumberOptional

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 endpoint

application/json

404

Facility not found

application/json

get

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

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/storagelocations/{storageLocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "version": 42,
    "information": "text",
    "name": "text",
    "runningSequences": [
      {
        "nextStorageLocationRef": "text",
        "previousStorageLocationRef": "text",
        "type": "PICKING_SEQUENCE"
      }
    ],
    "scannableCodes": [
      "text"
    ],
    "tenantLocationId": "text",
    "traitConfig": [
      {
        "enabled": true,
        "trait": "PICKABLE"
      }
    ],
    "traits": [
      "PICKABLE"
    ],
    "type": "SINGLE_STORAGE",
    "zoneName": "text",
    "zoneRef": "Esb20gpHBL94X5NdMp3C",
    "customAttributes": {},
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z"
  }
]

List facility storage locations

get

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility from which you want to get the storage locations. Also accepts tenantFacilityId in urn format (e.g. urn:fft:facility:tenantFacilityId:{your-tenant-facility-id})

Query parameters

startAfterIdstringOptional

all entities after given Id

sizeintegerOptional

number of entities to show

Default: 25

scannableCodestringOptional

limit result to storage locations with scannable code

Responses

200

Facility was found & you are allowed to get the storage locations. The result is in the body.

application/json

StorageLocation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptionalDeprecated

Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

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

Example: 2020-02-03T09:45:51.525Z

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

idstringRequired

The id of this storage location

schemaVersionnumberOptional

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 endpoint

application/json

404

Facility not found

application/json

get

/api/facilities/{facilityId}/storagelocations

HTTPcURLJavaScriptPython

GET /api/facilities/{facilityId}/storagelocations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "version": 42,
    "information": "text",
    "name": "text",
    "runningSequences": [
      {
        "nextStorageLocationRef": "text",
        "previousStorageLocationRef": "text",
        "type": "PICKING_SEQUENCE"
      }
    ],
    "scannableCodes": [
      "text"
    ],
    "tenantLocationId": "text",
    "traitConfig": [
      {
        "enabled": true,
        "trait": "PICKABLE"
      }
    ],
    "traits": [
      "PICKABLE"
    ],
    "type": "SINGLE_STORAGE",
    "zoneName": "text",
    "zoneRef": "Esb20gpHBL94X5NdMp3C",
    "customAttributes": {},
    "created": "2020-02-03T08:45:51.525Z",
    "lastModified": "2020-02-03T09:45:51.525Z"
  }
]

Update facility storage location

put

Replaces the current storage locations of this Facility with the provided in the body.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility from whom you want to put the storage locations

storageLocationIdstringRequired

the ID of the storageLocation

Body

application/json

StorageLocationForReplacement

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptional

The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

versioninteger · int64RequiredExample: 42

Responses

200

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

application/json

StorageLocation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptionalDeprecated

Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

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

Example: 2020-02-03T09:45:51.525Z

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

idstringRequired

The id of this storage location

schemaVersionnumberOptional

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 endpoint

application/json

404

Facility or Storage Location not found

application/json

put

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

HTTPcURLJavaScriptPython

PUT /api/facilities/{facilityId}/storagelocations/{storageLocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "version": 42,
  "information": "text",
  "name": "text",
  "runningSequences": [
    {
      "nextStorageLocationRef": "text",
      "previousStorageLocationRef": "text",
      "type": "PICKING_SEQUENCE"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantLocationId": "text",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "PICKABLE"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "type": "SINGLE_STORAGE",
  "zoneName": "text",
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "customAttributes": {}
}

{
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "text",
  "schemaVersion": 1,
  "traitConfig": [
    {
      "enabled": true,
      "trait": "PICKABLE"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "version": 42,
  "information": "text",
  "name": "text",
  "runningSequences": [
    {
      "nextStorageLocationRef": "text",
      "previousStorageLocationRef": "text",
      "type": "PICKING_SEQUENCE"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantLocationId": "text",
  "type": "SINGLE_STORAGE",
  "zoneName": "text",
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "customAttributes": {},
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Create facility storage location

post

Creates a new storage location in this facility.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility from whom you want to create the storage location

Body

application/json

StorageLocationForCreation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptional

The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

Responses

201

The storage location was successfully 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 endpoint

application/json

404

Facility not found

application/json

post

/api/facilities/{facilityId}/storagelocations

HTTPcURLJavaScriptPython

POST /api/facilities/{facilityId}/storagelocations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 376

{
  "information": "text",
  "name": "text",
  "runningSequences": [
    {
      "nextStorageLocationRef": "text",
      "previousStorageLocationRef": "text",
      "type": "PICKING_SEQUENCE"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantLocationId": "text",
  "traitConfig": [
    {
      "enabled": true,
      "trait": "PICKABLE"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "type": "SINGLE_STORAGE",
  "zoneName": "text",
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "customAttributes": {}
}

{
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "text",
  "schemaVersion": 1,
  "traitConfig": [
    {
      "enabled": true,
      "trait": "PICKABLE"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "version": 42,
  "information": "text",
  "name": "text",
  "runningSequences": [
    {
      "nextStorageLocationRef": "text",
      "previousStorageLocationRef": "text",
      "type": "PICKING_SEQUENCE"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantLocationId": "text",
  "type": "SINGLE_STORAGE",
  "zoneName": "text",
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "customAttributes": {},
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Update facility storage location

patch

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.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility you want to patch the storage locations

storageLocationIdstringRequired

the ID of the storageLocation

Body

application/json

StorageLocationPatchActions

versioninteger · int64Required

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

Example: 42

Responses

200

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

application/json

StorageLocation

customAttributesobject · nullableOptional

Attributes that can be added to this entity. These attributes cannot be used within fulfillment processes, but enable you to attach custom data from your systems to fulfillmenttools entities.

informationstring · max: 1024Optional

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

namestring · max: 15Required

The name of this storage location

scannableCodesstring[] · max: 5Required

Barcodes representing this storage location

tenantLocationIdstringOptional

The internal tenant id for this location

typestring · enumRequired

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

Possible values:

zoneNamestringOptionalDeprecated

Deprecated! This field will not be filled in newly created storage locations. Resolve the zone name separately via the facilities/{id}/zones endpoint. The name of the Zone to which this storage location belongs

zoneRefstringOptional

The id of the Zone to which this storage location belongs

Example: Esb20gpHBL94X5NdMp3C

versioninteger · int64Required

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

Example: 42

createdstring · date-timeOptional

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

Example: 2020-02-03T08:45:51.525Z

lastModifiedstring · date-timeOptional

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

Example: 2020-02-03T09:45:51.525Z

facilityRefstringRequired

The id of the facility reference.

Example: Esb20gpHBL94X5NdMp3C

idstringRequired

The id of this storage location

schemaVersionnumberOptional

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 endpoint

application/json

404

Facility or Storage location not found

application/json

patch

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

HTTPcURLJavaScriptPython

PATCH /api/facilities/{facilityId}/storagelocations/{storageLocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 396

{
  "actions": [
    {
      "action": "ModifyStorageLocation",
      "customAttributes": {},
      "information": "text",
      "name": "text",
      "runningSequences": [
        {
          "nextStorageLocationRef": "text",
          "previousStorageLocationRef": "text",
          "type": "PICKING_SEQUENCE"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tenantLocationId": "text",
      "traitConfig": [
        {
          "enabled": true,
          "trait": "PICKABLE"
        }
      ],
      "type": "SINGLE_STORAGE",
      "zoneRef": "Esb20gpHBL94X5NdMp3C"
    }
  ],
  "version": 42
}

{
  "facilityRef": "Esb20gpHBL94X5NdMp3C",
  "id": "text",
  "schemaVersion": 1,
  "traitConfig": [
    {
      "enabled": true,
      "trait": "PICKABLE"
    }
  ],
  "traits": [
    "PICKABLE"
  ],
  "version": 42,
  "information": "text",
  "name": "text",
  "runningSequences": [
    {
      "nextStorageLocationRef": "text",
      "previousStorageLocationRef": "text",
      "type": "PICKING_SEQUENCE"
    }
  ],
  "scannableCodes": [
    "text"
  ],
  "tenantLocationId": "text",
  "type": "SINGLE_STORAGE",
  "zoneName": "text",
  "zoneRef": "Esb20gpHBL94X5NdMp3C",
  "customAttributes": {},
  "created": "2020-02-03T08:45:51.525Z",
  "lastModified": "2020-02-03T09:45:51.525Z"
}

Delete facility storage location

delete

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

facilityIdstringRequired

ID of facility from whom you want to delete the storage location

storageLocationIdstringRequired

ID of the storageLocation you want to delete

Responses

200

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

No content

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 endpoint

application/json

404

Facility or storage location not found

application/json

delete

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

HTTPcURLJavaScriptPython

DELETE /api/facilities/{facilityId}/storagelocations/{storageLocationId} HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get stock recommendations

get

This part of the API is in Alpha status. For details please check the api-release-life-cycle documentation. Get the Storage Location recommendations for a specific Stock.

Authorizations

BearerToken

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

stockIdstringRequired

Responses

200

List of Storage Locations sorted by the stock sum ascending. The result is in the body.

application/json

StorageLocationRecommendation

stockCountnumberRequired

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

/api/stocks/{stockId}/locationrecommendations

HTTPcURLJavaScriptPython

GET /api/stocks/{stockId}/locationrecommendations HTTP/1.1
Host: your-tenant-name.api.fulfillmenttools.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "stockCount": 1,
    "storageLocation": {
      "facilityRef": "Esb20gpHBL94X5NdMp3C",
      "id": "text",
      "schemaVersion": 1,
      "traitConfig": [
        {
          "enabled": true,
          "trait": "PICKABLE"
        }
      ],
      "traits": [
        "PICKABLE"
      ],
      "version": 42,
      "information": "text",
      "name": "text",
      "runningSequences": [
        {
          "nextStorageLocationRef": "text",
          "previousStorageLocationRef": "text",
          "type": "PICKING_SEQUENCE"
        }
      ],
      "scannableCodes": [
        "text"
      ],
      "tenantLocationId": "text",
      "type": "SINGLE_STORAGE",
      "zoneName": "text",
      "zoneRef": "Esb20gpHBL94X5NdMp3C",
      "customAttributes": {},
      "created": "2020-02-03T08:45:51.525Z",
      "lastModified": "2020-02-03T09:45:51.525Z"
    }
  }
]