products_read
Arguments
ID!
required
The id of the product family to fetch.
Returns
A merchant catalog item — a group of related products (variants).
Show fields
Show fields
Look up a single attribute on this family by its name, if set.Requires:
products_readShow fields
Show fields
ArgumentsFields
String!
required
The machine name of the attribute to look up.
String
An optional description of what the attribute represents.
String!
required
The human-readable label shown for the attribute.
ID!
required
The unique identifier of the attribute’s definition.
String!
required
The attribute’s machine name, unique within the account.
required
The data type of the attribute’s value.
required
The merchant-defined attributes set on this family.
Show fields
Show fields
String
An optional description of what the attribute represents.
String!
required
The human-readable label shown for the attribute.
ID!
required
The unique identifier of the attribute’s definition.
String!
required
The attribute’s machine name, unique within the account.
required
The data type of the attribute’s value.
String!
required
The product family’s long-form description.
ID!
required
The id of this product family.
The first (default) image for this family, if any.Requires:
products_readrequired
A paginated list of the family’s images.Requires:
products_readShow fields
Show fields
ArgumentsFields
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.required
required
A paginated list of the products (variants) in this family.Requires:
products_readShow fields
Show fields
ArgumentsFields
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
Look up a single attribute on this product by its name, if set.Requires:
products_readShow fields
Show fields
Arguments
String!
required
The machine name of the attribute to look up.
required
The merchant-defined attributes set on this product.
[String!]!
required
Barcodes associated with this product.
String!
required
The product’s long-form description.
The product’s length, width, and height, expressed in a single shared unit.
String
The Harmonized System code used for customs.
ID!
required
The id of this product.
The first (default) image for this product, if any.Requires:
products_readrequired
A paginated list of the product’s images.Requires:
products_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.This product’s inventory level at a single location, if any.Requires:
inventory_readShow fields
Show fields
Arguments
ID!
required
The id of the location to fetch the level at.
Per-location inventory levels for this product.Requires:
inventory_readShow fields
Show fields
Arguments
String
Forward pagination cursor — returns items after it. Pass an
edges[].cursor or pageInfo.endCursor from a previous page.String
Backward pagination cursor — returns items before it. Pass an
edges[].cursor or pageInfo.startCursor from a previous page.Int
Forward pagination: returns the first N items (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N items (max 100, default 25). Use with
before; mutually exclusive with first/after.required
The variant’s selected option values (e.g. Size: M, Color: Red), ordered by the family’s option positions.
String
The country of origin, as a country code.
Boolean!
required
Whether the product is a physical, shippable item.
The product family this product belongs to, if any.Requires:
products_readString
The stock keeping unit identifying this product.
[String!]!
required
Free-form tags applied to the product.
String
The tax code used to classify the product for taxation.
Boolean!
required
Whether the product is subject to tax.
String!
required
The product’s title.
String
The Universal Product Code for this product.
String
The vendor or manufacturer of the product.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.[String!]!
required
Free-form tags applied to the product family.
String!
required
The product family’s title.
String
The vendor or manufacturer of the product family.
Example
query {
productFamily(id: "...") {
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
# ...
}
}