skuPatterns

Requires at least one of the permissions products:product:create or products:product:update.

Lists the organization's SKU patterns. Needs the products create or update permission.

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

query SkuPatterns {
  skuPatterns {
    id
    name
    createdAt
    brandId
    categoryId
    deletedAt
    brand {
      id
      code
      name
      createdAt
      deletedAt
      deletedBy
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query SkuPatterns {\n  skuPatterns {\n    id\n    name\n    createdAt\n    brandId\n    categoryId\n    deletedAt\n    brand {\n      id\n      code\n      name\n      createdAt\n      deletedAt\n      deletedBy\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "skuPatterns": [
      {
        "id": "id",
        "name": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "brandId": "id",
        "categoryId": "id",
        "deletedAt": "2025-01-15T00:00:00Z",
        "brand": {
          "id": "id",
          "code": "string",
          "name": "string",
          "createdAt": "2025-01-15T00:00:00Z",
          "deletedAt": "2025-01-15T00:00:00Z",
          "deletedBy": "string"
        }
      }
    ]
  }
}

skuPatterns: [SKUPattern!]!

Type

SKUPattern object

A rule that builds SKUs from placeholders such as brand, category and a running number.