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": [
            {
              "id": "621c10f3ff2e4507c199b66b",
              "nodeId": 31,
              "name": "PRIMARY",
              "attributes": [
                {
                  "id": "619a8ba6f1875f6dbcaf0521",
                  "name": "notes",
                  "description": "Notes for this particular category.",
                  "type": "TEXT",
                  "value": "Unable to fulfill demand.",
                  "mapping": "description"
                }
              ]
            }
          ]
        }
      ],
      "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": [
            {
              "id": "619a8ba6f1875f6dbcaf0521",
              "name": "notes",
              "description": "Notes for this particular category.",
              "type": "TEXT",
              "value": "Unable to fulfill demand.",
              "mapping": "description"
            }
          ]
        }
      ]
    }
  ]
}

GET

api-product

product

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": [
            {
              "id": "621c10f3ff2e4507c199b66b",
              "nodeId": 31,
              "name": "PRIMARY",
              "attributes": [
                {
                  "id": "619a8ba6f1875f6dbcaf0521",
                  "name": "notes",
                  "description": "Notes for this particular category.",
                  "type": "TEXT",
                  "value": "Unable to fulfill demand.",
                  "mapping": "description"
                }
              ]
            }
          ]
        }
      ],
      "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": [
            {
              "id": "619a8ba6f1875f6dbcaf0521",
              "name": "notes",
              "description": "Notes for this particular category.",
              "type": "TEXT",
              "value": "Unable to fulfill demand.",
              "mapping": "description"
            }
          ]
        }
      ]
    }
  ]
}

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.
Note: If omitted, all items are retrieved.
Applicable only when keyword is omitted.

itemIds

string[]

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

page

number

Page number to be retrieved.

size

integer

Number of records per page.
Note: 1) Always paired with page.
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.
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
false: Includes children items

Example:

false

onlyChildren

boolean

true: Excludes parent items
false: Includes parent items

Example:

true

Response

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[]

Show child attributes

products.sku

string

Stock Keeping Unit (SKU) of item

Example:

"MSI-Z490"

products.itemId

number

Item ID

Example:

2

products.type

string

default:ITEM

Item type - either ITEM or BUNDLE

Example:

"ITEM"

products.categories

object[]

Show child attributes

products.categories.id

string

A 24-character system-generated category ID

Example:

"621c121bff2e4507c199b7cb"

products.categories.name

string

Category name

Example:

"electronics"

products.categories.nodeId

number

Numeric category ID

Example:

30

products.categories.breadcrumbs

object[]

Show child attributes

products.categories.breadcrumbs.id

string

A 24-character system-generated breadcrumb ID

Example:

"621c10f3ff2e4507c199b66b"

products.categories.breadcrumbs.nodeId

number

Numeric category ID

Example:

31

products.categories.breadcrumbs.name

string

Category name

Example:

"PRIMARY"

products.categories.breadcrumbs.attributes

object[]

Show child attributes

products.categories.breadcrumbs.attributes.id

string

A 24-character system-generated attribute ID

Example:

"619a8ba6f1875f6dbcaf0521"

products.categories.breadcrumbs.attributes.name

string

Attribute name

Example:

"notes"

products.categories.breadcrumbs.attributes.description

string

Attribute description Explains purpose of the selected attribute

Example:

"Notes for this particular category."

products.categories.breadcrumbs.attributes.type

enum<string>

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

Example:

"TEXT"

products.categories.breadcrumbs.attributes.value

string

Value corresponding to type

Example:

"Unable to fulfill demand."

products.categories.breadcrumbs.attributes.mapping

string

Attribute mapping (as received)

Example:

"description"

products.attributes

object[]

Show child attributes

products.attributes.id

string

A 24-character system-generated attribute ID

Example:

"619a8ba6f1875f6dbcaf0521"

products.attributes.name

string

Attribute name

Example:

"notes"

products.attributes.description

string

Attribute description Explains purpose of the selected attribute

Example:

"Notes for this particular category."

products.attributes.type

enum<string>

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

Example:

"TEXT"

products.attributes.value

string

Value corresponding to type

Example:

"Unable to fulfill demand."

products.attributes.mapping

string

Attribute mapping (as received)

Example:

"description"

products.dependents

string[]

Children SKUs

products.createdOn

string

Time when the item was added to Product Catalog (UTC format)

Example:

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

products.modifiedOn

string

Time when item was last updated (UTC format)

Example:

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

products.children

object[]

Show child attributes

products.children.sku

string

Stock Keeping Unit (SKU) of item

products.children.attributes

object[]

Show child attributes

products.children.attributes.id

string

A 24-character system-generated attribute ID

Example:

"619a8ba6f1875f6dbcaf0521"

products.children.attributes.name

string

Attribute name

Example:

"notes"

products.children.attributes.description

string

Attribute description Explains purpose of the selected attribute

Example:

"Notes for this particular category."

products.children.attributes.type

enum<string>

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

Example:

"TEXT"

products.children.attributes.value

string

Value corresponding to type

Example:

"Unable to fulfill demand."

products.children.attributes.mapping

string

Attribute mapping (as received)

Example:

"description"

Get items and limited children items Get item attributes

⌘I

Authentication v1

User Self Service APIs

Experiences v2 (XM v2)

Experiences v1 (XM v1)

Product Catalog

Orders v2 (OMS v2)

Orders v1 (OMS v1)

Offers v2

Offers v1

Subscriptions (SMT API)

Loyalty (Member)

Dropship

Cart API

Checkout API

Customer

Find items

Authorizations

Headers

Query Parameters

Response