> ## Documentation Index
> Fetch the complete documentation index at: https://developer.fabric.inc/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Attribute Mapping
> Before adding an item (with or without variants) to fabric **Product Catalog**, you must map merchant-specific attributes to fabric-specific attributes. Once mapping is created, this endpoint is used to get the mapping details.
## OpenAPI
````yaml attribute.openapi get /product-attribute-mappings
openapi: 3.0.0
info:
title: Products - Attributes API
description: >-
fabric **Product Catalog** supports two types of attributes: Item Attributes
and Category Attributes. Within fabric Products, a product could be an item,
a variant, or a bundle. Product attributes are factual and objective
descriptions that shoppers see when browsing through an e-commerce platform
(website or mobile app). These attributes may include technical
specifications such as size and weight, design specifications such as color
and material, as well as basic details like name, description, and ID.
Similarly, Category attributes define the characteristics of parent and
children categories. They're essential for organizing products in logical
groups, making it easier for shoppers to browse and find products on your
platform with minimal cognitive load.
version: 3.0.0
x-audience: external-public
contact:
email: support@fabric.inc
name: Product team
license:
name: fabric API License
url: https://fabric.inc/api-license
termsOfService: https://fabric.inc/terms-of-use
servers:
- url: https://api.fabric.inc/v3
description: Production URL
security:
- authorization: []
tags:
- name: Attributes
description: >-
Supports CRUD operations for managing attributes. These endpoints
generally require an attribute `target` to be specified to ensure
appropriate separation and assignment of attributes to the correct target
- `Item` or `Category`.
- name: Attribute Groups
description: >-
Attribute Group is a collection of product attributes that helps
categorize products into various semantic groups based on meaning and
purpose, allowing for easier management and organization of products in
the catalog. Supports CRUD operations for managing attribute groups.
- name: Attributes Mapping
description: >-
fabric has a predefined set of mandatory attributes for `Items` and
`Categories`. However, as merchants, you may have your own naming
conventions for these attributes. For instance, a mandatory attribute
'unique item identifier' may be referred to as `SKU` by fabric and as
`productId` by merchant. To address this inconsistency, merchant-defined
attributes are mapped to fabric attributes as productId -> fabric SKU.
These endpoints are used to get and update mapping of attributes.
externalDocs:
description: Find out more about Products (previously called PIM)
url: https://developer.fabric.inc/docs/products-overview
paths:
/product-attribute-mappings:
get:
tags:
- Attributes Mapping
summary: Get Attribute Mapping
description: >-
Before adding an item (with or without variants) to fabric **Product
Catalog**, you must map merchant-specific attributes to fabric-specific
attributes. Once mapping is created, this endpoint is used to get the
mapping details.
operationId: getAttributeMapping
parameters:
- $ref: '#/components/parameters/x-fabric-tenant-id'
- $ref: '#/components/parameters/x-fabric-request-id'
responses:
'200':
description: Ok
content:
application/json:
schema:
$ref: '#/components/schemas/getAttributeMappingsResponse'
headers:
x-fabric-request-id:
$ref: '#/components/headers/x-fabric-request-id-header'
'400':
$ref: '#/components/responses/badRequest'
'401':
$ref: '#/components/responses/notAuthorized'
'403':
$ref: '#/components/responses/forbidden'
'500':
$ref: '#/components/responses/internalServerError'
components:
parameters:
x-fabric-tenant-id:
name: x-fabric-tenant-id
in: header
description: >-
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](/v3/platform/settings/account-details/getting-the-account-id).
This header is required.
schema:
type: string
example: 517fa9dfd42d8b00g1o3k312
x-fabric-request-id:
name: x-fabric-request-id
in: header
description: Unique request ID
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
required: false
schemas:
getAttributeMappingsResponse:
$ref: '#/components/schemas/attributeMapping'
attributeMapping:
type: object
properties:
image:
type: object
properties:
id:
type: string
example: CAXCC1234AASXSSSS
description: Merchant-specified image ID
name:
type: string
example: color
description: Merchant-specified name for `image`
localizedProperties:
$ref: '#/components/schemas/localizedProperties'
isLocalizable:
type: boolean
example: true
description: >-
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.
active:
type: object
properties:
id:
type: string
example: CBCAC1234AASXLLLL
description: Merchant-specified ID for `active` status
name:
type: string
example: color
description: Merchant-specified name for `active` status
localizedProperties:
$ref: '#/components/schemas/localizedProperties'
isLocalizable:
type: boolean
example: true
description: >-
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.
sku:
type: object
properties:
id:
type: string
example: CBCAC1234AASKKKK
description: Merchant-specified SKU ID
name:
type: string
example: color
description: Merchant-specified name for `SKU`
localizedProperties:
$ref: '#/components/schemas/localizedProperties'
isLocalizable:
type: boolean
example: true
description: >-
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.
title:
type: object
properties:
id:
type: string
example: CBCAC1234AAS554R
description: Merchant-specified title ID
name:
type: string
example: color
description: Merchant-specified name for `title`
localizedProperties:
$ref: '#/components/schemas/localizedProperties'
isLocalizable:
type: boolean
example: true
description: >-
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.
genericError:
type: object
properties:
message:
type: string
description: Placeholder error message for all the 4xx, 5xx errors
example: Request is invalid
type:
type: string
description: Placeholder error type for all the 4xx, 5xx errors
example: Bad request
errors:
type: array
items:
type: object
properties:
type:
type: string
description: Error type
example: CLIENT_ERROR
message:
type: string
description: Error details
example: Invalid request. Check your parameters or request body.
localizedProperties:
type: object
additionalProperties:
type: object
properties:
name:
type: string
example: color
description: Localized name
example:
en-US:
name: color
en-IN:
name: colour
description: Names of localized attributes
headers:
x-fabric-request-id-header:
description: Unique request ID
schema:
type: string
example: 263e731c-45c8-11ed-b878-0242ac120002
responses:
badRequest:
description: Request is invalid or malformed
headers:
x-fabric-request-id:
$ref: '#/components/headers/x-fabric-request-id-header'
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
notAuthorized:
description: Request isn't authorized
headers:
x-fabric-request-id:
$ref: '#/components/headers/x-fabric-request-id-header'
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
example:
message: The requester is unauthorized
type: UNAUTHORIZED_ERROR
forbidden:
description: User isn't allowed to perform the action
headers:
x-fabric-request-id:
$ref: '#/components/headers/x-fabric-request-id-header'
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
example:
type: REQUEST_DENIED
message: User doesn't have the required permission
internalServerError:
description: Internal server error
headers:
x-fabric-request-id:
$ref: '#/components/headers/x-fabric-request-id-header'
content:
application/json:
schema:
$ref: '#/components/schemas/genericError'
example:
type: SERVER_ERROR
message: Internal Server Error
securitySchemes:
authorization:
type: http
scheme: bearer
bearerFormat: JWT
description: S2S access token (JWT) from fabric Identity service (during Login)
````