createPriceListEntry

mutation · in the family Price list entry

What it does

Create a new one price on a price list — a variant’s price in a currency at your organization.

Create a PriceListEntry — the splice insert.

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

Arguments

Name	Type	Required	Notes
`input`	NewPriceListEntryInput `NewPriceListEntryInput!`	yes	No further notes.

Returns

PriceListEntry PriceListEntry! — A PriceListEntry — ONE effective-dated price window per (list × single-axis merch target): the FOURTH DATED_SCHEDULE family (SalePrice → TaxRate → FxRate → this). List-parented (parentId = the PriceList ≠ rootId — the schedule dies with its list at purge). Windows are half-open [startAt, endAt) with endAt ALWAYS present (far-future = the standing price); no past starts; absent startAt = effective NOW (server-stamped). Inserts are splice-normalized per (list × targetKind × targetId) — classifySplice VERBATIM: a start falling STRICTLY inside the immediately-preceding window auto-TRIMS it (the ONE sanctioned in-place mutation — revisioned + evented); overlap with ANY OTHER record refuses CONFLICT/LIST_PRICE_WINDOW_OVERLAP naming the blockers (the family's OWN error row — the errors registry's ratified minting law). ≤1 EFFECTIVE entry per key at any instant BY the splice invariant — no uniqueness marker. Doom cancels a not-yet-effective FUTURE record only (an effective/lapsed record is IMMUTABLE price history — CONFLICT/IMMUTABLE; supersede it). The TARGET is a flag-discriminated SINGLE-axis ref (the commission-tuple class): variant | category | brand | division — category matches the SUBTREE rooted at the target (deepest node wins); IMMUTABLE with the window. The VALUE: fixed (house MoneyEntry) · percent_off_rrp (ppm off the Product's rrp entry in the ORDER currency) · cost_plus (ppm over the II's system-maintained wmaCost) — rounding half-away-from-zero; at capture a currency mismatch / absent basis / result ≤ 0 / unconvertible value FALLS THROUGH to the next plane; IMMUTABLE with the window (a renegotiated price is a NEW window — price history is fact). The edit surface is caption ONLY. ≤ 500 live entries per list (the create gate). NOT searchable (the SalePrice schedule-row class — reached via its list).

Example request

mutation ExampleCreatePriceListEntry($input: NewPriceListEntryInput!) {
  createPriceListEntry(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "priceListId": "01900000-0000-7000-8000-7844e9fb0000",
    "target": {
      "kind": "variant",
      "variantId": "01900000-0000-7000-8000-8415e73b0000"
    },
    "value": {
      "kind": "fixed",
      "price": {
        "currency": "USD",
        "amount": "10.00"
      }
    },
    "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": {
    "createPriceListEntry": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PE-EXMP-0000-000F",
      "type": "PriceListEntry",
      "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"
    }
  },
  "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

Price differently for a customer group