Getting Started
Authentication v3
- Concepts
- System Apps
- User Apps
- Authentication Endpoints
Product Catalog
- Product Catalog API - Overview
- Developer Guide
- Data Ingestion Best Practices
- Attributes & Attribute Mapping
- Categories
- Products
- Collections
- Background Jobs
- Bulk Import & Export
- Published Products
Orders
- Orders (3.0.0)
- Developer Guide
- Orders FAQ
- Shopping Lists
- Shipping Methods
- Imports
- Exports
- Orders
- Frauds
- Notifications
- Backorders Preorders
- Cancellations
- Allocations
- Shipments
- Inventory Transfers
- Tracking
- Invoices
- Payments
- Credits
- Appeasements
- Returns
Inventory
- Inventory (3.0.0)
- Inventory FAQ
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Developer Guide
- Real-time Pricing Engine
- Price Lists
- Prices
- Price Types
- Price Controls
- Price Methods
- Priced Products
- Add-ons
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Product Exclusion Lists
- Segments
- Imports
- Exports
- Attributes
- Webhook Events
Carts
- Overview
- Developer Guides
- Carts
- Order Draft
- Items
- Addresses
- Payments
- Fulfillment
- Customer
- Coupons
- Validations
- Cart Orchestrator
Customers
- Customer Profile
- Customer Address
- Customer Self
Find attributes
With this endpoint, you can search for attributes based on criteria such as name, creation or modification date, attribute type, and other factors.
S2S access token (JWT) from fabric Identity service (during Login)
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. This header is required.
Unique request ID
Criteria to sort response. Sorting is supported only on createdAt, updatedAt, type, name and isMandatory. - refers to descending while + refers to ascending order
Specification for matching attributes
Simple string search
Operations that can be performed on a string type
Searches for attributes that matches the query. Append locale and name with a # as a value
Operations that can be performed on a string type
If isLocalizable is true, searches for the requested name in the list of locales provided here. If isLocalizable is false, the search will only be on the non-localized names.
String search
Operations that can be performed on a string type
Boolean search
Operations that can be performed on a boolean type
Sample boolean schema
Boolean search
Operations that can be performed on a boolean type
Sample boolean schema
Boolean search
Operations that can be performed on a boolean type
Sample boolean schema
Boolean search
Operations that can be performed on a boolean type
Sample boolean schema
Boolean search
Operations that can be performed on a boolean type
Sample boolean schema
Attributes of the specified target
Operations supported on a string type.
Single string for EQUALS operation; comma-separated string for an IN operation
Attributes of the specified type
Operations supported on a string type
Single string for EQUALS operation; comma-separated string for an IN operation
Searches for attributes of the specified subType
Operations that can be performed on a string type
Single string for an EQUALS operation; comma-separated string for an IN operation
Date-time search
Date range
Starting range (UTC)
Ending range (UTC)
Date-time search
Date range
Starting range (UTC)
Ending range (UTC)
Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page <br /> When no value is specified, default is 10.
Authorizations
S2S access token (JWT) from fabric Identity service (during Login)
Headers
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. This header is required.
Unique request ID
Body
Specification for matching attributes
Searches for attributes that matches the query. Append locale and name with a # as a value
Operations that can be performed on a string type
IN If isLocalizable is true, searches for the requested name in the list of locales provided here. If isLocalizable is false, the search will only be on the non-localized names.
Attributes of the specified type
Searches for attributes of the specified subType
Criteria to sort response. Sorting is supported only on createdAt, updatedAt, type, name and isMandatory. - refers to descending while + refers to ascending order
Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page <br /> When no value is specified, default is 10.
Response
Attribute details
Attribute ID
Non-localized attribute name. Refer to localizedProperties to get the localized name.
Brief description of attribute
Attribute type
TEXT, NUMBER, DATETIME, BOOLEAN, OPTIONS, SERIAL Single string for EQUALS operation; comma-separated string for an IN operation
PRODUCT, CATEGORY true: Attribute name is translated into different languages or localized for different regions <br /> false: Attribute name isn't localized Note: Refer to localizedProperties to get relevant attributes based on locale.
Validation details
true: Attribute is mandatory. <br /> false: Attribute is optional
true: The value isn't computed using formula property <br /> false: The value is computed using formula property. <br /> Note: manualOverwrite is applicable only for formula property.
JavaScript will be evaluated and applied on product. <br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.
JavaScript can be provided here to add custom validations.<br /> Applicable only for attributeType - TEXT, NUMBER, OPTIONS, and DATE.
Date format. <br /> Applicable when attributeType is DATETIME.
true: Input can be a float. <br /> false: Input must be an integer. <br /> Applicable only when attributeType is NUMBER.
Minimum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.
Maximum value allowed for an attribute. <br /> Applicable only when attributeType is NUMBER.
Starting number in a series. <br /> Applicable only when attributeType is SERIAL.
Represents number increment in a series. <br /> Applicable only when attributeType is SERIAL. For example, if the startWith is 5 and increment is 5, the next value in the series will 10, 15, and so forth.
Subtypes such as SINGLE and MULTIPLE are applicable when attributeType is OPTIONS. The rest of the subTypes are applicable when attributeType is TEXT.
SINGLE, MULTIPLE, SMALL_TEXT, TEXT_AREA, HTML List of accepted values. Applicable when the attributeType is OPTIONS and subType is MULTIPLE. Note: When non-localized, shows the attribute name as it is. Otherwise, shows the localized name.
Email of the user who last updated the attribute
Time of attribute creation (UTC)
Time of last update to attribute (UTC)
Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page
Total number of records
Was this page helpful?