List Products
POST/Products/List
Returns a paginated list of products visible to the authenticated API customer.
Results can be filtered by category and/or by a specific product, and the level of
detail in the response can be controlled with the detailed flag.
Pagination: use page (zero-based) together with pageSize to walk through
large catalogs. When omitted, server defaults are applied.
Filtering: pass productCategoryID to limit the response to a single category, or
productID to fetch a single product through the listing endpoint.
Detail level: when detailed = true (default) the response includes pricing, stock,
images, descriptions, platforms and variants; when false a lighter projection is
returned for faster catalog synchronization.
Authentication: requires a valid API customer. Requests without a
valid API user will receive 401 Unauthorized.
Request
Responses
- 200
- 400
- 401
- 403
- 404
Product list returned successfully.
Invalid pagination or filter parameters (e.g. negative page).
The caller is not an authorized API customer.
Forbidden
The API integration is disabled for this tenant.