createProductVariant

Requires permission products:product:create.

Adds a variant to a product. The SKU must not already be in use. Setting opening stock needs the permission to adjust stock. Requires permission to create products.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation CreateProductVariant($createProductVariantInput: CreateProductVariantInput!, $productId: ID!) {
  createProductVariant(
    createProductVariantInput: $createProductVariantInput
    productId: $productId
  ) {
    id
    QRCode
    name
    createdAt
    attributes
    barcode
    baseUOM {
      id
      code
      colorCode
      name
      pluralName
      createdAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CreateProductVariant($createProductVariantInput: CreateProductVariantInput!, $productId: ID!) {\n  createProductVariant(\n    createProductVariantInput: $createProductVariantInput\n    productId: $productId\n  ) {\n    id\n    QRCode\n    name\n    createdAt\n    attributes\n    barcode\n    baseUOM {\n      id\n      code\n      colorCode\n      name\n      pluralName\n      createdAt\n    }\n  }\n}",
  "variables": {
    "createProductVariantInput": {
      "isActive": true,
      "minOrderQuantity": 0
    },
    "productId": "id"
  }
}
EOF

Variables:

{
  "createProductVariantInput": {
    "isActive": true,
    "minOrderQuantity": 0
  },
  "productId": "id"
}

Response:

{
  "data": {
    "createProductVariant": {
      "id": "id",
      "QRCode": "string",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "attributes": {},
      "barcode": "string",
      "baseUOM": {
        "id": "id",
        "code": "string",
        "colorCode": "string",
        "name": "string",
        "pluralName": "string",
        "createdAt": "2025-01-15T00:00:00Z"
      }
    }
  }
}

createProductVariant(
  createProductVariantInput: CreateProductVariantInput!
  productId: ID!
): ProductVariant!

Arguments

createProductVariant.createProductVariantInput ● CreateProductVariantInput! non-null input

The details of the variant to create.

createProductVariant.productId ● ID! non-null scalar

The ID of the product to add the variant to.

Type

ProductVariant object

A sellable version of a product, with its own SKU, price, units of measure and stock.