On this page
priceListEntry
query · in the family Price list entry
What it does
Look up one record — one price on a price list — a variant’s price in a currency.
A PriceListEntry 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:priceListEntry
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
PriceListEntry — A PriceListEntry — ONE effective-dated price window per (list × single-axis merch target): the FOURTH DATED_SCHEDULE family (SalePrice → TaxRate → FxRate → this). List-parented (parentId = the PriceList ≠ rootId — the schedule dies with its list at purge). Windows are half-open [startAt, endAt) with endAt ALWAYS present (far-future = the standing price); no past starts; absent startAt = effective NOW (server-stamped). Inserts are splice-normalized per (list × targetKind × targetId) — classifySplice VERBATIM: a start falling STRICTLY inside the immediately-preceding window auto-TRIMS it (the ONE sanctioned in-place mutation — revisioned + evented); overlap with ANY OTHER record refuses CONFLICT/LIST_PRICE_WINDOW_OVERLAP naming the blockers (the family's OWN error row — the errors registry's ratified minting law). ≤1 EFFECTIVE entry per key at any instant BY the splice invariant — no uniqueness marker. Doom cancels a not-yet-effective FUTURE record only (an effective/lapsed record is IMMUTABLE price history — CONFLICT/IMMUTABLE; supersede it). The TARGET is a flag-discriminated SINGLE-axis ref (the commission-tuple class): variant | category | brand | division — category matches the SUBTREE rooted at the target (deepest node wins); IMMUTABLE with the window. The VALUE: fixed (house MoneyEntry) · percent_off_rrp (ppm off the Product's rrp entry in the ORDER currency) · cost_plus (ppm over the II's system-maintained wmaCost) — rounding half-away-from-zero; at capture a currency mismatch / absent basis / result ≤ 0 / unconvertible value FALLS THROUGH to the next plane; IMMUTABLE with the window (a renegotiated price is a NEW window — price history is fact). The edit surface is caption ONLY. ≤ 500 live entries per list (the create gate). NOT searchable (the SalePrice schedule-row class — reached via its list).
Example request
query ExamplePriceListEntry($id: ID!) {
priceListEntry(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
startAt
endAt
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"priceListEntry": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "PE-EXMP-0000-000F",
"type": "PriceListEntry",
"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",
"startAt": "2027-01-31T00:00:00.000Z",
"endAt": "2027-01-31T00:00:00.000Z"
}
},
"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)