On this page
customerPriceGroup
query · in the family Customer price group
What it does
Look up one record — a customer price group — named customers who get special pricing.
A CustomerPriceGroup 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:customerPriceGroup
Arguments
| Name | Type | Required | Notes |
|---|---|---|---|
id | ID ID! | yes | The id of the record. |
Returns
CustomerPriceGroup — A CustomerPriceGroup — the customer-classification / pricing-ELIGIBILITY axis (retail tiers: standard · member · vip · wholesale_lite — merchant-defined, the registry's roster is illustrative). An eligibility KEY, NOT a price store: the group carries NO rate fields — its benefits are expressed EXCLUSIVELY promotions scoped to it (PromotionScope.priceGroupIds); the priceListId CARRIER is live while the group itself stays rate-field-FREE (the anti-price-plane guard's letter: the PLANE is the PriceList's, the group is the eligibility KEY + the carrier). The axis law: CustomerPriceGroup = pricing eligibility · Segment = marketing audience · CorporateCustomer = B2B identity — three distinct axes a customer may carry independently. Assignment v1 rides the LoyaltyMember carrier (member.priceGroupId, the PRE- home; OrgCustomer and Consumer bind per their locks, the Consumer binding SUPERSEDES). Resolution DEGRADES: anonymous / no member / no group / group non-ACTIVE-or-deselected ⇒ no eligibility — a lapsed group NEVER kills a cart. Org participation is the canned-pool selection (≤ 32; ABSENT = every org). At most 32 ACTIVE per org group. Doom is -gated by non-doomed LoyaltyMembers carrying the group; deactivate stays FREE (a paused group's scoped promotions simply stop matching). NO code/identity — no UNIQ marker (nothing bearer-resolvable rides a group).
Example request
query ExampleCustomerPriceGroup($id: ID!) {
customerPriceGroup(id: $id) {
id
sysId
type
caption
status
parentId
rootId
createdAt
updatedAt
revisionNum
revision
organizationIds
priceListId
}
}
Variables:
{
"id": "01900000-0000-7000-8000-37386ae00000"
}
Example response
{
"data": {
"customerPriceGroup": {
"id": "01900000-0000-7000-8000-37386ae00000",
"sysId": "PG-EXMP-0000-000F",
"type": "CustomerPriceGroup",
"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",
"organizationIds": [
"01900000-0000-7000-8000-60e064dc0000"
],
"priceListId": "01900000-0000-7000-8000-7844e9fb0000"
}
},
"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)