Get products list
You may have to review products to review or analyze them or create certain reports. This endpoint gets a paginated list of products (items, variants, and bundles) for the specified locales
. Note: Specify product IDs to get only those products. Or, you may mention offset
and limit
to refine the search results. When they’re not specified, by default, you’ll get up to 10 products.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
Unique request ID
Query Parameters
Comma-separated product IDs
Maximum number of records per page
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Product types that can be filtered are Item, Bundle, and Variant
ITEM
, VARIANT
, BUNDLE
Comma-separated locale codes of product. The service throws a 400 error if the locale isn't supported. Standard locales can be found at https://www.rfc-editor.org/rfc/rfc5646. <br /> Note: The recommended way to get the locale is by invoking multi-channel service.
Comma-separated statuses indicating the preferred order of the product versions considered for this operation (endpoint action). For example, <br />1. When the status is DRAFT
, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE
, this operation will only apply to the Live version of the product, if it exists <br />3 When the status is LIVE,DRAFT
, this operation will prioritize Live version first, if it exists. Otherwise, the Draft version is considered. <br />4 When the status is DRAFT,LIVE
this operation will prioritize the Draft version first, if it exists. Otherwise, the Live version is considered.
Sorting criteria. Supported values are sku
, and createdAt
. Note: -
refers to descending and +
refers to ascending order
Product types that can be filtered are Item, Bundle, and Variant. Supports multiple types when provided as comma separated types
Response
Product list by IDs
Number of records to skip before returning records. For example, offset=20, limit=10
returns records 21-30.
Maximum number of records per page
Total number of records in the response
Was this page helpful?