AlmondTill/G3N API

On this page

promotions

query · in the family Promotion

What it does

The promotion list — each entry is a promotion — an automatic price rule.

The caller's org-group family's ACTIVE LISTING of Promotions — doomed records DROP from listings.

What happens

Reads only — changes nothing.

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Returns

Promotion [Promotion!]! — A Promotion — the rule-based discount engine that EMITS source=promo LINE discount entries at the step-2 position 3 (after manual + coupon; the pipeline math was position-complete from birth — the build ANIMATES the dormant slot, the pattern). Org restriction is JUNCTION-LESS: the scope axes (channels/LFs/orgs) gate WHERE it fires; productScope (the CollectionPredicate VERBATIM + inclusions/exclusions + a Collection ref) gates WHAT lines match — ABSENT productScope = ALL product lines (the sitewide sale; open_item lines never match); cartConditions gate WHEN. Windows are half-open [startAt, endAt) — an EVALUATION gate, never FSM states (advance scheduling = create active with a future startAt; absent endAt = evergreen). Resolution is STRICT no-stack (priority asc, id asc; combinableGroup opts IN; exclusive blocks its lines). Emissions are ABSOLUTE amount entries computed to replay VERBATIM in the pipeline; order-target effects pre-allocate largest-remainder over the MATCHED lines ONLY. Redemptions count per ORDER in the place/accept transaction; a capped-out promotion silently STOPS FIRING. At most 128 ACTIVE per org group.

Example request

query ExamplePromotions {
  promotions {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
    priority
    exclusive
    combinableGroup
    maxDiscountPerLineMinor
    maxDiscountPerOrderMinor
    totalRedemptionsCap
    couponGated
    code
  }
}

Example response

{
  "data": {
    "promotions": [
      {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "sysId": "PM-EXMP-0000-000F",
        "type": "Promotion",
        "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",
        "priority": 1,
        "exclusive": true,
        "combinableGroup": "<combinable group>",
        "maxDiscountPerLineMinor": 1,
        "maxDiscountPerOrderMinor": 1,
        "totalRedemptionsCap": 1,
        "couponGated": true,
        "code": "BJ-001"
      }
    ]
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer