Find Attribute Groups

curl --request POST \
  --url https://api.fabric.inc/v3/product-attribute-groups/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match": {
    "id": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "name": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "priority": {
      "op": "GTE",
      "value": 1
    },
    "attributeIds": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "createdAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    },
    "updatedAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    }
  },
  "sort": "+name,-attributesCount",
  "offset": 2,
  "limit": 10
}
'

{
  "data": [
    {
      "id": "59328bf0b5f328bf0b5f3288",
      "name": "Dimensions",
      "description": "Dimensions of a product",
      "priority": 1,
      "attributes": [
        {
          "attributeId": "33328bf0b5f328bf0b5f3288",
          "name": "color",
          "type": "TEXT",
          "localizedProperties": {
            "en-US": {
              "name": "color"
            },
            "en-IN": {
              "name": "colour"
            }
          },
          "isLocalizable": true,
          "isReadOnly": true
        }
      ],
      "attributeCount": 20,
      "updatedBy": "[email protected]",
      "createdAt": "2021-04-20T10:24:36.162Z",
      "updatedAt": "2021-04-20T10:24:36.162Z"
    }
  ],
  "offset": 2,
  "limit": 10,
  "count": 1000
}

POST

product-attribute-groups

curl --request POST \
  --url https://api.fabric.inc/v3/product-attribute-groups/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "match": {
    "id": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "name": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "priority": {
      "op": "GTE",
      "value": 1
    },
    "attributeIds": {
      "op": "IN",
      "value": [
        "blue"
      ]
    },
    "createdAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    },
    "updatedAt": {
      "op": "RANGE",
      "fromValue": "2022-04-20T10:24:36.162Z",
      "toValue": "2023-04-20T10:24:36.162Z"
    }
  },
  "sort": "+name,-attributesCount",
  "offset": 2,
  "limit": 10
}
'

{
  "data": [
    {
      "id": "59328bf0b5f328bf0b5f3288",
      "name": "Dimensions",
      "description": "Dimensions of a product",
      "priority": 1,
      "attributes": [
        {
          "attributeId": "33328bf0b5f328bf0b5f3288",
          "name": "color",
          "type": "TEXT",
          "localizedProperties": {
            "en-US": {
              "name": "color"
            },
            "en-IN": {
              "name": "colour"
            }
          },
          "isLocalizable": true,
          "isReadOnly": true
        }
      ],
      "attributeCount": 20,
      "updatedBy": "[email protected]",
      "createdAt": "2021-04-20T10:24:36.162Z",
      "updatedAt": "2021-04-20T10:24:36.162Z"
    }
  ],
  "offset": 2,
  "limit": 10,
  "count": 1000
}

Authorizations

Authorization

string

header

required

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

Headers

x-fabric-tenant-id

string

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

Example:

"517fa9dfd42d8b00g1o3k312"

x-fabric-request-id

string

Unique request ID

Example:

"263e731c-45c8-11ed-b878-0242ac120002"

Body

application/json

Search criteria for attribute group

match

object

required

Specification for matching attributes

Show child attributes

match.id

object

Simple string search Simple multi-string search

Option 1
Option 2

Show child attributes

match.id.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.id.value

string[]

required

Sample string schema

match.name

object

String search Simple multi-string search

Option 1
Option 2

Show child attributes

match.name.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.name.value

string[]

required

Sample string schema

match.priority

object

Number search Single number search

Option 1
Option 2

Show child attributes

match.priority.op

enum<string>

required

Operations that can be performed on a number type such as equals to, less than (LT), Greater than (GT), Less than or equal to (LTE), Greater than or equal to (GTE), etc.

Available options:

EQUALS,

LTE,

GTE,

LT,

GT

Example:

"GTE"

match.priority.value

number<double>

required

Sample double schema

Example:

1

match.attributeIds

object

Simple string search Simple multi-string search

Option 1
Option 2

Show child attributes

match.attributeIds.op

enum<string>

required

Operations that can be performed on a string type

Available options:

IN

Example:

"IN"

match.attributeIds.value

string[]

required

Sample string schema

match.createdAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.createdAt.op

enum<string>

required

Date range

Available options:

RANGE

Example:

"RANGE"

match.createdAt.fromValue

string

required

Starting range (UTC)

Example:

"2022-04-20T10:24:36.162Z"

match.createdAt.toValue

string

required

Ending range (UTC)

Example:

"2023-04-20T10:24:36.162Z"

match.updatedAt

object

Date-time search Date range search

Option 1
Option 2
Option 3

Show child attributes

match.updatedAt.op

enum<string>

required

Date range

Available options:

RANGE

Example:

"RANGE"

match.updatedAt.fromValue

string

required

Starting range (UTC)

Example:

"2022-04-20T10:24:36.162Z"

match.updatedAt.toValue

string

required

Ending range (UTC)

Example:

"2023-04-20T10:24:36.162Z"

sort

string

Criteria to sort the response. Currently, sorting is only supported on createdAt, updatedAt, name, attributesCount and priority. - refers to descending while + refers to ascending order

Example:

"+name,-attributesCount"

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

2

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

Response

Details of attribute groups

data

object[]

Show child attributes

data.id

string

24-character system-generated attribute group ID

Example:

"59328bf0b5f328bf0b5f3288"

data.name

string

Attribute group name

Example:

"Dimensions"

data.description

string

Brief description of attribute group

Example:

"Dimensions of a product"

data.priority

integer<int32>

Determines attribute group's order of appearance in the UI

Example:

1

data.attributes

object[]

Show child attributes

data.attributes.attributeId

string

24-character system-generated attribute ID

Example:

"33328bf0b5f328bf0b5f3288"

data.attributes.name

string

Attribute name when it isn't localized. When localized, the translated name shows.

Example:

"color"

data.attributes.type

enum<string>

Attribute type

Available options:

TEXT,

NUMBER,

DATETIME,

BOOLEAN,

OPTIONS,

SERIAL

Example:

"TEXT"

data.attributes.localizedProperties

object

Names of localized attributes

Show child attributes

data.attributes.localizedProperties.{key}

object

Show child attributes

data.attributes.localizedProperties.{key}.name

string

Localized name

Example:

"color"

Example:

{
  "en-US": { "name": "color" },
  "en-IN": { "name": "colour" }
}

data.attributes.isLocalizable

boolean

true: Attribute name is translated into different languages or localized for different regions
false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.

Example:

true

data.attributes.isReadOnly

boolean

true: Attribute is read only
false: Attribute is editable

Example:

true

data.attributeCount

integer<int32>

Number of attributes in the attribute group

Example:

20

data.updatedBy

string

Email of user who last updated Attribute Group

Example:

"[email protected]"

data.createdAt

string

Attribute group creation time (UTC)

Example:

"2021-04-20T10:24:36.162Z"

data.updatedAt

string

Time of last update to attribute group (UTC)

Example:

"2021-04-20T10:24:36.162Z"

offset

integer<int32>

default:0

Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.

Example:

2

limit

integer<int32>

default:10

Maximum number of records per page

Example:

10

count

integer<int32>

Total number of records in the search results

Example:

1000

Get All Product Attribute Groups Overview

⌘I

Product Catalog

Product Catalog User Guides

Product Catalog API

Developer Guide

Catalog Connector User Guides

Catalog Connector API

Find Attribute Groups

Authorizations

Headers

Body

Response