POST
/
api-product
/
v1
/
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[]

Response

OK

​
attributeId
string

A 24-character system-generated attribute ID

Example:

"62e2ae29c3004a000950ad5f"

​
attribute
object

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

​
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; <br /> false: mapping is optional

​
validation
object
​
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"