Materials List Stock Formats
materials_list_stock_formatsRead-onlyIdempotent
The stock formats your organization prices with, its own first.
That is every format of your own plus each standard format you have
not hidden. Every row says in resolution what calculations do with it.
The response is a plain array, so the page position travels in the
Link (RFC 8288) and X-Next-Cursor / X-Has-More response headers.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| at | No | Read the list as it stood on this date (`YYYY-MM-DD`): the formats a calculation dated then prices with. Defaults to today (UTC). | |
| kind | No | Which purchased stock form to list: `sheet`, `plate`, `bar` or `tube`. One kind per list. | sheet |
| limit | No | Maximum rows to return in one page. | |
| cursor | No | Opaque position token from the previous page's `next_cursor` (or the `Link` / `X-Next-Cursor` response header). Omit it for the first page. Keep every other query parameter identical for the whole walk — a cursor replayed against different filters is rejected. | |
| offset | No | Rows to skip. Superseded by `cursor`, which is stable under concurrent writes; kept for existing integrations. Bounded — past the cap, page with `cursor`. | |
| include_suppressed | No | Also list the standard formats your organization has hidden, marked `suppressed`. Off by default, so the list is exactly the formats calculations price with. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | This page's rows, in the order and shape the REST list returns them. | |
| has_more | Yes | False on the last page. Stop on this, never on a short page. | |
| next_cursor | Yes | Pass as `cursor` to read the next page. Null on the last page. |