Product

Get a product

Get a single product by ID. Unlike the list endpoint, the response always includes the product's bill_of_materials (or null if it has none).

Returns 404 if no product with that ID exists in your company, or if the authenticated user cannot see it under their team restrictions — the two cases are indistinguishable from the response.

Required permission: products_permissions_view.

get/public/v1/products/{id}

Path parameters

idstring required

Product ID.

Query parameters

include_packages_with_active_quantity_by_locationboolean

When true, the product carries packages_with_active_quantity_by_location — its packages that hold active quantity, grouped by location (empty when the product is not package-tracked). Defaults to false, in which case the field is omitted.

include_batches_with_active_quantity_by_locationboolean

When true, the product carries batches_with_active_quantity_by_location — its batches that hold active quantity, grouped by location, each batch carrying its active quantity at that location (empty when the product is not batch-tracked). Defaults to false, in which case the field is omitted.

Response

A single product

Changes

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