Create and Update attribute mappings

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute/mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "mappings": [
    {
      "attributeId": "ATTR1234",
      "mapping": "SKU",
      "name": "<string>",
      "description": "Item SKU",
      "validation": {
        "required": true,
        "inheritable": true,
        "inverse": false,
        "unique": true,
        "exact": "<string>",
        "attributeTypes": [
          "TEXT"
        ],
        "contains": "<string>",
        "range": {
          "min": "<string>",
          "max": "<string>"
        },
        "formula": "value < 10 || value > 20",
        "oneOf": [
          "<string>"
        ]
      },
      "required": true
    }
  ]
}
'

{
  "attributeId": "62e2ae29c3004a000950ad5f",
  "attribute": {
    "id": "<string>",
    "statuses": [
      {
        "code": "<string>",
        "type": "ATTRIBUTE",
        "source": "PIM",
        "name": "<string>",
        "description": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "createdBy": "broma0",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "modifiedBy": "broma0"
      }
    ],
    "files": [
      {
        "type": "IMPORT",
        "name": "<string>",
        "statuses": [
          {
            "code": "<string>",
            "type": "ATTRIBUTE",
            "source": "PIM",
            "name": "<string>",
            "description": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "createdBy": "broma0",
            "modifiedOn": "2023-11-07T05:31:56Z",
            "modifiedBy": "broma0"
          }
        ],
        "progress": 100,
        "createdOn": "2023-11-07T05:31:56Z",
        "createdBy": "broma0",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "modifiedBy": "broma0",
        "secondsTakenToImport": 123,
        "secondsTakenToProcess": 123
      }
    ],
    "name": "<string>",
    "description": "<string>",
    "locales": [
      {
        "locale": "fr-ca",
        "name": "Un Nom Français"
      }
    ],
    "localizable": true,
    "mapping": "<string>",
    "type": "TEXT",
    "serialStart": 123,
    "target": "NODE",
    "format": "YYYY-MM-DD",
    "formula": "value < 10 || value > 20",
    "validation": {
      "required": true,
      "inheritable": true,
      "inverse": false,
      "unique": true,
      "exact": "<string>",
      "attributeTypes": [
        "TEXT"
      ],
      "contains": "<string>",
      "range": {
        "min": "<string>",
        "max": "<string>"
      },
      "formula": "value < 10 || value > 20",
      "oneOf": [
        "<string>"
      ]
    },
    "createdOn": "2023-11-07T05:31:56Z",
    "createdBy": "broma0",
    "modifiedOn": "2023-11-07T05:31:56Z",
    "modifiedBy": "broma0"
  },
  "mapping": "SKU",
  "target": "ITEM",
  "name": "Item SKU",
  "description": "Item SKU",
  "required": true,
  "validation": {
    "required": true,
    "inheritable": true,
    "inverse": false,
    "unique": true,
    "exact": "<string>",
    "attributeTypes": [
      "TEXT"
    ],
    "contains": "<string>",
    "range": {
      "min": "<string>",
      "max": "<string>"
    },
    "formula": "value < 10 || value > 20",
    "oneOf": [
      "<string>"
    ]
  },
  "createdOn": "2021-09-23T17:47:04.231Z",
  "createdBy": "broma0",
  "modifiedOn": "2023-11-07T05:31:56Z",
  "modifiedBy": "broma0"
}

POST

api-product

product

attribute

mapping

Create and Update attribute mappings

curl --request POST \
  --url https://live.copilot.fabric.inc/api-product/v1/product/attribute/mapping \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "mappings": [
    {
      "attributeId": "ATTR1234",
      "mapping": "SKU",
      "name": "<string>",
      "description": "Item SKU",
      "validation": {
        "required": true,
        "inheritable": true,
        "inverse": false,
        "unique": true,
        "exact": "<string>",
        "attributeTypes": [
          "TEXT"
        ],
        "contains": "<string>",
        "range": {
          "min": "<string>",
          "max": "<string>"
        },
        "formula": "value < 10 || value > 20",
        "oneOf": [
          "<string>"
        ]
      },
      "required": true
    }
  ]
}
'

{
  "attributeId": "62e2ae29c3004a000950ad5f",
  "attribute": {
    "id": "<string>",
    "statuses": [
      {
        "code": "<string>",
        "type": "ATTRIBUTE",
        "source": "PIM",
        "name": "<string>",
        "description": "<string>",
        "createdOn": "2023-11-07T05:31:56Z",
        "createdBy": "broma0",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "modifiedBy": "broma0"
      }
    ],
    "files": [
      {
        "type": "IMPORT",
        "name": "<string>",
        "statuses": [
          {
            "code": "<string>",
            "type": "ATTRIBUTE",
            "source": "PIM",
            "name": "<string>",
            "description": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "createdBy": "broma0",
            "modifiedOn": "2023-11-07T05:31:56Z",
            "modifiedBy": "broma0"
          }
        ],
        "progress": 100,
        "createdOn": "2023-11-07T05:31:56Z",
        "createdBy": "broma0",
        "modifiedOn": "2023-11-07T05:31:56Z",
        "modifiedBy": "broma0",
        "secondsTakenToImport": 123,
        "secondsTakenToProcess": 123
      }
    ],
    "name": "<string>",
    "description": "<string>",
    "locales": [
      {
        "locale": "fr-ca",
        "name": "Un Nom Français"
      }
    ],
    "localizable": true,
    "mapping": "<string>",
    "type": "TEXT",
    "serialStart": 123,
    "target": "NODE",
    "format": "YYYY-MM-DD",
    "formula": "value < 10 || value > 20",
    "validation": {
      "required": true,
      "inheritable": true,
      "inverse": false,
      "unique": true,
      "exact": "<string>",
      "attributeTypes": [
        "TEXT"
      ],
      "contains": "<string>",
      "range": {
        "min": "<string>",
        "max": "<string>"
      },
      "formula": "value < 10 || value > 20",
      "oneOf": [
        "<string>"
      ]
    },
    "createdOn": "2023-11-07T05:31:56Z",
    "createdBy": "broma0",
    "modifiedOn": "2023-11-07T05:31:56Z",
    "modifiedBy": "broma0"
  },
  "mapping": "SKU",
  "target": "ITEM",
  "name": "Item SKU",
  "description": "Item SKU",
  "required": true,
  "validation": {
    "required": true,
    "inheritable": true,
    "inverse": false,
    "unique": true,
    "exact": "<string>",
    "attributeTypes": [
      "TEXT"
    ],
    "contains": "<string>",
    "range": {
      "min": "<string>",
      "max": "<string>"
    },
    "formula": "value < 10 || value > 20",
    "oneOf": [
      "<string>"
    ]
  },
  "createdOn": "2021-09-23T17:47:04.231Z",
  "createdBy": "broma0",
  "modifiedOn": "2023-11-07T05:31:56Z",
  "modifiedBy": "broma0"
}

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

mappings

object[]

Show child attributes

mappings.attributeId

string

Attribute ID

Example:

"ATTR1234"

mappings.mapping

string

Attribute mapping

Example:

"SKU"

mappings.name

string

Name of the attribute mapping

mappings.description

string

Description of the attribute mapping

Example:

"Item SKU"

mappings.validation

object

Show child attributes

mappings.validation.required

boolean

Indicates mandatory attribute

mappings.validation.inheritable

boolean

true: Parent attributes are inherited to children items
false: Parent attributes are not inherited to children items.

Example:

true

mappings.validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass)
false: Follows existing validation

Example:

false

mappings.validation.unique

boolean

true: Value is unique across all items or categories
false: Value is not unique

mappings.validation.exact

Specified value must exactly match this value

mappings.validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

mappings.validation.contains

string

Specified value must contain this string

mappings.validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

mappings.validation.range.min

Specified value must be greater than or equal to this value

mappings.validation.range.max

Specified value must be less than or equal to this value

mappings.validation.formula

string

JavaScript expression to determine if the value matches

Example:

"value < 10 || value > 20"

mappings.validation.oneOf

Match the value if it is one of these.

mappings.required

boolean

true: Mapping is mandatory
false: Mapping is optional

Response

attributeId

string

A 24-character system-generated attribute ID

Example:

"62e2ae29c3004a000950ad5f"

attribute

object

Represents the mapped attributes. Only populated when include.attribute is true.
Note: Not applicable for an attribute mapping modify request

Show child attributes

attribute.id

string

Attribute ID

attribute.statuses

object[]

For 'attribute modify request', the PIM statuses (if applicable). For 'attribute search request', the statuses defined by the include.status request parameter.

Show child attributes

attribute.statuses.code

string

Status code

attribute.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

attribute.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

attribute.statuses.name

string

Status name

attribute.statuses.description

string

Status description

attribute.statuses.createdOn

string<date-time>

Time of file creation

attribute.statuses.createdBy

string

User ID that created the file

Example:

"broma0"

attribute.statuses.modifiedOn

string<date-time>

Time when file was last modified

attribute.statuses.modifiedBy

string

User ID that last modified the file

Example:

"broma0"

attribute.files

object[]

Array of file's associated with an item

Show child attributes

attribute.files.type

enum<string>

Status type

Available options:

IMPORT,

EXPORT

attribute.files.name

string

File name

attribute.files.statuses

object[]

Current status of the file

Show child attributes

attribute.files.statuses.code

string

Status code

attribute.files.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

attribute.files.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

attribute.files.statuses.name

string

Status name

attribute.files.statuses.description

string

Status description

attribute.files.statuses.createdOn

string<date-time>

