AlmondTill/G3N API

On this page

salePrice

query · in the family Sale price

What it does

Look up one record — a sale price — a time-boxed promotional price.

A SalePrice 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.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.

Returns

SalePrice — A sale price: ONE effective-dated price window in the parent InventoryItem schedule — the dated record-set IS the full price history. Windows are half-open [startAt, endAt) with endAt ALWAYS present (far-future = the standing price); past the last endAt with no successor the item is NOT for sale (the LAPSE rule — enforced by the sell path; stores + normalizes). Inserts are splice-normalized: a start falling STRICTLY inside the immediately-preceding window auto-TRIMS that predecessor endAt to the new start (the ONE sanctioned in-place mutation — revisioned + evented); overlap with ANY OTHER record refuses CONFLICT/PRICE_WINDOW_OVERLAP naming the blockers. No past starts. The schedule currency is FIXED by the FIRST record; a mismatch is refused NAMED. Doom cancels a not-yet-effective FUTURE record only. startAt/endAt/price are wire-IMMUTABLE.

Example request

query ExampleSalePrice($id: ID!) {
  salePrice(id: $id) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
    markdownPlanId
    markdownStepIndex
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000"
}

Example response

{
  "data": {
    "salePrice": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SP-EXMP-0000-000F",
      "type": "SalePrice",
      "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",
      "markdownPlanId": "01900000-0000-7000-8000-7b0984720000",
      "markdownStepIndex": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer