Inventory

Get a inventory by ID

Retrieves a single inventory by its unique identifier.

get/v1/inventory/{id}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/inventory/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Inventory ID

Response

The inventory has been successfully retrieved.

idstring

Unique identifier for the Inventory.

createdAtstring date-time

Timestamp when the Inventory was created.

updatedAtstring date-time

Timestamp when the Inventory was last updated.

companyIdstring

Company ID associated with the Inventory.

productIdstring

Product ID of the Stock.

variantIdstring

Variant ID of the Stock.

outletIdstring

Outlet ID of the Stock.

manageStockboolean

Whether the tuple manages stock. If false, quantity is treated as infinite.

quantitynumber

Quantity of the Stock.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "productId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "variantId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "manageStock": true,
  "quantity": 10
}

Changes

No recorded changes to this operation across all 1 revision of this API.