Time of file creation

attribute.files.statuses.createdBy

string

User ID that created the file

Example:

"broma0"

attribute.files.statuses.modifiedOn

string<date-time>

Time when file was last modified

attribute.files.statuses.modifiedBy

string

User ID that last modified the file

Example:

"broma0"

attribute.files.progress

number

Import progress in percentage

Example:

100

attribute.files.createdOn

string<date-time>

Time of file creation

attribute.files.createdBy

string

User ID that created the file

Example:

"broma0"

attribute.files.modifiedOn

string<date-time>

Time when file was last modified

attribute.files.modifiedBy

string

User ID that last modified the file

Example:

"broma0"

attribute.files.secondsTakenToImport

number

Time taken to import the file (doesn't include the whole time for the full bulk import process).

attribute.files.secondsTakenToProcess

number

Time taken to process the file after the file was read

attribute.name

string

Attribute name

attribute.description

string

Attribute description

attribute.locales

object[]

Show child attributes

attribute.locales.locale

string

Locale identifier

Example:

"fr-ca"

attribute.locales.name

string

Localized string value

Example:

"Un Nom Français"

attribute.localizable

boolean

true: attribute can be localized
false: attribute cannot be localized

attribute.mapping

string | null

Attribute mapping.
Note: Most attributes will not have a mapping, resulting in null value.

attribute.type

enum<string>

Data type of the attribute

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

attribute.serialStart

number

Conditionally required to indicate the starting value of SERIAL attribute type. When enabled, the subsequent attribute values increment by 1.

attribute.target

enum<string>

Indicates whether the attribute is for categories or items.

Available options:

NODE,

ITEM

attribute.format

string

Attribute format. Currently used only for the attribute type DATETIME.

Example:

"YYYY-MM-DD"

attribute.formula

string

JavaScript expression to dynamically compute the attribute's value.
Note: The type returned must match the attribute's type.

Example:

"value < 10 || value > 20"

attribute.validation

object

Show child attributes

attribute.validation.required

boolean

Indicates mandatory attribute

attribute.validation.inheritable

boolean

true: Parent attributes are inherited to children items
false: Parent attributes are not inherited to children items.

Example:

true

attribute.validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass)
false: Follows existing validation

Example:

false

attribute.validation.unique

boolean

true: Value is unique across all items or categories
false: Value is not unique

attribute.validation.exact

Specified value must exactly match this value

attribute.validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

attribute.validation.contains

string

Specified value must contain this string

attribute.validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

attribute.validation.range.min

Specified value must be greater than or equal to this value

attribute.validation.range.max

Specified value must be less than or equal to this value

attribute.validation.formula

string

JavaScript expression to determine if the value matches

Example:

"value < 10 || value > 20"

attribute.validation.oneOf

Match the value if it is one of these.

attribute.createdOn

string<date-time>

Time of attribute creation

attribute.createdBy

string

ID that created the attribute

Example:

"broma0"

attribute.modifiedOn

string<date-time>

Time when the attribute was last modified

attribute.modifiedBy

string

User ID that last modified the attribute

Example:

"broma0"

mapping

string

Attribute mapping

Example:

"SKU"

target

string

Returns attribute mapping for the specified target

Example:

"ITEM"

name

string

Name of attribute mapping

Example:

"Item SKU"

description

string

Description for attribute mapping

Example:

"Item SKU"

required

boolean

true: Mapping is mandatory;
false: mapping is optional

validation

object

Show child attributes

validation.required

boolean

Indicates mandatory attribute

validation.inheritable

boolean

true: Parent attributes are inherited to children items
false: Parent attributes are not inherited to children items.

Example:

true

validation.inverse

boolean

true: Inverts existing validation (example - requires that the validation does not pass)
false: Follows existing validation

Example:

false

validation.unique

boolean

true: Value is unique across all items or categories
false: Value is not unique

validation.exact

Specified value must exactly match this value

validation.attributeTypes

enum<string>[]

Attribute types

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

ASSET,

DATETIME

validation.contains

string

Specified value must contain this string

validation.range

object

Specified range of values must be between this min and/or max

Show child attributes

validation.range.min

Specified value must be greater than or equal to this value

validation.range.max

Specified value must be less than or equal to this value

validation.formula

string

JavaScript expression to determine if the value matches

Example:

"value < 10 || value > 20"

validation.oneOf

Match the value if it is one of these.

createdOn

string<date-time>

Time of attribute creation (UTC format)

Example:

"2021-09-23T17:47:04.231Z"

createdBy

string

User ID that created item attribute

Example:

"broma0"

modifiedOn

string<date-time>

Time of when the attribute was last modified

modifiedBy

string

User ID that last modified item attribute

Example:

"broma0"

Find attribute mapping Overview

⌘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

Create and Update attribute mappings

Authorizations

Headers

Body

Response