Authentication v1
- Identity APIs
- User
- Address
- Auth
User Self Service APIs
- Introduction
- User Self Service APIs
- Authentication APIs
Experiences v2 (XM v2)
- XM
- Pages
- Global Components
- Menu
Experiences v1 (XM v1)
- XM
- Pages
- Global Components
- Menu
Product Catalog
Orders v2 (OMS v2)
- Order Management System
- Order
- Order Attribute
- Developer Guide
- Order Return
- Payment Status
- Package Tracking
- Cross Border
- Order Cancellation
- Appeasement
- Allocation
- Configuration
- Fraud Configuration
- Target Configuration
- Location
- Location Attribute
- Inventory Network
- Inventory
- Inventory Counter
- Inventory Bulk Operation
- Inventory Attribute
- Inventory Upload Log
- Shipment
- Shipping Method
- Webhook
- Notification
- Export
- Invoice
- Fraud
- Backorder Preorder Reservation
- List
Orders v1 (OMS v1)
- Order Management System
- Cart
- Bill To
- Ship To
- Wishlist
- Cart Decoupled
- Warehouse
- Inventory
- Attributes
- List
- Tax/Address Validate
- Shipping
- Payments
- Order
Offers v2
- Offers
- Developer Guide
- Promotion
- Price Kind
- Dynamic Pricing Engine
- Segment
- Coupon
- Coupon Codes
- Product
- Price List
- Attributes
- Item
- Price Guard
- Global Exclusion
- Upload Price CSV
- Pricing
- Redemption
- Exports
Offers v1
- Offers
- Login API
- Promotions
- Pricing
Subscriptions (SMT API)
- Subscriptions API
- Cancellation Reasons
- Subscription Discounts
- Subscriptions
- Subscribers
- Orders
Loyalty (Member)
- Member APIs
- Inquire
- Discounts
- Redeem
- Earn
- Members
Dropship
- Dropship API
- Shipments
- Products
- Invoices
- Connections
- Inventory
- Developer Guide
- Returns
- Orders
Cart API
- Cart
- Order Draft
- Attribute
- Adjustments
- Shipping
- Cart
Checkout API
- Checkout
- Checkout
Customer
- Core Concepts
- Customer Service
- Organization
- User Party
- Organization Group Addresses
- User Internal Party
- Organization Contracts
- Party
- Party Contracts
- Contracts
- User
- Search
- User Trait
- Organization Users
- Address
- User Address
- Trait
- Party Address
- Party Trait
- Organization Group Users
- Internal Party
- Contract Pricelist
- Internal Parties Party
- Account
- Party Account
- Organization Addresses
- Organization Groups
- Individual Addresses
- Users Organization
- Individual
Find attribute mapping
Searches for attribute mapping based on the given search criteria. You will get a paginated response, which you can narrow down using filter criteria such as page and size.
S2S access token (JWT) from fabric Identity service (during Login)
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.
true: include the attribute in the response; <br /> false: exclude attribute in the response
Sorting preference
Specification for matching attribute mapping.
Attribute mapping for the specified target
Attribute mapping
A 24-character system-generated Attribute ID
Mapping for an attribute whose name contains the specified value
Mapping for an attribute whose description contains the specified value.
true: Returns only the attribute mappings that are mandatory
Page number to be retrieved. <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with size
Number of records per page <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with page
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
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
Page number to be retrieved. <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with size
Number of records per page <br /> Note: <br /> 1) Applicable only in a paginated response. <br /> 2) Always paired with page
true: include the attribute in the response; <br /> false: exclude attribute in the response
Specification for matching attribute mapping.
Attribute mapping for the specified target
Attribute mapping
A 24-character system-generated Attribute ID
Mapping for an attribute whose name contains the specified value
Mapping for an attribute whose description contains the specified value.
true: Returns only the attribute mappings that are mandatory
Response
Total number of records
Number of records in a page
Total number of pages in the response
A 24-character system-generated attribute ID
Represents the mapped attributes. Only populated when include.attribute is true. <br /> Note: Not applicable for an attribute mapping modify request
Attribute ID
For 'attribute modify request', the PIM statuses (if applicable). For 'attribute search request', the statuses defined by the include.status request parameter.
Status code
Status type
ATTRIBUTE, ATTRIBUTE_VALUE, ITEM, BUNDLE, NODE, HIERARCHY Status source
PIM, WAM Status name
Status description
Time of file creation
User ID that created the file
Time when file was last modified
User ID that last modified the file
Array of file's associated with an item
Status type
IMPORT, EXPORT File name
Current status of the file
Status code
Status type
ATTRIBUTE, ATTRIBUTE_VALUE, ITEM, BUNDLE, NODE, HIERARCHY Status source
PIM, WAM Status name
Status description
Time of file creation
User ID that created the file
Time when file was last modified
User ID that last modified the file
Import progress in percentage
Time of file creation
User ID that created the file
Time when file was last modified
User ID that last modified the file
Time taken to import the file (doesn't include the whole time for the full bulk import process).
Time taken to process the file after the file was read
Attribute name
Attribute description
true: attribute can be localized <br /> false: attribute cannot be localized
Attribute mapping. <br /> Note: Most attributes will not have a mapping, resulting in null value.
Data type of the attribute
TEXT, BOOLEAN, SERIAL, DECIMAL, INTEGER, DATETIME Conditionally required to indicate the starting value of SERIAL attribute type. When enabled, the subsequent attribute values increment by 1.
Indicates whether the attribute is for categories or items.
NODE, ITEM Attribute format. Currently used only for the attribute type DATETIME.
JavaScript expression to dynamically compute the attribute's value. <br /> Note: The type returned must match the attribute's type.
Indicates mandatory attribute
true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.
true: Inverts existing validation (example - requires that the validation does not pass) <br /> false: Follows existing validation
true: Value is unique across all items or categories <br /> false: Value is not unique
Specified value must exactly match this value
Attribute types
TEXT, BOOLEAN, SERIAL, DECIMAL, INTEGER, ASSET, DATETIME Specified value must contain this string
JavaScript expression to determine if the value matches
Match the value if it is one of these.
Time of attribute creation
ID that created the attribute
Time when the attribute was last modified
User ID that last modified the attribute
Attribute mapping
Returns attribute mapping for the specified target
Name of attribute mapping
Description for attribute mapping
true: Mapping is mandatory; <br /> false: mapping is optional
Indicates mandatory attribute
true: Parent attributes are inherited to children items <br /> false: Parent attributes are not inherited to children items.
true: Inverts existing validation (example - requires that the validation does not pass) <br /> false: Follows existing validation
true: Value is unique across all items or categories <br /> false: Value is not unique
Specified value must exactly match this value
Attribute types
TEXT, BOOLEAN, SERIAL, DECIMAL, INTEGER, ASSET, DATETIME Specified value must contain this string
JavaScript expression to determine if the value matches
Match the value if it is one of these.
Time of attribute creation (UTC format)
User ID that created item attribute
Time of when the attribute was last modified
User ID that last modified item attribute
Was this page helpful?