createItem

mutation · in the family Catalog structure

What it does

Create a new item — a full style/product/variant family at your organization.

Create an ITEM — a zero-dimension simple Style + its whole-style Product + the single Variant — in ONE atomic transaction; requires the unrestricted capability. Returns the full trio.

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

Arguments

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

Returns

ItemCreation ItemCreation! — The composite item-create result — the zero-dimension simple Style + the whole-style Product + the single Variant, ALL born in ONE atomic transaction.

Example request

mutation ExampleCreateItem($input: NewItemInput!) {
  createItem(input: $input) {
    style {
      id
      sysId
      type
      caption
      status
      parentId
      rootId
      createdAt
      updatedAt
      revisionNum
      revision
      styleType
      brandId
      sizeRunId
      seasonIds
      tagIds
      code
      taxCategory
    }
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "product": {
      "caption": "Blue jeans",
      "rrp": [
        {
          "currency": "USD",
          "amount": "10.00"
        }
      ]
    },
    "variant": {
      "caption": "Blue jeans"
    }
  }
}

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

Example response

{
  "data": {
    "createItem": {
      "style": {
        "id": "01900000-0000-7000-8000-37386ae00000",
        "sysId": "ST-EXMP-0000-000F",
        "type": "Style",
        "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",
        "styleType": "simple",
        "brandId": "01900000-0000-7000-8000-4067736b0000",
        "sizeRunId": "01900000-0000-7000-8000-d314eddc0000",
        "seasonIds": [
          "01900000-0000-7000-8000-92b52b220000"
        ],
        "tagIds": [
          "01900000-0000-7000-8000-decd62770000"
        ],
        "code": "BJ-001",
        "taxCategory": "standard"
      }
    }
  },
  "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.