Skip to main content
GET
/
api-product
/
v1
/
product
Get items and children items
curl --request GET \
  --url https://live.copilot.fabric.inc/api-product/v1/product \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "totalSize": 100,
  "pageSize": 10,
  "pages": 10,
  "products": [
    {
      "sku": "MOBO-X570",
      "itemId": 4,
      "children": [
        {
          "sku": "<string>",
          "attributes": [
            {
              "id": "619a8ba6f1875f6dbcaf0521",
              "name": "notes",
              "description": "Notes for this particular category.",
              "type": "TEXT",
              "value": "Unable to fulfill demand.",
              "mapping": "description"
            }
          ]
        }
      ],
      "type": "ITEM",
      "status": true,
      "categories": [
        {
          "id": "621c121bff2e4507c199b7cb",
          "name": "electronics",
          "nodeId": 30,
          "breadcrumbs": [
            {
              "id": "621c10f3ff2e4507c199b66b",
              "nodeId": 31,
              "name": "PRIMARY",
              "attributes": [
                "<any>"
              ]
            }
          ]
        }
      ],
      "attributes": [
        {
          "id": "<any>",
          "name": "<any>",
          "description": "<any>",
          "type": "<any>",
          "value": "<any>",
          "mapping": "<any>"
        }
      ],
      "createdOn": "2022-03-07T22:50:10.668Z",
      "modifiedOn": "2022-03-07T22:52:01.720Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Query Parameters

​
skus
string[]

Stock Keeping Units (SKUs). <br /> Note: Either skus or itemIds can be used to get specific items. If they are omitted, all items are returned in a paginated response. Using the query parameters page and size, you can narrow down the search results.

​
itemIds
number[]

Item IDs. Applicable only when skus are omitted. <br /> Note: Either skus or itemIds can be used to get specific items. If they are omitted, all items are returned in a paginated response. Using the query parameters page and size, you can narrow down the search results.

​
page
number

Page number to be retrieved. Applicable only in a paginated response and always paired with size.

Example:

1

​
size
number

Number of records per page. Applicable only in a paginated response and always paired with page.

Example:

10

​
status
enum<string>

Item status. <br /> Note: <br /> 1) Returns a paginated response. <br /> 2) When used as the only criteria, must be paired with size and page to narrow down the search results.

Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

​
createdAfter
string

Lists items created after a specific date. Valid date formats are 'YYYY/MM/DD', 'YYYY-MM-DDTHH:mm:ss.SSSZ'. <br /> Note: <br /> 1) Applicable only when skus and itemIds are omitted. <br /> 2) Returns paginated response. <br /> 3) Must be paired with size and page to narrow down the search results.

Example:

"2021-05-28T16:36:50.055Z"

​
createdBefore
string

Lists items created before a specific date. Valid date formats are 'YYYY/MM/DD', 'YYYY-MM-DDTHH:mm:ss.SSSZ'. <br /> Note: <br /> 1) Applicable only when skus and itemIds are omitted. <br /> 2) Returns paginated response. <br /> 3) Must be paired with size and page to narrow down the search results.

Example:

"2021-05-28T16:36:50.055Z"

​
modifiedAfter
string

Lists items modified after a specific date. Valid date formats are 'YYYY/MM/DD', 'YYYY-MM-DDTHH:mm:ss.SSSZ'. <br /> Note: <br /> 1) Applicable only when skus or itemIds are omitted. <br /> 2) Returns paginated response. <br /> 3) Must be paired with size and page to narrow down the search results.

Example:

"2021-05-28T16:36:50.055Z"

​
modifiedBefore
string

Gets items modified before a specific date. Valid date formats are 'YYYY/MM/DD', 'YYYY-MM-DDTHH:mm:ss.SSSZ'. <br /> Note: <br /> 1) Applicable only when skus and itemIds are omitted. <br /> 2) Returns paginated response. <br /> 3) Must be paired with size and page to narrow down the search results.

Example:

"2021-05-28T16:36:50.055Z"

​
onlyIncludeAttributes
string[]

Attributes are included based on their exact, case-sensitive names. For example, if you specify the values as xyZ and Abc, the response will include these attributes in both parent and child objects.

​
onlyExcludeAttributes
string[]

Attributes are excluded based on their exact, case-sensitive names. For example, if you specify the values as xyZ and Abc, the response will exclude these attributes from both parent and child objects. <br /> Note: When both onlyIncludeAttributes and onlyExcludeAttributes are used, the onlyIncludeAttributes takes precedence. As a result, attributes are first filtered based on onlyIncludeAttributes, and then onlyExcludeAttributes is applied to further refine the selection.

Response

OK

  • Option 1
  • Option 2
  • Option 3
​
totalSize
number

Total number of records (items)

Example:

100

​
pageSize
number

Number of records (items) in a page

Example:

10

​
pages
number

Number of pages for the given pageSize

Example:

10

​
products
object[]