Find attribute groups

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute-group/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "page": 0,
  "size": 10,
  "include": {
    "attributes": true
  },
  "match": {
    "target": "ITEM",
    "or": [
      {
        "name": "weight"
      }
    ]
  },
  "sort": [
    {
      "field": "priorityOrder",
      "direction": "DESC"
    }
  ]
}
'

{
  "totalSize": 7,
  "pageSize": 10,
  "pages": 1,
  "attributeGroups": [
    {
      "_id": "6259ec8d006b0d00092b3189",
      "description": "Item weight, in KG",
      "type": "COLLECTION",
      "name": "weight",
      "priorityOrder": 1,
      "createdOn": "2022-04-15T22:07:09.921Z",
      "modifiedOn": "2022-04-15T22:10:05.427Z",
      "totalAttributes": 1,
      "EditableAttributes": [
        {
          "_id": "6259ec8defc2116dd6c0f3fc",
          "attributeGroupId": "6259ec8d006b0d00092b3189",
          "attributeId": "6245f16d11ae770009f19292",
          "isEditable": true,
          "createdOn": "2022-04-15T22:07:09.932Z",
          "modifiedOn": "2022-04-15T22:10:05.444Z",
          "order": 0,
          "attribute": [
            {
              "_id": "6259ec8defc2116dd6c0f3fc",
              "description": "Item weight, in KG.",
              "formulaManuallyOverWritten": false,
              "formula": null,
              "type": "TEXT",
              "name": "weight",
              "textSubType": "SMALL_TEXT",
              "attributeValidationId": "624d92f8caa34e0009b5d849",
              "modifiedBy": "60aad2c835c5fb000885f679",
              "createdOn": "2022-04-15T22:07:09.932Z",
              "modifiedOn": "2022-04-15T22:10:05.444Z"
            }
          ]
        }
      ],
      "ReadOnlyAttributes": [
        {
          "_id": "6259ec8defc2116dd6c0f3fc",
          "attributeGroupId": "6259ec8d006b0d00092b3189",
          "attributeId": "6245f16d11ae770009f19292",
          "isEditable": true,
          "createdOn": "2022-04-15T22:07:09.932Z",
          "modifiedOn": "2022-04-15T22:10:05.444Z",
          "order": 0,
          "attribute": [
            {
              "_id": "6259ec8defc2116dd6c0f3fc",
              "description": "Item weight, in KG.",
              "formulaManuallyOverWritten": false,
              "formula": null,
              "type": "TEXT",
              "name": "weight",
              "textSubType": "SMALL_TEXT",
              "attributeValidationId": "624d92f8caa34e0009b5d849",
              "modifiedBy": "60aad2c835c5fb000885f679",
              "createdOn": "2022-04-15T22:07:09.932Z",
              "modifiedOn": "2022-04-15T22:10:05.444Z"
            }
          ]
        }
      ],
      "WorkflowAttributes": [
        {}
      ],
      "ImpactedAttributes": [
        {}
      ]
    }
  ]
}

POST

api-product

product

attribute-group

Find attribute groups

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute-group/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "page": 0,
  "size": 10,
  "include": {
    "attributes": true
  },
  "match": {
    "target": "ITEM",
    "or": [
      {
        "name": "weight"
      }
    ]
  },
  "sort": [
    {
      "field": "priorityOrder",
      "direction": "DESC"
    }
  ]
}
'

