List products

get /rest/api/products

Retrieves the collection of Product resources.

Returns a paginated collection of products in the current organization, optionally filtered by channel, collection or status, and with pricing resolved against a given channel/country/time when resolveContext is set.

Polling for changes

Use updatedAt[after] with an ISO 8601 UTC timestamp to fetch only the products that have changed since your last sync. Combine with order[updatedAt]=asc to walk the change feed deterministically.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.
X-Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.
X-Flowkiwi-Locale-Fallback	boolean	-	Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from the default locale will be used.

Query parameters

Name	Type	Required	Description
resolveContext[channel]	string	-	Channel IRI used to resolve the variant price. Required together with resolveContext[country].
resolveContext[country]	string	-	Country IRI used to resolve the variant price. Required together with resolveContext[channel].
resolveContext[at]	string	-	ISO 8601 UTC timestamp at which the price is resolved. Defaults to the current time when omitted.
expand	string	-	Comma-separated list of relations to embed as full objects instead of IRI strings. Supported values: variants, options, optionValues, medias, category, collections, channels, metafields, metaobject. Tokens are independent; unknown values are silently ignored. optionValues only has a visible effect when combined with variants. medias and metafields apply to the product and, when combined with variants, to each variant. metaobject only has a visible effect when combined with metafields (it embeds the referenced metaobject on each metafield of type metaobject_reference or list__metaobject_reference).
page	integer	-	The collection page number
itemsPerPage	integer	-	The number of items per page
channels	string	-
channels[]	string[]	-
collections	string	-
collections[]	string[]	-
status	string	-
status[]	string[]	-
vendor	string	-
order[vendor]	string	-
order[createdAt]	string	-
order[updatedAt]	string	-
createdAt[before]	string	-
createdAt[strictly_before]	string	-
createdAt[after]	string	-
createdAt[strictly_after]	string	-
updatedAt[before]	string	-
updatedAt[strictly_before]	string	-
updatedAt[after]	string	-
updatedAt[strictly_after]	string	-
exists[variants]	boolean	-

Response

200 - Product collection

Property	Type	Required	Description
hydra:totalItems	integer	-
hydra:search	object	-
Show hydra:search fields Property Type Required Description @type string - hydra:template string - hydra:variableRepresentation string - hydra:mapping object[] - Show hydra:mapping fields Property Type Required Description @type string - variable string - property string | null - required boolean -
hydra:view	object	-
Show hydra:view fields Property Type Required Description @id string - @type string - hydra:first string - hydra:last string - hydra:previous string - hydra:next string -
hydra:member	Product[]	required
Show hydra:member fields Property Type Required Description @context object - @id string required @type string required id string - Stable UUID of the product. status string - The status of the product. vendor string | null - The name of the product's vendor. title string | null - This property supports translations. The name of the product. description string | null - This property supports translations. A description of the product. tags string | null - A string of comma-separated tags. variants string[] - A list of Variant, each one representing a variant associated with the product. Serialized as IRI strings by default; pass ?expand=variants to embed the full Variant objects (including resolvedPrice, lowestPriceLast30Days, medias, and metafields when composed with ?expand=metafields). options string[] - A list of Product Option, each one representing an option associated with the product. Serialized as IRI strings by default; pass ?expand=options to embed the full Product Option objects. category string | null - The category to which this product belongs. Serialized as IRI string by default; pass ?expand=category to embed the full CategoryResource. attributeValues array - A list of Attribute Values, each one representing an attribute value associated with the product. channels string[] - A list of Channel, each one representing a channel associated with the product. Serialized as IRI strings by default; pass ?expand=channels to embed full ChannelResource objects. collections string[] - A list of Collection, each one representing a collection associated with the product. Serialized as IRI strings by default; pass ?expand=collections to embed full CollectionResource objects. medias string[] - A list of Media, ordered by position. Only media of type "image" can be associated with a product. Returned as IRI strings by default; pass ?expand=medias to embed full Media objects. metafields string[] - Metafields owned by this product. Serialized as IRI strings by default; pass ?expand=metafields to embed full MetafieldResource objects. createdAt string - The date and time when the resource was created (ISO 8601 format). updatedAt string - The date and time when the resource was last modified (ISO 8601 format).

Errors

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.