Customer-defined IDs in requests

fulfillmenttools 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. 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 stock

Get stock with a user-defined ID

GET https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks?tenantFacilityId=CGN-01

Search for stock with a user-defined ID

POST https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks/search

Request body (JSON)

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

Create stock with a user-defined ID via PUT

PUT https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks

Request body (JSON)

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

Create a stock with a user-defined ID via POST

POST https://ocff-{projectId}.api.fulfillmenttools.com/api/stocks

Request body (JSON)

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