products

Fetch products matching the supplied arguments.

Arguments

ArgumentTypeRequiredDefaultDescription
skuStringNo

Filter by SKU. SKU matching is case-insensitive and ignores surrounding whitespace.

created_fromISODateTimeNo

Inclusive start of the created range, in ISO-8601 datetime format.

created_toISODateTimeNo

Inclusive end of the created range, in ISO-8601 datetime format.

updated_fromISODateTimeNo

Inclusive start of the updated range, in ISO-8601 datetime format.

updated_toISODateTimeNo

Inclusive end of the updated range, in ISO-8601 datetime format.

customer_account_idStringNo

If you are a 3PL you can specify one of your customer's account.

has_kitsBooleanNo

When true, filters results where has kits applies; when false, filters where it does not.

tag[String]No

Filters products that have ANY of the specified tags (OR).

tag_not_in[String]No

Excludes products that have ANY of the specified tags; untagged products are included.

analyzeBooleanNo

If true, the query will only be analyzed (cost estimated) without executing it.

Return Type

ProductsQueryResult

Query

query products(
  $sku: String,
  $created_from: ISODateTime,
  $created_to: ISODateTime,
  $updated_from: ISODateTime,
  $updated_to: ISODateTime,
  $customer_account_id: String,
  $has_kits: Boolean,
  $tag: [String],
  $tag_not_in: [String],
  $analyze: Boolean
) {
  products(
    sku: $sku,
    created_from: $created_from,
    created_to: $created_to,
    updated_from: $updated_from,
    updated_to: $updated_to,
    customer_account_id: $customer_account_id,
    has_kits: $has_kits,
    tag: $tag,
    tag_not_in: $tag_not_in,
    analyze: $analyze
  ) {
    request_id
    complexity
    data {
      ...ProductConnectionFragment
    }
  }
}

Variables

{
  "sku": "BLUE-TEE-M",
  "created_from": "2026-07-09T15:30:00Z",
  "created_to": "2026-07-09T15:30:00Z",
  "updated_from": "2026-07-09T15:30:00Z",
  "updated_to": "2026-07-09T15:30:00Z",
  "customer_account_id": "QWNjb3VudDoxMjM0",
  "has_kits": true,
  "tag": ["ANY"],
  "tag_not_in": ["ANY"],
  "analyze": true
}

Response

{
  "data": {
    "products": {
      "request_id": "UmVjb3JkOjEyMzQ=",
      "complexity": 100,
      "data": [{sku: "BLUE-TEE-M", name: "Blue Tee"}]
    }
  }
}