createMarkdownPlan

mutation · in the family Markdown plan

What it does

Create a new markdown plan — scheduled price cuts over time at your organization.

Create a MarkdownPlan in the caller's org group. The all-future/base/splice/cap gates run at SCHEDULE, not here.

Who may call it

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

• Owner
• Manager
• An API key whose scope allows api:createMarkdownPlan

Arguments

Returns

MarkdownPlan MarkdownPlan! — A MarkdownPlan — the markdown CADENCE: a product scope (the grammar VERBATIM — predicate + inclusions/exclusions + a Collection ref) + ≤ 8 ordered effective-dated steps (percent_off ppm-EXCLUSIVE · amount_off · to_fixed; startAt strictly increasing; the LAST step MAY carry endAt = the clearance-LAPSE arm, absent = the standing far-future window). the write rule: the schedule transition pre-computes the whole price LADDER per targeted InventoryItem (base₀ = the record covering step-1's startAt, then each PRIOR RESULT — half-away rounding, every result > 0) and WRITES EVERY future-dated SalePrice up-front through the existing per-record create (splice-gated, evented, plan/step-stamped; the FIRST window per II TRIMS the covering standing record; caps: ≤ 250 items · ≤ 500 writes). The prices then move by dated-window resolution ALONE — the scheduler fires ONLY the plan's own status flips (scheduled→active at the first step's moment · active→completed after the last; a down sweeper delays ZERO price moves — the flips are observability). The live splice law PROTECTS the cadence (an external overlapping write refuses CONFLICT/PRICE_WINDOW_OVERLAP naming the plan's records). Cancel dooms the not-yet-effective plan-stamped records ONLY (effective windows are permanent price history; the step-1 trim is NOT restored). A markdown MOVES the step-1 base — promotions/loyalty/employee compose on top UNCHANGED. Update is DRAFT-only (amend-after-schedule = cancel + author anew). At most 32 OPEN (draft+scheduled+active) per org group. Org participation is the canned-pool selection (≤ 32; ABSENT = every org); logicalFacilityIds (≤ 32) RESTRICTS within the selected orgs' facilities (ABSENT = all of them). NOT searchable (the document non-joiner stance — this born-paginated list is the discovery read); NO UNIQ marker.

Example request

mutation ExampleCreateMarkdownPlan($input: NewMarkdownPlanInput!) {
  createMarkdownPlan(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationIds
    logicalFacilityIds
    currency
    nextDueAt
    resolvedInventoryItemIds
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "productScope": {
      "predicate": {
        "categoryIds": [
          "01900000-0000-7000-8000-57cf15750000"
        ]
      }
    },
    "currency": "USD",
    "steps": [
      {
        "startAt": "2027-01-31T00:00:00.000Z",
        "move": {
          "kind": "percent_off",
          "percentPpm": 1
        },
        "endAt": "2027-01-31T00:00:00.000Z"
      }
    ]
  }
}

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

Example response

{
  "data": {
    "createMarkdownPlan": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "MD-EXMP-0000-000F",
      "type": "MarkdownPlan",
      "caption": "Blue jeans",
      "status": "draft",
      "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"
      ],
      "logicalFacilityIds": [
        "01900000-0000-7000-8000-2c5783bd0000"
      ],
      "currency": "USD",
      "nextDueAt": "2027-01-31T00:00:00.000Z",
      "resolvedInventoryItemIds": [
        "01900000-0000-7000-8000-0600d5020000"
      ]
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "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)
• CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
• VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

• Plan scheduled price cuts (a markdown)