Warehouse

Inventory levels and stock movements per warehouse, item, and variant — as absolute quantities and/or delta adjustments, optionally with incoming quantity, next delivery date, and forward planning / historical consumption data.

Add warehouse entries to the queue

POST https://onbrightcom.com/gateway/v1/warehouse

Accepts a JSON array of warehouse entries.

Field	Type	Notes
`id`	string (GUID)
`externalId`	string
`checksum`	string
`warehouseExternalId`	string
`sourceWarehouseExternalId`	string	For transfer-type movements
`destinationWarehouseExternalId`	string	For transfer-type movements
`messageType`	string
`comment`	string
`source`	string
`partNo`	string
`variantCode`	string
`quantity`	number	Absolute quantity
`deltaQuantity`	number	Adjustment relative to the last known quantity
`created`	datetime
`incomingQuantity`	number
`nextDelivery`	datetime
`reasonCode`	string
`transactionId`	string
`name`	string
`extendedInfo`	array	See Extended Info
`type`	string
`period`	string
`planning`	array of object	See Planning below
`history`	array of object	See History below
`productRanges`	array	Channel/assortment flags

Request

[
  {
    "externalId": "MAIN-10023-050-ONE",
    "warehouseExternalId": "MAIN",
    "source": "example-erp",
    "partNo": "10023",
    "variantCode": "050-ONE",
    "quantity": 42,
    "deltaQuantity": -3,
    "created": "2026-08-26T08:00:00Z",
    "incomingQuantity": 100,
    "nextDelivery": "2026-09-05T00:00:00Z",
    "extendedInfo": []
  }
]

Response

201 Created
"1 warehouse entr(y/ies) queued"

Planning

Field	Type
`startPeriod`	datetime
`endPeriod`	datetime
`quantityPhysical`	number
`scheduledReceipt`	number
`grossRequirement`	number
`quantity`	number

History

Field	Type
`periodStart`	datetime
`periodEnd`	datetime
`periodStartInventory`	number
`purchases`	number
`sales`	number
`other`	number
`periodEndInventory`	number

Retrieve warehouse entries from the queue

GET https://onbrightcom.com/gateway/v1/warehouse

Query parameter	Notes
`count`	Number of entries to retrieve. Default 100 if omitted.
`acknowledge`	The `acknowledgeToken` from your previous batch — pass it to close that batch and advance the queue.

{
  "count": 1,
  "acknowledgeToken": "6c2e9a4d-1a3b-4f60-9e0c-2d7a5f8b3c11",
  "nextLink": "/warehouse?acknowledge=6c2e9a4d-1a3b-4f60-9e0c-2d7a5f8b3c11",
  "data": [
    {
      "externalId": "MAIN-10023-050-ONE",
      "warehouseExternalId": "MAIN",
      "partNo": "10023",
      "variantCode": "050-ONE",
      "quantity": 42,
      "extendedInfo": []
    }
  ]
}