GET
/
products
{
  "data": [
    {
      "id": "8d7329dfd5288b0011332376",
      "sku": "QWERTTY56DDFFVVV",
      "type": "ITEM",
      "isActive": true,
      "hasDraft": true,
      "hasLive": true,
      "status": "LIVE",
      "attributes": [
        {
          "id": "6d7329dfd5288b0011332345",
          "name": "Color",
          "type": "string",
          "isDeleted": false,
          "value": "blue",
          "isInherited": true
        }
      ],
      "localizedProperties": {
        "en-US": {
          "attributes": [
            {
              "id": "517329dfd5288b0011332315",
              "name": "Color",
              "type": "string",
              "isDeleted": false,
              "value": "blue",
              "isInherited": true
            }
          ]
        },
        "en-IN": {
          "attributes": [
            {
              "id": "617329dfd5288b0011332316",
              "name": "Colour",
              "type": "string",
              "isDeleted": false,
              "value": "blue",
              "isInherited": true
            }
          ]
        }
      },
      "variants": [
        {
          "id": "717329dfd5288b0011332317"
        }
      ],
      "categoryId": "5e7329dfd5288b00113323e4",
      "createdAt": "2021-09-14T22:10:30.618Z",
      "updatedAt": "2021-09-14T22:10:30.618Z"
    }
  ],
  "offset": 5,
  "limit": 10,
  "count": 100
}

Authorizations

​
Authorization
string
headerrequired

S2S access token (JWT) from fabric Identity service (during Login)

Headers

​
x-fabric-tenant-id
string

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.

​
x-fabric-request-id
string

Unique request ID

Query Parameters

​
ids
string

Comma-separated product IDs

​
limit
integer
default: 10

Maximum number of records per page

​
offset
integer
default: 0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

​
type
enum<string>
deprecated

Product types that can be filtered are Item, Bundle, and Variant

Available options:
ITEM,
VARIANT,
BUNDLE
​
locales
string

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.

​
statuses
string
default: DRAFT,LIVE

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.

​
sort
string

Sorting criteria. Supported values are sku, and createdAt. Note: - refers to descending and + refers to ascending order

​
types
string

Product types that can be filtered are Item, Bundle, and Variant. Supports multiple types when provided as comma separated types

Response

200 - application/json

Product list by IDs

​
offset
integer
default: 0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

​
limit
integer
default: 10

Maximum number of records per page

​
count
integer

Total number of records in the response

​
data
object[]

Was this page helpful?

Find productsUpdate product attributes by ID