Customer defined IDs in requests

The fulfillmenttools platform allows specifying a customer-defined ID for certain entities. The ID format follows the pattern tenant<entity>Id. This field allows for transferring IDs from external systems to the fulfillmenttools platform. If this ID is unambiguous, it enables reading and writing the entity using HTTP.

Currently, this functionality applies only to stock entities.

For information on retrieving entities by their tenant<entity>Id using a path parameter, refer to the Uniform Resource Name (URN) pattern in path parameters documentation.

Examples for stocks

Retrieving stocks by customer-defined ID

GET https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/stocks?tenantFacilityId=CGN-01

Searching for stocks by customer-defined ID

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

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

Creating stocks with a customer-defined ID via PUT

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

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

Creating stocks with a customer-defined ID via POST

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

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

}