Products

The {product} path parameter accepts a record ID or external identifier. Treat identifiers as opaque strings and preserve them exactly.

GET/api/v1/products

List products

Required scope: products:read. Supports the standard collection query controls documented under Pagination.

POST/api/v1/products

Create a product

Required scope: products:write. Use product.schema.json for the current request contract.

GET/api/v1/products/{product}

Get a product

Required scope: products:read.

PATCH/api/v1/products/{product}

Update a product

Required scope: products:write. PUT is also supported.

DELETE/api/v1/products/{product}

Delete a product

Required scope: products:write. Returns 204 No Content on success.

Was this page helpful?