Skip to main content
GET
/
api-product
/
v1
/
product
/
search
Find items
curl --request GET \
  --url https://live.copilot.fabric.inc/api-product/v1/product/search \
  --header 'Authorization: Bearer <token>' \
  --header 'x-site-context: <x-site-context>'
{
  "totalSize": 100,
  "pageSize": 10,
  "pages": 10,
  "products": [
    {
      "sku": "MSI-Z490",
      "itemId": 2,
      "type": "ITEM",
      "categories": [
        {
          "id": "621c121bff2e4507c199b7cb",
          "name": "electronics",
          "nodeId": 30,
          "breadcrumbs": [
            "<any>"
          ]
        }
      ],
      "attributes": [
        {
          "id": "619a8ba6f1875f6dbcaf0521",
          "name": "notes",
          "description": "Notes for this particular category.",
          "type": "TEXT",
          "value": "Unable to fulfill demand.",
          "mapping": "description"
        }
      ],
      "dependents": [
        [
          "Child1",
          "Child2"
        ]
      ],
      "createdOn": "2021-05-28T16:36:50.055Z",
      "modifiedOn": "2021-05-28T16:36:50.055Z",
      "children": [
        {
          "sku": "<string>",
          "attributes": [
            {}
          ]
        }
      ]
    }
  ]
}

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

​
keyword
string

Keywords related to SKU or title

Example:

"MOBO-1024"

​
skus
string[]

Searches for items based on SKU. <br /> Note: If omitted, all items are retrieved. <br /> Applicable only when keyword is omitted.

​
itemIds
string[]

Item IDs. <br /> Note: If omitted, all items are retrieved <br /> Applicable only when keyword and skus are omitted.

​
page
number

Page number to be retrieved.

​
size
integer

Number of records per page. <br />Note: 1) Always paired with page. <br />2) Applicable only in a paginated response.

​
type
enum<string>

Item type

Available options:
ITEM,
BUNDLE,
ALL
Example:

"ITEM"

​
allAttributes
boolean

true: Gets all attributes. false: Gets only the mapped attributes. <br /> Note: Always clubbed with page and size. When they are not specified, you will get up to 10 records.

Example:

true

​
excludeChildren
boolean

true: Excludes children items <br /> false: Includes children items

Example:

false

​
onlyChildren
boolean

true: Excludes parent items <br /> false: Includes parent items

Example:

true

Response

OK

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

Total number of records

Example:

100

​
pageSize
number

Number of records per page

Example:

10

​
pages
number

Number of pages for the given pageSize

Example:

10

​
products
object[]