updatePriceList

mutation · in the family Price list

What it does

Edit a price list — a named set of prices — change its details.

Edit a PriceList's mutable attributes. Requires the unrestricted capability + the record's CURRENT revision.

Careful

Edits take effect immediately and write a new revision; the old revision stays in history.

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

Arguments

Returns

PriceList PriceList! — A PriceList — a named ALTERNATE base-price plane (a 'price book'): the pipeline STEP-1 base for eligible customers, resolved at line capture ContractPrice → assigned PriceList → SalePrice and snapshotted IMMUTABLE at capture. ≠ step-2 discounts (promos/coupons/loyalty/employee compute OFF the captured base); ≠ markdowns (which WRITE SalePrice records — a list is READ-THROUGH at capture: nothing moves on a date, ZERO SCHEDULED_DUE growth; the resolve-time window IS the gating). THE CONTRACT SCOPE: orgCustomerId? — the lock's ContractPrice IS a PriceList scoped to ONE OrgCustomer, NOT a third construct: set at create, IMMUTABLE thereafter (the Edit shape excludes it — author a new list); a SCOPED list REQUIRES both window bounds (the contract TERM — STRICT). The effective window [startAt, endAt) is half-open and optional-per-side on an UNSCOPED list (absent = boundless); non-ACTIVE / out-of-window / org-unselected ⇒ the whole plane FALLS THROUGH silently at capture (the / degrade class — the LAPSE law STANDS: the effective SalePrice window remains REQUIRED, a plane hit overrides the captured VALUE only). Entries are child PriceListEntry dated windows (≤ 500 live per list); carrier law: a scoped list may be carried ONLY by its scoped OrgCustomer's priceListId, a CustomerPriceGroup carries UNSCOPED lists only. Org participation is the canned-pool selection (≤ 32; ABSENT = every org); at most 32 ACTIVE per org group (the create/reactivate gate). SEARCHABLE (the book law — the Promotion/LP/CPG/Affiliate operational-master class). Doom ← non-doomed OrgCustomer/CustomerPriceGroup carriers (the THIRD carrier-gated doom family); its OWN entries never block (they die with the plane at purge). NO UNIQ marker (captions are non-unique; nothing bearer-resolvable).

Example request

mutation ExampleUpdatePriceList($id: ID!, $revision: ID!, $input: EditPriceListInput!) {
  updatePriceList(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    organizationIds
    startAt
    endAt
    orgCustomerId
  }
}

Variables:

{
  "id": "01900000-0000-7000-8000-37386ae00000",
  "revision": "01900000-0000-7000-8000-b7960e180000",
  "input": {
    "caption": "Blue jeans"
  }
}

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

Example response

{
  "data": {
    "updatePriceList": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "PB-EXMP-0000-000F",
      "type": "PriceList",
      "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",
      "organizationIds": [
        "01900000-0000-7000-8000-60e064dc0000"
      ],
      "startAt": "2027-01-31T00:00:00.000Z",
      "endAt": "2027-01-31T00:00:00.000Z",
      "orgCustomerId": "01900000-0000-7000-8000-ba56ff800000"
    }
  },
  "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.