updateWarrantyTerms

mutation · in the family Warranty terms

What it does

Edit warranty terms — what coverage a product carries — change its details.

Edit a WarrantyTerms'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: Purchasing — Purchase orders, returns to vendors, vendor invoices and supplier records.

Owner
Manager
Associate Manager
An API key whose scope allows api:updateWarrantyTerms

Arguments

Name	Type	Required	Notes
`id`	ID `ID!`	yes	The id of the record.
`revision`	ID `ID!`	yes	The revision id you read on the record; the change is refused if an edit landed in the meantime.
`input`	EditWarrantyTermsInput `EditWarrantyTermsInput!`	yes	No further notes.

Returns

WarrantyTerms WarrantyTerms! — Warranty terms — the WARRANTY POLICY TEMPLATE: provider + duration + coverage, attached to EXACTLY ONE of a Product or a Manufacturer (the manufacturer-attached row IS the reusable template). Group-scoped like a Brand (parent = the org group). The ATTACHMENT is the template's IDENTITY — IMMUTABLE at birth (re-attach = recreate); the POLICY payload stays mutable (the future warranty INSTANCE snapshots terms at sale, so a template edit never rewrites issued warranties). The warranty INSTANCE construct is NOT here.

Example request

mutation ExampleUpdateWarrantyTerms($id: ID!, $revision: ID!, $input: EditWarrantyTermsInput!) {
  updateWarrantyTerms(id: $id, revision: $revision, input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    provider
    durationDays
    coverage
    productId
    manufacturerId
  }
}

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": {
    "updateWarrantyTerms": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "WT-EXMP-0000-000F",
      "type": "WarrantyTerms",
      "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",
      "provider": "manufacturer",
      "durationDays": 1,
      "coverage": "<coverage>",
      "productId": "01900000-0000-7000-8000-969657010000",
      "manufacturerId": "01900000-0000-7000-8000-7cefed4d0000"
    }
  },
  "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

Set warranty terms and handle a claim