AlmondTill/G3N API

On this page

doomSalePrice

mutation · in the family Sale price

What it does

Permanently retire a sale price — a time-boxed promotional price.

Cancel a SCHEDULED SalePrice window: allowed ONLY while the record is not yet effective (now < startAt). An effective or lapsed window is immutable price history — CONFLICT/IMMUTABLE naming startAt vs now; supersede it with a new window instead. Requires the current revision (OCC) + the unrestricted capability; the record is kept, excluded from the schedule (no-delete).

Careful

Doom is forever — a doomed record never comes back into use (its history remains readable). Anything still referencing it live will block the doom.

Who may call it

Capability area: Pricing — Prices, price schedules, promotions, coupons and the money rules of selling.

Arguments

NameTypeRequiredNotes
idID ID!yesThe id of the record.
revisionID ID!yesThe revision id you read on the record; the change is refused if an edit landed in the meantime.
reasonStringnoNo further notes.

Returns

SalePrice 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

mutation ExampleDoomSalePrice($id: ID!, $revision: ID!, $reason: String) {
  doomSalePrice(id: $id, revision: $revision, reason: $reason) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
    markdownPlanId
    markdownStepIndex
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "reason": "Correcting a miscount."
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "doomSalePrice": {
      "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": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer