Customer defined IDs in requests

For some entities, it is possible to specify a user-defined ID. The format is always tenant<entity>Id. This field can be utilized for the purpose of transferring IDs from external systems to the fulfillmenttools platform. If this ID is unambiguous, it can be used to read and write the entity in HTTP.

At present, this functionality is exclusively available for stocks.

For getting entities by their tenant<entity>Id via path parameter please refer to Uniform-Resource-Name-Pattern (URN) in path parameters.

Examples for stocks

Search for stocks with a user-defined ID

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stocks/search

{
    "query": {
        "tenantFacilityId": {
            "eq": "CGN-01"
        }
    }
}

Create a stock with a user-defined ID via PUT

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stocks

{
    "stocks": [
        {
            "facility": {
                "tenantFacilityId": "CGN-01"
            },
            "tenantArticleId": "0188104",
            "value": 100
        }
    ]
}

Create a stock with a user-defined ID via POST

POST https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stocks

{
    "facility": {
        "tenantFacilityId": "CGN-01"
    },
    "tenantArticleId": "0188104",
    "value": 101

}