createOptionValue

mutation · in the family Option value

What it does

Create a new one value inside an option group (like “Large” or “Red”) at your organization.

Create an OptionValue under an OptionGroup in the caller's org group; requires the unrestricted capability.

Who may call it

Capability area: Catalog structure — Creating and retiring catalog families and whole items.

Owner
Manager
An API key whose scope allows api:createOptionValue

Arguments

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

Returns

OptionValue OptionValue! — An option value — one member of an OptionGroup pick-source (a size cell, a color name), ORDERED via ordinal (lower = earlier in the pick list; ties break by id). Parent = its OptionGroup (NOT the family root — the first non-group-parented catalog construct, the Zone shape). Consumed by the spine (scheme tiers pick values into Product/Variant cells).

Example request

mutation ExampleCreateOptionValue($input: NewOptionValueInput!) {
  createOptionValue(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    ordinal
    code
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "optionGroupId": "01900000-0000-7000-8000-14f0cf6a0000"
  }
}

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

Example response

{
  "data": {
    "createOptionValue": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "OV-EXMP-0000-000F",
      "type": "OptionValue",
      "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",
      "ordinal": 1,
      "code": "BJ-001"
    }
  },
  "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

Describe how products vary — sizes, colours, options