{
  "totalSize": 7,
  "pageSize": 10,
  "pages": 1,
  "attributeGroups": [
    {
      "_id": "6259ec8d006b0d00092b3189",
      "description": "Item weight, in KG",
      "type": "COLLECTION",
      "name": "weight",
      "priorityOrder": 1,
      "createdOn": "2022-04-15T22:07:09.921Z",
      "modifiedOn": "2022-04-15T22:10:05.427Z",
      "totalAttributes": 1,
      "EditableAttributes": [
        {
          "_id": "6259ec8defc2116dd6c0f3fc",
          "attributeGroupId": "6259ec8d006b0d00092b3189",
          "attributeId": "6245f16d11ae770009f19292",
          "isEditable": true,
          "createdOn": "2022-04-15T22:07:09.932Z",
          "modifiedOn": "2022-04-15T22:10:05.444Z",
          "order": 0,
          "attribute": [
            {
              "_id": "6259ec8defc2116dd6c0f3fc",
              "description": "Item weight, in KG.",
              "formulaManuallyOverWritten": false,
              "formula": null,
              "type": "TEXT",
              "name": "weight",
              "textSubType": "SMALL_TEXT",
              "attributeValidationId": "624d92f8caa34e0009b5d849",
              "modifiedBy": "60aad2c835c5fb000885f679",
              "createdOn": "2022-04-15T22:07:09.932Z",
              "modifiedOn": "2022-04-15T22:10:05.444Z"
            }
          ]
        }
      ],
      "ReadOnlyAttributes": [
        {
          "_id": "6259ec8defc2116dd6c0f3fc",
          "attributeGroupId": "6259ec8d006b0d00092b3189",
          "attributeId": "6245f16d11ae770009f19292",
          "isEditable": true,
          "createdOn": "2022-04-15T22:07:09.932Z",
          "modifiedOn": "2022-04-15T22:10:05.444Z",
          "order": 0,
          "attribute": [
            {
              "_id": "6259ec8defc2116dd6c0f3fc",
              "description": "Item weight, in KG.",
              "formulaManuallyOverWritten": false,
              "formula": null,
              "type": "TEXT",
              "name": "weight",
              "textSubType": "SMALL_TEXT",
              "attributeValidationId": "624d92f8caa34e0009b5d849",
              "modifiedBy": "60aad2c835c5fb000885f679",
              "createdOn": "2022-04-15T22:07:09.932Z",
              "modifiedOn": "2022-04-15T22:10:05.444Z"
            }
          ]
        }
      ],
      "WorkflowAttributes": [
        {}
      ],
      "ImpactedAttributes": [
        {}
      ]
    }
  ]
}

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\"}"

Body

application/json

page

number

Page number to be retrieved

Example:

0

size

number

Number of records (attribute groups) per page

Example:

10

include

object

Show child attributes

include.attributes

boolean

true: Includes attributes
false: Excludes attributes

match

object

Show child attributes

match.target

string

Search target. Currently, supports only ITEM.

Example:

"ITEM"

match.or

object[]

Show child attributes

match.or.name

string

Attribute group name

Example:

"weight"

sort

object[]

Show child attributes

sort.field

string

Field on which the results must be sorted

Example:

"priorityOrder"

sort.direction

enum<string>

Direction (ascending or descending) or sorting the response

Available options:

ASC,

DESC

Example:

"DESC"

Response

totalSize

number

Total number of records (attribute group)

Example:

7

pageSize

number

Number of records (attribute group) per page

Example:

10

pages

number

Number of pages for the given pageSize

Example:

1

attributeGroups

object[]

Show child attributes

attributeGroups._id

string

A 24-character system-generated ID of the attribute group

Example:

"6259ec8d006b0d00092b3189"

attributeGroups.description

string

Accurate description of the attribute and what it represents

Example:

"Item weight, in KG"

attributeGroups.type

enum<string>

Attribute group type

Available options:

WORKFLOW,

COLLECTION

Example:

"COLLECTION"

attributeGroups.name

string

Attribute group name

Example:

"weight"

attributeGroups.priorityOrder

number

Priority order of attribute group

Example:

1

attributeGroups.createdOn

string

Time of attribute group creation (UTC format)

Example:

"2022-04-15T22:07:09.921Z"

attributeGroups.modifiedOn

string

Time when attribute group was last modified (UTC format)

Example:

"2022-04-15T22:10:05.427Z"

attributeGroups.totalAttributes

number

Number of attributes in the attribute group

Example:

1

attributeGroups.EditableAttributes

object[]

Show child attributes

attributeGroups.EditableAttributes._id

string

A 24-character system-generated ID, for internal use

Example:

"6259ec8defc2116dd6c0f3fc"

attributeGroups.EditableAttributes.attributeGroupId

string

A 24-character system-generated ID of attribute group

Example:

"6259ec8d006b0d00092b3189"

attributeGroups.EditableAttributes.attributeId

string

A 24-character system-generated attribute ID

Example:

"6245f16d11ae770009f19292"

attributeGroups.EditableAttributes.isEditable

boolean

true: Attribute is editable
false: Attribute is non-editable

attributeGroups.EditableAttributes.createdOn

string

Time of attribute creation (UTC format)

Example:

"2022-04-15T22:07:09.932Z"

attributeGroups.EditableAttributes.modifiedOn

string

Time when attribute was last updated (UTC format)

Example:

"2022-04-15T22:10:05.444Z"

attributeGroups.EditableAttributes.order

number

Order of items within the attribute group

Example:

0

attributeGroups.EditableAttributes.attribute

object[]

Show child attributes

attributeGroups.EditableAttributes.attribute._id

string

A 24-character system-generated attribute ID

Example:

