createSalePrice

mutation · in the family Sale price

What it does

Create a new sale price — a time-boxed promotional price at your organization.

Create a SalePrice — the splice insert; requires the unrestricted capability.

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:createSalePrice

Arguments

Name	Type	Required	Notes
`input`	NewSalePriceInput `NewSalePriceInput!`	yes	No 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 ExampleCreateSalePrice($input: NewSalePriceInput!) {
  createSalePrice(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
    markdownPlanId
    markdownStepIndex
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
    "endAt": "2027-01-31T00:00:00.000Z",
    "price": {
      "currency": "USD",
      "amount": "10.00"
    }
  }
}

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

Example response

{
  "data": {
    "createSalePrice": {
      "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

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.