POST
/
api-product
/
v1
/
product
/
attribute-group
Create, update and delete attribute groups
curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute-group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "transactional": true,
  "attributeGroup": [
    {
      "action": "UPDATE",
      "type": "COLLECTION",
      "description": "Item weight, in KG",
      "name": "weight",
      "priorityOrder": 1,
      "id": "6259ec8d006b0d00092b3189",
      "editableAttributes": [
        {
          "action": "UPDATE",
          "id": "6245f16d11ae770009f19292",
          "order": 0
        }
      ]
    }
  ]
}'
[
  {
    "_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",
    "attributes": [
      {
        "_id": "6259ec8defc2116dd6c0f3fc",
        "attributeGroupId": "6259ec8d006b0d00092b3189",
        "attributeId": "6245f16d11ae770009f19292",
        "isEditable": true,
        "createdOn": "2022-04-15T22:07:09.932Z",
        "modifiedOn": "2022-04-15T22:10:05.444Z",
        "order": 0
      }
    ]
  }
]

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
​
transactional
boolean
required

true: All updates succeed or fail as a unit <br /> false: Some can succeed or fail

​
attributeGroup
object[]

Response

OK

​
_id
string

A 24-character system-generated attribute group ID

Example:

"6259ec8d006b0d00092b3189"

​
description
string

Accurate description of attribute group and what it represents

Example:

"Item weight, in KG"

​
type
enum<string>

Attribute group type

Available options:
WORKFLOW,
COLLECTION
Example:

"COLLECTION"

​
name
string

Attribute group name

Example:

"weight"

​
priorityOrder
number

Order of priority of the attribute group

Example:

1

​
createdOn
string

Time of attribute group creation (UTC format).

Example:

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

​
modifiedOn
string

Time when attribute group was last modified (UTC format).

Example:

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

​
attributes
object[]