On this page
variantIdentifiers
query · in the family Reading your records
What it does
The identifiers (barcodes/SKUs) assigned to one variant.
A variant's identifier ledger: current + superseded entries, VOIDED excluded, most-recent-first; kind/organizationId filters compose. Requires authentication; the variant is tenant-scoped server-side.
What happens
Reads only.
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
- Cashier
- An API key whose scope allows
api:variantIdentifiers
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
variantId | ID ID! | yes | No further notes. |
kind | String | no | No further notes. |
organizationId | ID | no | No further notes. |
Returns
IdentifierEntry [IdentifierEntry!]! — ONE ledgered identifier assignment: a kind + value borne by a Variant over an assignment window. sysId-LESS; IMMUTABLE (no edit op exists; supersededAt is the ONE set-once SYSTEM stamp; doomed = VOIDED, a correction).
Example request
query ExampleVariantIdentifiers($variantId: ID!, $kind: String) {
variantIdentifiers(variantId: $variantId, kind: $kind) {
id
type
caption
status
parentId
rootId
kind
value
organizationId
assignedAt
supersededAt
createdAt
updatedAt
revision
revisionNum
}
}
Variables:
{
"variantId": "01900000-0000-7000-8000-8415e73b0000",
"kind": "<kind>"
}
Example response
{
"data": {
"variantIdentifiers": [
{
"id": "01900000-0000-7000-8000-37386ae00000",
"type": "<type>",
"caption": "Blue jeans",
"status": "<status>",
"parentId": "01900000-0000-7000-8000-065235280000",
"rootId": "01900000-0000-7000-8000-a093dd800000",
"kind": "<kind>",
"value": "<value>",
"organizationId": "01900000-0000-7000-8000-44b781470000",
"assignedAt": "2027-01-31T00:00:00.000Z",
"supersededAt": "2027-01-31T00:00:00.000Z",
"createdAt": "2027-01-31T00:00:00.000Z",
"updatedAt": "2027-01-31T00:00:00.000Z",
"revision": "01900000-0000-7000-8000-b7960e180000",
"revisionNum": 1
}
]
},
"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)