"6259ec8defc2116dd6c0f3fc"

attributeGroups.EditableAttributes.attribute.description

string

Accurate description of attribute and what it represents

Example:

"Item weight, in KG."

attributeGroups.EditableAttributes.attribute.formulaManuallyOverWritten

boolean

true: Formula can be manually overwritten
false: Formula cannot be manually overwritten

Example:

false

attributeGroups.EditableAttributes.attribute.formula

string

Formula for the item attribute

Example:

null

attributeGroups.EditableAttributes.attribute.type

string

Attribute type

Example:

"TEXT"

attributeGroups.EditableAttributes.attribute.name

string

Attribute name

Example:

"weight"

attributeGroups.EditableAttributes.attribute.textSubType

string

Conditionally required sub-type for TEXT attribute type

Example:

"SMALL_TEXT"

attributeGroups.EditableAttributes.attribute.attributeValidationId

string

Attribute validation ID

Example:

"624d92f8caa34e0009b5d849"

attributeGroups.EditableAttributes.attribute.modifiedBy

string

User ID that modified item attribute

Example:

"60aad2c835c5fb000885f679"

attributeGroups.EditableAttributes.attribute.createdOn

string

Time of attribute creation (UTC format)

Example:

"2022-04-15T22:07:09.932Z"

attributeGroups.EditableAttributes.attribute.modifiedOn

string

Time when the attribute was last modified (UTC format)

Example:

"2022-04-15T22:10:05.444Z"

attributeGroups.ReadOnlyAttributes

object[]

Show child attributes

attributeGroups.ReadOnlyAttributes._id

string

A 24-character system-generated ID, for internal use

Example:

"6259ec8defc2116dd6c0f3fc"

attributeGroups.ReadOnlyAttributes.attributeGroupId

string

A 24-character system-generated ID of attribute group

Example:

"6259ec8d006b0d00092b3189"

attributeGroups.ReadOnlyAttributes.attributeId

string

A 24-character system-generated attribute ID

Example:

"6245f16d11ae770009f19292"

attributeGroups.ReadOnlyAttributes.isEditable

boolean

true: Attribute is editable
false: Attribute is non-editable

attributeGroups.ReadOnlyAttributes.createdOn

string

Time of attribute creation (UTC format)

Example:

"2022-04-15T22:07:09.932Z"

attributeGroups.ReadOnlyAttributes.modifiedOn

string

Time when attribute was last updated (UTC format)

Example:

"2022-04-15T22:10:05.444Z"

attributeGroups.ReadOnlyAttributes.order

number

Order of items within the attribute group

Example:

0

attributeGroups.ReadOnlyAttributes.attribute

object[]

Show child attributes

attributeGroups.ReadOnlyAttributes.attribute._id

string

A 24-character system-generated attribute ID

Example:

"6259ec8defc2116dd6c0f3fc"

attributeGroups.ReadOnlyAttributes.attribute.description

string

Accurate description of attribute and what it represents

Example:

"Item weight, in KG."

attributeGroups.ReadOnlyAttributes.attribute.formulaManuallyOverWritten

boolean

true: Formula can be manually overwritten
false: Formula cannot be manually overwritten

Example:

false

attributeGroups.ReadOnlyAttributes.attribute.formula

string

Formula for the item attribute

Example:

null

attributeGroups.ReadOnlyAttributes.attribute.type

string

Attribute type

Example:

"TEXT"

attributeGroups.ReadOnlyAttributes.attribute.name

string

Attribute name

Example:

"weight"

attributeGroups.ReadOnlyAttributes.attribute.textSubType

string

Conditionally required sub-type for TEXT attribute type

Example:

"SMALL_TEXT"

attributeGroups.ReadOnlyAttributes.attribute.attributeValidationId

string

Attribute validation ID

Example:

"624d92f8caa34e0009b5d849"

attributeGroups.ReadOnlyAttributes.attribute.modifiedBy

string

User ID that modified item attribute

Example:

"60aad2c835c5fb000885f679"

attributeGroups.ReadOnlyAttributes.attribute.createdOn

string

Time of attribute creation (UTC format)

Example:

"2022-04-15T22:07:09.932Z"

attributeGroups.ReadOnlyAttributes.attribute.modifiedOn

string

Time when the attribute was last modified (UTC format)

Example:

"2022-04-15T22:10:05.444Z"

attributeGroups.WorkflowAttributes

object[]

attributeGroups.ImpactedAttributes

object[]

Create, update and delete attribute groups Find attribute mapping

⌘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 attribute groups

Authorizations

Headers

Body

Response