Set up a new product line

How new merchandise becomes sellable: the brand exists first, the item wizard creates the style, product, and variant together, and a sale price makes it ring at the till.

Catalog · a guided walk in 3 steps.

The steps

1. Have the brand ready — Every style hangs from a brand — the maker label your goods sell under. — createBrand
2. Create the item — One pass creates the whole sellable item — the style, its product, and the variant — so nothing is born half-made. — createItem
3. Price it — A sale price is what the till charges — without one the item cannot ring. — createSalePrice

The calls

Every operation this use case runs, in the order it first appears, with the request and the response its reference page shows.

createBrand

createBrand — mutation · Create a new brand — a product building block at your organization.

Example request

mutation ExampleCreateBrand($input: NewBrandInput!) {
  createBrand(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    code
    description
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans"
  }
}

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

Example response

{
  "data": {
    "createBrand": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "BR-EXMP-0000-000F",
      "type": "Brand",
      "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",
      "code": "BJ-001",
      "description": "Straight-cut, mid-rise, five pockets."
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

createItem

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

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
        }
      }
    }
  }
}

createSalePrice

createSalePrice — mutation · Create a new sale price — a time-boxed promotional price at your organization.

Example request

mutation ExampleCreateSalePrice($input: NewSalePriceInput!) {
  createSalePrice(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
    startAt
    endAt
    markdownPlanId
    markdownStepIndex
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "inventoryItemId": "01900000-0000-7000-8000-9307d9650000",
    "endAt": "2027-01-31T00:00:00.000Z",
    "price": {
      "currency": "USD",
      "amount": "10.00"
    }
  }
}

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

Example response

{
  "data": {
    "createSalePrice": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "SP-EXMP-0000-000F",
      "type": "SalePrice",
      "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",
      "markdownPlanId": "01900000-0000-7000-8000-7b0984720000",
      "markdownStepIndex": 1
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}