On this page
sizeRun
query · in the family Size run
What it does
Look up one record — a size run — the ratio a buyer spreads a quantity over one option dimension (S-M-L-XL 1-2-2-1), kept once and reused by every style that names it.
A SizeRun by id, within the caller's OWN org-group family; requires authentication. A cross-tenant id reads as null (not-found) AND trips the rootId tripwire server-side.
What happens
Reads only — changes nothing.
Who may call it
Capability area: Reading your records — Looking up and listing the records of your organization.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- An API key whose scope allows
api:sizeRun
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
SizeRun — A size run — a RATIO over ONE option dimension (S-M-L-XL 1-2-2-1; a colour run 2 black: 1 white is equally real — any OptionGroup type may carry a run) a buyer fills a matrix with: kept ONCE and reused on every Style that names it (Style.sizeRunId — its group must be in the scheme) or by the dimension itself (OptionGroup.defaultSizeRunId — the org default lives on the dimension); resolution = the style pick, then the group default, then none (the matrix axes carry the resolved id). optionGroupId is IMMUTABLE at birth (a different dimension is a DIFFERENT run: doom + create — the PurchasePack unitsPerPack stance). entries = 1..256 { optionValueId, share } rows — DISTINCT values OF THAT GROUP, every share an integer 0..10000, the shares summing to at least 1, stored in the CALLER order = the display order (a 0-share value rides the run but never receives a unit). sizeRunFill spreads a total over the ratio by the fill rule (largest remainder, ties to the earlier entry, the quantities summing to the total exactly). Doom is blocked while a non-doomed Style or OptionGroup names the run (CONFLICT/REFERENCED naming the holders); deactivate is free. Group-parented (parentId === rootId); sysId SZ-….
Example request
query ExampleSizeRun($id: ID!) {
sizeRun(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
optionGroupId
code
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"sizeRun": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "SZ-EXMP-0000-000F",
"type": "SizeRun",
"caption": "Blue jeans",
"status": "active",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revisionNum": 1,
"revision": "01900000-0000-7000-8000-b7960e180000",
"optionGroupId": "01900000-0000-7000-8000-14f0cf6a0000",
"code": "BJ-001"
}
},
"extensions": {
"at": {
"callId": "01EXAMPLE-CALL-ID",
"version": {
"requested": null,
"serviced": {
"name": "genesis",
"number": 0
}
}
}
}
}
Errors this call can answer
VALIDATION/INVALID— Something in the request is not valid. (VALIDATION)AUTHN/REQUIRED— Sign in to do this. (AUTHN)AUTHZ/FORBIDDEN— Your role does not allow this action. (AUTHZ)RATE_LIMIT/THROTTLED— Too many requests in a short time. (RATE_LIMIT)NOT_FOUND/*— That record could not be found. (NOT_FOUND)