Getting Started
Authentication v3
- Concepts
- Systems 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(s)
- Shopping Lists
- Shipping Methods
- Webhooks
- 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(s)
- Imports
- Counters
- Inventory
- Locations
- Networks
Integrations
Offers
- Offers (3.0.0)
- Real-time Pricing Engine
- Webhook Events
- Price Lists
- Prices
- Promotions
- Coupons
- Coupon Codes
- Redemptions
- Segments
- Product Exclusion Lists
- Attributes
- Price Types
- Priced Products
- Price Controls
- Imports
- Exports
- Price Methods
- Add-ons
Cart
- Cart (3.0.0)
- Carts
- Line Items
- Adjustments
- Cart FAQ(s)
- Shipping Details
Checkout
- Checkout (3.0.0)
- Checkout Session
- Checkout FAQ(s)
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)
The x-fabric-tenant-id header is a string that contains the ID of the tenant from whom you wish to pull information from.
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
The x-fabric-tenant-id header is a string that contains the ID of the tenant from whom you wish to pull information from.
Unique request ID
Body
Sorting criteria. Sorting is supported only on sku, type and createdAt. - refers to descending while + refers to ascending order
Search criteria to match attributes
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
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
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
}