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
- Product Catalog API
- Create
- Update
- Delete
- Get
- Update Product Attributes
- Add Variants
- Remove Variants
- Get Variants
- Assign Bundle Items
- Remove Bundle Items
- Get Products in a Bundle
- Change Category Assignment
- Publish
- Unpublish
- 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 products
To find specific products for review or reports, you need to specify the criteria for the search. With this endpoint, you can find products (items, variants, and bundles) based on ID or SKU, type, category, and other criteria.
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
Sorting criteria. Sorting is supported only on sku, type and createdAt. - refers to descending while + refers to ascending order
Search criteria to match attributes
Simple string search
Operations that can be performed on a string type
String search
Operations that can be performed on a string type
Attributes that match the search query using single product type
Operations that can be performed on a string type.
Supported product types
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 that match the search query using single status
Operations that can be performed on a single-status
Statuses indicating the product version considered for this operation. For example, <br />1. When the status is DRAFT, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE, this operation will only apply to the Live version of the product.
Search by category IDs
Product Attributes are searched with the combination of id and value. Multiple attributes can be included in the search
Simple string search
Operations that can be performed on a string type
Simple string search
Operations that can be performed on a string type
Date-time search
Search operation that can be performed on a date-time range type
Start date for searching (UTC)
End date for searching (UTC)
Date-time search
Search operation that can be performed on a date-time range type
Start date for searching (UTC)
End date for searching (UTC)
Simple string search
Operations that can be performed on a string type
Number of records to skip before returning records. For example, offset=20, limit=10 returns records 21-30.
Maximum number of records per page
{
"data": [
{
"id": "8d7329dfd5288b0011332376",
"sku": "QWERTTY56DDFFVVV",
"type": "ITEM",
"isActive": true,
"hasDraft": true,
"hasLive": true,
"status": "LIVE",
"attributes": [
{
"id": "6d7329dfd5288b0011332345",
"name": "Color",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
],
"localizedProperties": {
"en-US": {
"attributes": [
{
"id": "517329dfd5288b0011332315",
"name": "Color",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
]
},
"en-IN": {
"attributes": [
{
"id": "617329dfd5288b0011332316",
"name": "Colour",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
]
}
},
"variants": [
{
"id": "717329dfd5288b0011332317"
}
],
"categoryId": "5e7329dfd5288b00113323e4",
"createdAt": "2021-09-14T22:10:30.618Z",
"updatedAt": "2021-09-14T22:10:30.618Z"
}
],
"offset": 5,
"limit": 10,
"count": 100
}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
Search criteria to match attributes
Attributes that match the search query using single status
Operations that can be performed on a single-status
EQUALS Statuses indicating the product version considered for this operation. For example, <br />1. When the status is DRAFT, this operations will only apply to the Draft version of product, if it exists <br />2. When the status is LIVE, this operation will only apply to the Live version of the product.
DRAFT, LIVE Product Attributes are searched with the combination of id and value. Multiple attributes can be included in the search
Attribute ID
Search operation that can be performed on a date-time range type
RANGE Start date for searching (UTC)
End date for searching (UTC)
Sorting criteria. Sorting is supported only on sku, type and createdAt. - 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
Response
Product list by IDs
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 in the response
Product ID
Unique product ID that maps to fabric's standard attribute called SKU. <br /> <b>Note:</b> sku shouldn't include ; or =
Supported product types
ITEM, VARIANT, BUNDLE true: Product is active <br /> false: Product is inactive
true: Product has a Draft version <br /> false: Product doesn't have a Draft version
true: Product has a Live version <br /> false: Product doesn't have a Live version
Represents the current status of product. This value takes precedence over isActive if both are sent in the request.
DRAFT, LIVE Attributes of product
Product ID
Attribute name
Attribute type
Attribute validation - date
Date format. <br> Applicable when attributeType is DATETIME.
true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.
true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product
Attribute value
Localized attribute names
Product ID
Attribute name
Attribute type
Attribute validation - date
true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product Note: Attributes are soft deleted when a product is moved from one category to another.
true: Attributes are inherited from parent product <br /> false: Attributes aren't inherited from parent product
Attribute value
24-character system-generated category ID of product
Time of product creation (UTC)
Time of last update to product (UTC)
Was this page helpful?
{
"data": [
{
"id": "8d7329dfd5288b0011332376",
"sku": "QWERTTY56DDFFVVV",
"type": "ITEM",
"isActive": true,
"hasDraft": true,
"hasLive": true,
"status": "LIVE",
"attributes": [
{
"id": "6d7329dfd5288b0011332345",
"name": "Color",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
],
"localizedProperties": {
"en-US": {
"attributes": [
{
"id": "517329dfd5288b0011332315",
"name": "Color",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
]
},
"en-IN": {
"attributes": [
{
"id": "617329dfd5288b0011332316",
"name": "Colour",
"type": "string",
"isDeleted": false,
"value": "blue",
"isInherited": true
}
]
}
},
"variants": [
{
"id": "717329dfd5288b0011332317"
}
],
"categoryId": "5e7329dfd5288b00113323e4",
"createdAt": "2021-09-14T22:10:30.618Z",
"updatedAt": "2021-09-14T22:10:30.618Z"
}
],
"offset": 5,
"limit": 10,
"count": 100
}