Create and Update attribute mappings

Set your attribute mapping to begin configuring your catalog. You can update the mappings only if there are no SKUs present in the catalog.

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.

Body

application/json

mappings

object[]

Show child attributes

mappings.attributeId

string

Attribute ID

mappings.description

string

Description of the attribute mapping

mappings.mapping

string

Attribute mapping

mappings.name

string

Name of the attribute mapping

mappings.required

boolean

true: Mapping is mandatory <br /> false: Mapping is optional

mappings.validation

object

Show child attributes

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.exact

Specified value must exactly match this value

mappings.validation.formula

string

JavaScript expression to determine if the value matches

mappings.validation.inheritable

boolean

true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.

mappings.validation.inverse

boolean

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

mappings.validation.oneOf

Match the value if it is one of these.

mappings.validation.range

object

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

Show child attributes

mappings.validation.range.max

Specified value must be less than or equal to this value

mappings.validation.range.min

Specified value must be greater than or equal to this value

mappings.validation.required

boolean

Indicates mandatory attribute

mappings.validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique

Response

200 - application/json

attribute

object

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

Show child attributes

attribute.createdBy

string

ID that created the attribute

attribute.createdOn

string

Time of attribute creation

attribute.description

string

Attribute description

attribute.files

object[]

Array of file's associated with an item

Show child attributes

attribute.files.createdBy

string

User ID that created the file

attribute.files.createdOn

string

Time of file creation

attribute.files.modifiedBy

string

User ID that last modified the file

attribute.files.modifiedOn

string

Time when file was last modified

attribute.files.name

string

File name

attribute.files.progress

number

Import progress in percentage

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.files.statuses

object[]

Current status of the file

Show child attributes

attribute.files.statuses.code

string

Status code

attribute.files.statuses.createdBy

string

User ID that created the file

attribute.files.statuses.createdOn

string

Time of file creation

attribute.files.statuses.description

string

Status description

attribute.files.statuses.modifiedBy

string

User ID that last modified the file

attribute.files.statuses.modifiedOn

string

Time when file was last modified

attribute.files.statuses.name

string

Status name

attribute.files.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

attribute.files.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

attribute.files.type

enum<string>

Status type

Available options:

IMPORT,

EXPORT

attribute.format

string

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

attribute.formula

string

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

attribute.id

string

Attribute ID

attribute.locales

object[]

Show child attributes

attribute.locales.locale

string

Locale identifier

attribute.locales.name

string

Localized string value

attribute.localizable

boolean

true: attribute can be localized <br /> false: attribute cannot be localized

attribute.mapping

string | null

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

attribute.modifiedBy

string

User ID that last modified the attribute

attribute.modifiedOn

string

Time when the attribute was last modified

attribute.name

string

Attribute name

attribute.serialStart

number

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

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.createdBy

string

User ID that created the file

attribute.statuses.createdOn

string

Time of file creation

attribute.statuses.description

string

Status description

attribute.statuses.modifiedBy

string

User ID that last modified the file

attribute.statuses.modifiedOn

string

Time when file was last modified

attribute.statuses.name

string

Status name

attribute.statuses.source

enum<string>

Status source

Available options:

PIM,

WAM

attribute.statuses.type

enum<string>

Status type

Available options:

ATTRIBUTE,

ATTRIBUTE_VALUE,

ITEM,

BUNDLE,

NODE,

HIERARCHY

attribute.target

enum<string>

Indicates whether the attribute is for categories or items.

Available options:

NODE,

ITEM

attribute.type

enum<string>

Data type of the attribute

Available options:

TEXT,

BOOLEAN,

SERIAL,

DECIMAL,

INTEGER,

DATETIME

attribute.validation

object

Show child attributes

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.exact

Specified value must exactly match this value

attribute.validation.formula

string

JavaScript expression to determine if the value matches

attribute.validation.inheritable

boolean

true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.

attribute.validation.inverse

boolean

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

attribute.validation.oneOf

Match the value if it is one of these.

attribute.validation.range

object

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

Show child attributes

attribute.validation.range.max

Specified value must be less than or equal to this value

attribute.validation.range.min

Specified value must be greater than or equal to this value

attribute.validation.required

boolean

Indicates mandatory attribute

attribute.validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique

attributeId

string

A 24-character system-generated attribute ID

createdBy

string

User ID that created item attribute

createdOn

string

Time of attribute creation (UTC format)

description

string

Description for attribute mapping

mapping

string

Attribute mapping

modifiedBy

string

User ID that last modified item attribute

modifiedOn

string

Time of when the attribute was last modified

name

string

Name of attribute mapping

required

boolean

true: Mapping is mandatory; <br /> false: mapping is optional

target

string

Returns attribute mapping for the specified target

validation

object

Show child attributes

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.exact

Specified value must exactly match this value

validation.formula

string

JavaScript expression to determine if the value matches

validation.inheritable

boolean

true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.

validation.inverse

boolean

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

validation.oneOf

Match the value if it is one of these.

validation.range

object

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

Show child attributes

validation.range.max

Specified value must be less than or equal to this value

validation.range.min

Specified value must be greater than or equal to this value

validation.required

boolean

Indicates mandatory attribute

validation.unique

boolean

true: Value is unique across all items or categories <br /> false: Value is not unique