> ## Documentation Index
> Fetch the complete documentation index at: https://redo-44af351d-docs-v3-graphql-api-reference.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# createProductFamily
> Create a new product family.
**Required scopes:**
[`products_write`](/docs/api-reference/v3/reference/scopes#scope-products_write)
## Arguments
CreateProductFamilyInput!} required>
The details of the product family to create.
The product family's long-form description.
[ProductFamilyOptionInput!]}>
The variant options to create on the family.
The option's name (e.g. Size).
The option's ordering position within the family.
The allowed values for this option (e.g. S, M, L).
[CreateProductInput!]}>
The products (variants) to create under the family.
[ProductOptionValueInput!]}>
The product's selected values for the family's options.
MoneyInput}>
The product's selling price.
The stock keeping unit for the product.
The product's title.
Free-form tags to apply to the product family.
The product family's title.
The vendor or manufacturer of the product family.
## Returns
ProductFamily!} required>
A merchant catalog item — a group of related products (variants).
Attribute}>
Look up a single attribute on this family by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
**Fields**
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
[Attribute!]!} required>
The merchant-defined attributes set on this family.
An optional description of what the attribute represents.
The human-readable label shown for the attribute.
The unique identifier of the attribute's definition.
The attribute's machine name, unique within the account.
AttributeType!} required>
The data type of the attribute's value.
JSON}>
The attribute's value, resolved to the typed JSON form for its `type` — read `type` to know the shape. E.g. SHORT\_TEXT → a string, WEIGHT → \{ value, unit }, MONEY → \{ amount, currency }. Null if unset. See AttributeType for each type's shape.
DateTime!} required>
When the record was created.
The product family's long-form description.
The id of this product family.
ProductFamilyImage}>
The first (default) image for this family, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
ProductFamilyImageConnection!} required>
A paginated list of the family's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductFamilyImageEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
ProductFamilyImage!} required>
The item at this edge.
[ProductFamilyImage!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Alternative text describing the image.
Whether this is the default image.
The id of this image.
The image's ordering position.
The public URL of the image.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
[ProductFamilyOption!]!} required>
The variant options (e.g. Size, Color) for this family.
The id of this option.
The option's name (e.g. Size).
The option's ordering position within the family.
The allowed values for this option (e.g. S, M, L).
ProductConnection!} required>
A paginated list of the products (variants) in this family.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[ProductEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
Product!} required>
The item at this edge.
[Product!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
Attribute}>
Look up a single attribute on this product by its name, if set.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
The machine name of the attribute to look up.
[Attribute!]!} required>
The merchant-defined attributes set on this product.
Barcodes associated with this product.
Money}>
The merchant's unit cost for the product.
DateTime!} required>
When the record was created.
The product's long-form description.
Dimensions}>
The product's length, width, and height, expressed in a single shared unit.
The Harmonized System code used for customs.
The id of this product.
ProductImage}>
The first (default) image for this product, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
ProductImageConnection!} required>
A paginated list of the product's images.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
LocationInventoryLevel}>
This product's inventory level at a single location, if any.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
The id of the location to fetch the level at.
LocationInventoryLevelConnection!} required>
Per-location inventory levels for this product.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
[ProductOptionValue!]!} required>
The variant's selected option values (e.g. Size: M, Color: Red), ordered by the family's option positions.
The country of origin, as a country code.
Whether the product is a physical, shippable item.
Money}>
The product's selling price.
ProductFamily}>
The product family this product belongs to, if any.
**Requires:** [`products_read`](/docs/api-reference/v3/reference/scopes#scope-products_read)
The stock keeping unit identifying this product.
Free-form tags applied to the product.
The tax code used to classify the product for taxation.
Whether the product is subject to tax.
The product's title.
The Universal Product Code for this product.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product.
Weight}>
The product's weight.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
Free-form tags applied to the product family.
The product family's title.
DateTime!} required>
When the record was last updated.
The vendor or manufacturer of the product family.
## Example
```graphql theme={null}
mutation {
createProductFamily(input: { ... }) {
createdAt
description
id
images {
nodes {
altText
default
id
position
url
}
pageInfo { hasNextPage endCursor }
}
products {
nodes {
barcodes
createdAt
description
hsCode
id
originCountry
physicalItem
sku
# ...
}
pageInfo { hasNextPage endCursor }
}
tags
title
updatedAt
# ...
}
}
```