{
"type": "UNAUTHORIZED_ERROR",
"message": "Requester is unauthorized"
}
{
"type": "PAYLOAD_LIMIT_EXCEEDED_ERROR",
"message": "Payload exceeds maximum configured size"
}
{
"type": "SERVER_ERROR",
"message": "Internal Server Error"
}
Operations
Find products
Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.
Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more.
Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.
Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.
{
"type": "UNAUTHORIZED_ERROR",
"message": "Requester is unauthorized"
}
{
"type": "PAYLOAD_LIMIT_EXCEEDED_ERROR",
"message": "Payload exceeds maximum configured size"
}
{
"type": "SERVER_ERROR",
"message": "Internal Server Error"
}
Authorizations
Authorization
string
header
required
This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the Making your first API request section.
Headers
x-fabric-tenant-id
string
required
A header retrieved from your Copilot Account Details that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.
x-fabric-request-id
string
Unique request ID
Query Parameters
locale
string
required
The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format).
The default value is en-US.
excludeBundleProducts
boolean
A flag indicating whether the products associated with a bundle should be excluded from the response. Set it to true to exclude products of a bundle and false to include them in the response.
excludeCollections
boolean
A flag indicating whether the collections should be excluded from the response. Set it to true to exclude collections and false to include them in the response.
excludeCategories
boolean
A flag indicating whether the categories should be excluded from the response. Set it to true to exclude categories and false to include them in the response.
excludeVariants
boolean
A flag indicating whether item variants should be excluded from the response. Set it to true to exclude variants and false to include them in the response.
excludeAttributes
boolean
A flag indicating whether attributes should be excluded from the response. Set it to true to exclude attributes and false to include them in the response.
The sorting criteria. Currently, the supported values are sku, type, productName, itemId, categoryName, and createdAt. Use - to view the results in a descending order and + for ascending.
Example:
"+sku,-productName"
offset
integer<int32>
default:0
The number of records to skip before returning records.
For example, when the offset is 20 and limit is 10, the system returns records from 21 to 30.
Example:
2
limit
integer<int32>
default:10
The maximum number of records per page.
Example:
10
Response
OK
Product Search Result list by IDs
offset
integer<int32>
default:0
The number of records to skip before returning records.
For example, with offset of 20 and limit of 10, the system returns the records from 21-30.
Example:
5
limit
integer<int32>
default:10
The maximum number of records per page.
Example:
10
count
integer<int32>
The total number of records.
Example:
100
data
object[]
The details of a product based on the product type.
Option 1
Option 2
Option 3
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Fabric","colors":{"primary":"#ff2ec1","light":"#ff2ec1","dark":"#ff2ec1"},"logo":{"light":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","dark":"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872","href":"https://developer.fabric.inc"},"favicon":"https://mintcdn.com/fabric-demo/ZXHlkaduf1S9hYir/neon-favicon.webp?fit=max\u0026auto=format\u0026n=ZXHlkaduf1S9hYir\u0026q=85\u0026s=fc87341b907a3b0ed573af9c896468b2","navbar":{"primary":{"type":"button","label":"Request Demo","href":"https://fabric.inc/demo-request"}},"footer":{"socials":{"twitter":"https://twitter.com/fabric_commerce?lang=en","linkedin":"https://www.linkedin.com/company/teamfabric"}},"integrations":{"ga4":{"measurementId":"G-5RS60WM116"}},"contextual":{"options":["copy","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"fabric-demo","hasAudioNarration":false,"actualSubdomain":"fabric-demo","customDomains":["developer.fabric.inc"],"gitSource":{"type":"gitlab","owner":"fabric2/docs","repo":"developer-docs","projectId":58049997,"deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae91effb06fa73e673c75b6:success","clientVersion":"0.0.4131","searchFilterCounts":[{"language":"default","tag":"API Reference","count":721},{"language":"default","tag":"Orders \u0026 Inventory","count":276},{"language":"default","tag":"Product Catalog","count":245},{"language":"default","tag":"Dropship","count":242},{"language":"default","tag":"Orders v2 (OMS v2)","count":162},{"language":"default","tag":"Orders API Endpoints","count":145},{"language":"default","tag":"Customer","count":144},{"language":"default","tag":"Offers","count":118},{"language":"default","tag":"Product Catalog API","count":102},{"language":"default","tag":"Orders v1 (OMS v1)","count":100}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tDMPKzSQ.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tMMPKzSQ.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiAyp8kv8JHgFVrJJLmE0tCMPI.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmv1pVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm21lVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrJJLucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmg1hVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmr19VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLmy15VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm111VF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVFteOcEg.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVGdeOcEg.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: italic;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiDyp8kv8JHgFVrJJLm81xVF9eO.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucXtAKPY.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTufntAKPY.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 100;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiGyp8kv8JHgFVrLPTucHtA.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 200;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLFj_Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 300;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDz8Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJbecmNE.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJnecmNE.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 400;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiEyp8kv8JHgFVrJJfecg.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 500;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLGT9Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 600;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLEj6Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 700;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLCz7Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 800;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLDD4Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* devanagari */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z11lFc-K.woff2) format('woff2');\n unicode-range: U+0900-097F, U+1CD0-1CF4, U+1CF7-1CF9, U+200C-200D, U+20A8, U+20B9, U+20F0, U+25CC, U+A830-A839, U+A8E0-A8FF, U+11B00-11B0A;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1JlFc-K.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Poppins';\n font-style: normal;\n font-weight: 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/poppins/v24/pxiByp8kv8JHgFVrLBT5Z1xlFQ.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nhtml,body,h1,h2,h3,h4,h5,h6,p,span,a{font-family:Poppins}#navbar{background:#000000}#navbar .bg-background-light{background:#000000}#navbar #search-bar-entry{background:rgb(var(--background-dark)/var(--tw-bg-opacity))}#navbar [id^=\"radix\"].bg-background-light{border-radius:8px;background:#fff;color:rgb(var(--gray-500));border:none}#navbar .dark\\:text-gray-300{color:rgb(var(--gray-300))}#navbar .dark\\:bg-primary-light{--tw-bg-opacity: 1;background-color:rgb(var(--primary-light) / var(--tw-bg-opacity))}#navbar .text-gray-800{color:rgb(var(--gray-200))}#navbar .text-gray-600{color:#d4d4d4}#topbar-cta-button .rounded-full,#topbar-cta-button .rounded-full:is(.dark *){border-radius:31px;background:#000000;box-shadow:0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);border:none}#topbar-cta-button .dark\\:text-primary-light,#topbar-cta-button .dark\\:text-primary-light:is(.dark *){color:#FFF;text-align:center;font-size:14px;font-style:normal;font-weight:500;line-height:20px;letter-spacing:-0.084px}.bodyContainer{max-width:63rem;margin:auto;background:transparent}.bodyFull{background:url(\"images/hero-background-unmasked-1.svg\");position:relative;overflow:hidden}.bodyFull:is(.dark *),.bodyContainer:is(.dark *){background-color:transparent}.box-full{border-radius:8px;box-shadow:0px 7.57px 30.28px 0px rgba(0, 0, 0, 0.08);padding:16px 20px}.box-full:is(.dark *){background-color:#4d354d;border:1px solid rgba(255, 255, 255, 0.20)}button p{font-size:18px}button .bg-primary-light{background-color:#121213}.twocol-cntr{width:75%;margin:auto;margin-top:1rem}.gap-x-4{column-gap:1rem;row-gap:1rem}.pink-boxes .card.block{background-color:#fff;border:1px solid #D9ACD9;height:161px}.pink-boxes .card.block h2{font-size:28px;font-weight:300}.my-2{margin:0}.pink-boxes.dark\\:bg-background-dark:is(.dark *){background-color:#0c0a0f!important;z-index:-1;border-radius:15px}.pink-boxes.dark\\:bg-background-dark:is(.dark *) .card.block{background-color:transparent;border:1px solid #494949;position:relative}.three-col.dark\\:bg-background-dark:is(.dark *),.twocol-cntr.dark\\:bg-background-dark:is(.dark *){background-color:#0c0a0f!important;z-index:-1;border-radius:15px}.three-col.dark\\:bg-background-dark:not(.dark *),.twocol-cntr.dark\\:bg-background-dark:not(.dark *){background-color:#fff!important;z-index:-1;border-radius:15px}.bg-primary{background-color:rgb(var(--gray-950) / var(--tw-bg-opacity))}.image-boxes h2{font-size:24px;font-weight:600;line-height:32px;letter-spacing:-0.2px}.subtitle{text-align:center;font-size:20px;font-style:normal;font-weight:400;line-height:28px;letter-spacing:0.04px;width:70%;margin:auto}.spacer{height:80px}.resource-boxes{text-align:center}.resource-boxes .dark\\:bg-background-dark:is(.dark *){background-color:#121213}.bodyContainer hr{border-color:rgb(227, 223, 226)}.bodyContainer:is(.dark *) hr{border-color:#27272A}.col-lg-6{width:50%}.footer{padding-bottom:2.5rem;display:flex;background:transparent}.footer .dark\\:bg-background-dark:is(.dark *){background-color:transparent}.footer li,.footer p{font-size:14px;font-style:normal;font-weight:600;line-height:24px;letter-spacing:-0.084px;margin-top:12px}.footer li a{color:#ff2ec1}.footer .updated.col-lg-6{display:flex;justify-content:flex-end}.fa-thin.fa-question-circle{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/question.svg\");mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-headphones{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/headphones.svg\");mask-repeat:no-repeat;mask-position:center center}.fa-thin.fa-list{mask-image:url(\n \"https://mintlify.b-cdn.net/v6.6.0/regular/list.svg\");mask-repeat:no-repeat;mask-position:center center}.fa-thin:is(.dark *){background-color:#fff}.footer.bg-background-light{background-color:transparent}.dark\\:text-gray-400:is(.dark *){color:#FFF}#navbar-transition{display:none}.callout{border-color:rgba(255 46 193 0.5);background-color:rgba(255 46 193 0.3)}"}],"page":{"pagePath":"v3/product-catalog/api-reference/catalog-connector/operations/search","slug":"/v3/product-catalog/api-reference/catalog-connector/operations/search","pageMetadata":{"openapi":"cc.openapi post /catalog-connector/products/search","title":"Find products","description":"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.\n\u003cNote> \n - Use the `CONTAINS` search operation to search for products based on keywords of SKU, name, and more. \n - Use the `IN` search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.\n - Use the less than or equals to, `LTE`, greater than or equals to, `GTE`, less than, `LT`, greater than, `GT` and equals `EQ` operations to search for date-specific values, such as time of creation or modification.\n\u003c/Note>\n","href":"/v3/product-catalog/api-reference/catalog-connector/operations/search"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n }, {Note} = _components;\n if (!Note) _missingMdxReference(\"Note\", true);\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.\"\n }), \"\\n\", _jsx(Note, {\n children: _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [\"Use the \", _jsx(_components.code, {\n children: \"CONTAINS\"\n }), \" search operation to search for products based on keywords of SKU, name, and more.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Use the \", _jsx(_components.code, {\n children: \"IN\"\n }), \" search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [\"Use the less than or equals to, \", _jsx(_components.code, {\n children: \"LTE\"\n }), \", greater than or equals to, \", _jsx(_components.code, {\n children: \"GTE\"\n }), \", less than, \", _jsx(_components.code, {\n children: \"LT\"\n }), \", greater than, \", _jsx(_components.code, {\n children: \"GT\"\n }), \" and equals \", _jsx(_components.code, {\n children: \"EQ\"\n }), \" operations to search for date-specific values, such as time of creation or modification.\"]\n }), \"\\n\"]\n })\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\nfunction _missingMdxReference(id, component) {\n throw new Error(\"Expected \" + (component ? \"component\" : \"object\") + \" `\" + id + \"` to be defined: you likely forgot to import, pass, or provide it.\");\n}\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"cc.openapi post /catalog-connector/products/search","title":"Find products","description":"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.\n\u003cNote> \n - Use the `CONTAINS` search operation to search for products based on keywords of SKU, name, and more. \n - Use the `IN` search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.\n - Use the less than or equals to, `LTE`, greater than or equals to, `GTE`, less than, `LT`, greater than, `GT` and equals `EQ` operations to search for date-specific values, such as time of creation or modification.\n\u003c/Note>\n","href":"/v3/product-catalog/api-reference/catalog-connector/operations/search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/fabric-demo/6a81ae5b5ebc4bb2/theme.js","/_mintlify/custom/fabric-demo/aebbe2ead0ce64f7/top-form.v1.js","/_mintlify/custom/fabric-demo/5b243c7a49e8f495/gtag.js"],"openApiReferenceData":{"operation":{"tags":["General Catalog Connector Operations"],"summary":"Find products","description":"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle.\n\u003cNote> \n - Use the `CONTAINS` search operation to search for products based on keywords of SKU, name, and more. \n - Use the `IN` search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types.\n - Use the less than or equals to, `LTE`, greater than or equals to, `GTE`, less than, `LT`, greater than, `GT` and equals `EQ` operations to search for date-specific values, such as time of creation or modification.\n\u003c/Note>\n","operationId":"getCatalogsBySearchCriteria","parameters":["53f234be-02d6-4184-b98e-2036f68e47a8","7f98f1af-d21b-4451-bf5a-cb30ceeae675","0c469bcf-a62f-4ec5-9149-017362d7c689","5d0231ad-0ab7-4476-88e9-15deea4cedb1","d7a62c4f-6822-4452-becc-acf6690422ef","59cae820-dca2-41a2-b8ff-100d2dd1498e","0b44a902-1a57-4477-9444-1332793e29d3","4f6f7a75-88ac-43ba-b069-e9cbee455903"],"requestBody":"7e941020-3a3c-46dd-9d51-25ee790e61e6","responses":{"200":"6ba5da32-adec-412f-8b19-77bfa4046fe9","400":"c9bf1514-2ff2-48ac-879b-c4de1fcacc61","401":"017bcb68-c9f8-4146-bb8d-1bf248140302","413":"6b6a4270-57a6-4c40-aea4-711c7c40788c","500":"734d92a0-30af-4f1e-968e-0b74a2b9c4c7"},"method":"post","type":"path","servers":["1031a83b-c45a-4788-983b-6fca55ea06a5"],"security":["09124e2c-8536-4b2d-b6cf-04cc3ae9b3cc"],"path":"/catalog-connector/products/search","baseUrlOptions":["https://api.fabric.inc/v3"],"title":"Find products","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"53f234be-02d6-4184-b98e-2036f68e47a8":{"in":"header","name":"x-fabric-tenant-id","schema":{"type":"string","isRequired":true,"description":"A header retrieved from your [Copilot Account Details](/v3/platform/settings/account-details/getting-the-account-id) that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints.","uniqueKey":"","typeLabel":"string"},"required":true,"example":"5f328bf0b5f328bf0b5f328b","description":"A header retrieved from your [Copilot Account Details](/v3/platform/settings/account-details/getting-the-account-id) that's used by the API to identify the tenant making the request. Tenant ID must be included in the authentication header for API requests to access any of fabric’s endpoints."},"7f98f1af-d21b-4451-bf5a-cb30ceeae675":{"name":"locale","in":"query","example":"en-US","description":"The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format). \n\nThe default value is en-US.\n","schema":{"type":"string","isRequired":true,"description":"The language code, which is a combination of language (ISO 639 format) and country (ISO 3166 format). \n\nThe default value is en-US.\n","uniqueKey":"","typeLabel":"string"},"required":true},"0c469bcf-a62f-4ec5-9149-017362d7c689":{"name":"excludeBundleProducts","in":"query","example":false,"description":"A flag indicating whether the products associated with a bundle should be excluded from the response. Set it to `true` to exclude products of a bundle and `false` to include them in the response.","schema":{"type":"boolean","isRequired":false,"description":"A flag indicating whether the products associated with a bundle should be excluded from the response. Set it to `true` to exclude products of a bundle and `false` to include them in the response.","uniqueKey":"","typeLabel":"boolean"},"required":false},"5d0231ad-0ab7-4476-88e9-15deea4cedb1":{"name":"excludeCollections","in":"query","example":false,"description":"A flag indicating whether the collections should be excluded from the response. Set it to `true` to exclude collections and `false` to include them in the response.","schema":{"type":"boolean","isRequired":false,"description":"A flag indicating whether the collections should be excluded from the response. Set it to `true` to exclude collections and `false` to include them in the response.","uniqueKey":"","typeLabel":"boolean"},"required":false},"d7a62c4f-6822-4452-becc-acf6690422ef":{"name":"excludeCategories","in":"query","example":false,"description":"A flag indicating whether the categories should be excluded from the response. Set it to `true` to exclude categories and `false` to include them in the response.","schema":{"type":"boolean","isRequired":false,"description":"A flag indicating whether the categories should be excluded from the response. Set it to `true` to exclude categories and `false` to include them in the response.","uniqueKey":"","typeLabel":"boolean"},"required":false},"59cae820-dca2-41a2-b8ff-100d2dd1498e":{"name":"excludeVariants","in":"query","example":false,"description":"A flag indicating whether item variants should be excluded from the response. Set it to `true` to exclude variants and `false` to include them in the response.","schema":{"type":"boolean","isRequired":false,"description":"A flag indicating whether item variants should be excluded from the response. Set it to `true` to exclude variants and `false` to include them in the response.","uniqueKey":"","typeLabel":"boolean"},"required":false},"0b44a902-1a57-4477-9444-1332793e29d3":{"name":"excludeAttributes","in":"query","example":false,"description":"A flag indicating whether attributes should be excluded from the response. Set it to `true` to exclude attributes and `false` to include them in the response.","schema":{"type":"boolean","isRequired":false,"description":"A flag indicating whether attributes should be excluded from the response. Set it to `true` to exclude attributes and `false` to include them in the response.","uniqueKey":"","typeLabel":"boolean"},"required":false},"4f6f7a75-88ac-43ba-b069-e9cbee455903":{"in":"header","name":"x-fabric-request-id","description":"Unique request ID","schema":{"type":"string","isRequired":false,"description":"Unique request ID","uniqueKey":"","typeLabel":"string"},"example":"263e731c-45c8-11ed-b878-0242ac120002","required":false}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","required":["search"],"properties":{"search":{"minProperties":1,"additionalProperties":false,"description":"The search criteria to find products.","type":"object","properties":{"keyword":{"type":"object","description":"The search criteria based on keywords of product name, SKU, item ID, more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.keyword.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.keyword.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.keyword.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.keyword.value","typeLabel":"string | null"}},"uniqueKey":"search.keyword","typeLabel":"object"},"id":{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.id.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.id.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.id.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.id.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.id.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.id","typeLabel":"object"},"sku":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.sku.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.sku.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.sku.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.sku.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.sku.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.sku.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.sku.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.sku.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.sku.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.sku.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.sku.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.sku","typeLabel":"object"},"productName":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.productName.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.productName.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.productName.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.productName.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.productName.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.productName.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.productName.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.productName.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.productName.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.productName.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.productName.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.productName","typeLabel":"object"},"image":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.image.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.image.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.image.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.image.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.image.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.image.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.image.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.image.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.image.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.image.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.image.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.image","typeLabel":"object"},"itemId":{"type":"object","description":"The search criteria based on integer values.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.itemId.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"integer","format":"int32","description":"Represents an integer schema.","example":1,"uniqueKey":"search.itemId.value.items.[INDEX].oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Represents an integer schema.","example":1,"uniqueKey":"search.itemId.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.itemId.value.items.[INDEX]","typeLabel":"integer\u003cint32> | null"},"uniqueKey":"search.itemId.value","typeLabel":"(integer\u003cint32> | null)[]"}},"uniqueKey":"search.itemId","typeLabel":"object"},"type":{"type":"object","description":"The search criteria based on product type.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.type.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","description":"The type of product.","enum":["BUNDLE","VARIANT","ITEM"],"example":"ITEM","uniqueKey":"search.type.value.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"search.type.value","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"search.type","typeLabel":"object"},"parentSku":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.parentSku.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.parentSku.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.parentSku.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.parentSku.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.parentSku.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.parentSku.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.parentSku.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.parentSku.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.parentSku.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.parentSku.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.parentSku.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.parentSku","typeLabel":"object"},"categoryId":{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.categoryId.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryId.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryId.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.categoryId.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.categoryId.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.categoryId","typeLabel":"object"},"categoryName":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.categoryName.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryName.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryName.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.categoryName.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.categoryName.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.categoryName.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.categoryName.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryName.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.categoryName.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.categoryName.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.categoryName.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.categoryName","typeLabel":"object"},"collectionId":{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.collectionId.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionId.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionId.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.collectionId.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.collectionId.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.collectionId","typeLabel":"object"},"collectionName":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.collectionName.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionName.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionName.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.collectionName.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.collectionName.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.collectionName.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.collectionName.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionName.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.collectionName.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.collectionName.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.collectionName.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.collectionName","typeLabel":"object"},"bundleProductName":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.bundleProductName.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductName.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductName.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.bundleProductName.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.bundleProductName.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.bundleProductName.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.bundleProductName.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductName.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductName.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.bundleProductName.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.bundleProductName.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.bundleProductName","typeLabel":"object"},"bundleProductSku":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.bundleProductSku.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductSku.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductSku.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.bundleProductSku.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.bundleProductSku.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.bundleProductSku.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.bundleProductSku.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductSku.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.bundleProductSku.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.bundleProductSku.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.bundleProductSku.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.bundleProductSku","typeLabel":"object"},"bundleProductCount":{"type":"object","description":"The search criteria based on integer values.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.bundleProductCount.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"integer","format":"int32","description":"Represents an integer schema.","example":1,"uniqueKey":"search.bundleProductCount.value.items.[INDEX].oneOf.0","typeLabel":"integer\u003cint32>"},{"type":"null","format":"int32","description":"Represents an integer schema.","example":1,"uniqueKey":"search.bundleProductCount.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.bundleProductCount.value.items.[INDEX]","typeLabel":"integer\u003cint32> | null"},"uniqueKey":"search.bundleProductCount.value","typeLabel":"(integer\u003cint32> | null)[]"}},"uniqueKey":"search.bundleProductCount","typeLabel":"object"},"variantProductName":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.variantProductName.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductName.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductName.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.variantProductName.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.variantProductName.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.variantProductName.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.variantProductName.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductName.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductName.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.variantProductName.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.variantProductName.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.variantProductName","typeLabel":"object"},"variantProductSku":{"oneOf":[{"type":"object","description":"The search operation based on a string value, such as ID, name, SKU, image URL, attribute type, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.variantProductSku.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductSku.oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductSku.oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.variantProductSku.oneOf.0.value.items.[INDEX]","typeLabel":"string | null"},"uniqueKey":"search.variantProductSku.oneOf.0.value","typeLabel":"(string | null)[]"}},"uniqueKey":"search.variantProductSku.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on single-string search.\nFor example, by using the `CONTAINS` operation, you can search for `parentSku`, `categoryName`, `collectionName`, `bundleProductSku`, `bundleProductName`, and more.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS"],"uniqueKey":"search.variantProductSku.oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductSku.oneOf.1.value.oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","example":"blue","uniqueKey":"search.variantProductSku.oneOf.1.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"search.variantProductSku.oneOf.1.value","typeLabel":"string | null"}},"uniqueKey":"search.variantProductSku.oneOf.1","typeLabel":"object"}],"uniqueKey":"search.variantProductSku","typeLabel":"object"},"attributes":{"type":"array","items":{"oneOf":[{"type":"object","description":"The search criteria based on attributes.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"search.attributes.items.[INDEX].oneOf.0.name","typeLabel":"string"},"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX].oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value.items.[INDEX]","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"uniqueKey":"search.attributes.items.[INDEX].oneOf.0.value","typeLabel":"(boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[])[]"}},"uniqueKey":"search.attributes.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on the attributes.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"search.attributes.items.[INDEX].oneOf.1.name","typeLabel":"string"},"op":{"type":"string","description":"The type of search operation.","example":"CONTAINS","enum":["CONTAINS","LTE","GTE","LT","GT"],"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.op","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"search.attributes.items.[INDEX].oneOf.1.value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"}},"uniqueKey":"search.attributes.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"search.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"search.attributes","typeLabel":"object[]"},"createdAt":{"oneOf":[{"type":"object","description":"The search criteria based on date-time using the IN condition.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.createdAt.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","uniqueKey":"search.createdAt.oneOf.0.value.items.[INDEX]","typeLabel":"string"},"example":["2023-01-14T22:10:30.618Z","2023-05-14T22:10:30.618Z"],"description":"The timestamp to search.","uniqueKey":"search.createdAt.oneOf.0.value","typeLabel":"string[]"}},"uniqueKey":"search.createdAt.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on date range.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"RANGE","enum":["RANGE"],"uniqueKey":"search.createdAt.oneOf.1.op","typeLabel":"enum\u003cstring>"},"fromValue":{"type":"string","description":"The start date for searching, in UTC format.","example":"2022-09-14T22:10:30.618Z","uniqueKey":"search.createdAt.oneOf.1.fromValue","typeLabel":"string"},"toValue":{"type":"string","description":"The end date for searching, in UTC format.","example":"2023-04-14T22:10:30.618Z","uniqueKey":"search.createdAt.oneOf.1.toValue","typeLabel":"string"}},"uniqueKey":"search.createdAt.oneOf.1","typeLabel":"object"},{"type":"object","description":"The search criteria based on date-time.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"GTE","enum":["EQUALS","LTE","GTE","LT","GT"],"uniqueKey":"search.createdAt.oneOf.2.op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The timestamp to be searched, in UTC format.","example":"2021-09-14T22:10:30.618Z","uniqueKey":"search.createdAt.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"search.createdAt.oneOf.2","typeLabel":"object"}],"uniqueKey":"search.createdAt","typeLabel":"object"},"updatedAt":{"oneOf":[{"type":"object","description":"The search criteria based on date-time using the IN condition.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"IN","enum":["IN"],"uniqueKey":"search.updatedAt.oneOf.0.op","typeLabel":"enum\u003cstring>"},"value":{"type":"array","items":{"type":"string","uniqueKey":"search.updatedAt.oneOf.0.value.items.[INDEX]","typeLabel":"string"},"example":["2023-01-14T22:10:30.618Z","2023-05-14T22:10:30.618Z"],"description":"The timestamp to search.","uniqueKey":"search.updatedAt.oneOf.0.value","typeLabel":"string[]"}},"uniqueKey":"search.updatedAt.oneOf.0","typeLabel":"object"},{"type":"object","description":"The search criteria based on date range.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"RANGE","enum":["RANGE"],"uniqueKey":"search.updatedAt.oneOf.1.op","typeLabel":"enum\u003cstring>"},"fromValue":{"type":"string","description":"The start date for searching, in UTC format.","example":"2022-09-14T22:10:30.618Z","uniqueKey":"search.updatedAt.oneOf.1.fromValue","typeLabel":"string"},"toValue":{"type":"string","description":"The end date for searching, in UTC format.","example":"2023-04-14T22:10:30.618Z","uniqueKey":"search.updatedAt.oneOf.1.toValue","typeLabel":"string"}},"uniqueKey":"search.updatedAt.oneOf.1","typeLabel":"object"},{"type":"object","description":"The search criteria based on date-time.","properties":{"op":{"type":"string","description":"The type of search operation.","example":"GTE","enum":["EQUALS","LTE","GTE","LT","GT"],"uniqueKey":"search.updatedAt.oneOf.2.op","typeLabel":"enum\u003cstring>"},"value":{"type":"string","description":"The timestamp to be searched, in UTC format.","example":"2021-09-14T22:10:30.618Z","uniqueKey":"search.updatedAt.oneOf.2.value","typeLabel":"string"}},"uniqueKey":"search.updatedAt.oneOf.2","typeLabel":"object"}],"uniqueKey":"search.updatedAt","typeLabel":"object"}},"example":{"keyword":{"op":"CONTAINS","value":"NIKE237765"},"id":{"op":"IN","value":["6482b9524ffa4978fd9cbf5c"]},"sku":{"op":"IN","value":["NIKE237765"]},"productName":{"op":"IN","value":["Nike runner shoes"]},"image":{"op":"IN","value":["https://myawsomestore.com/is/image/nike/8801290_s7"]},"itemId":{"op":"IN","value":[2700537]},"type":{"op":"IN","value":["ITEM"]},"parentSku":{"op":"CONTAINS","value":"NIKE237765"},"parentId":{"op":"IN","value":["6482e47771609dfca2beb29f"]},"categoryId":{"op":"IN","value":["648014741adc8a9de14e1a68"]},"categoryName":{"op":"CONTAINS","value":"Shoes"},"collectionName":{"op":"CONTAINS","value":"Flash Sale"},"bundleProductSku":{"op":"CONTAINS","value":"BUNDLE237765"},"bundleProductName":{"op":"CONTAINS","value":"nike"},"bundleProductId":{"op":"IN","value":["60ad7e9d858eb50007abbb19#123124"]},"bundleProductCount":{"op":"GTE","value":10},"attributes":[{"name":"Color","op":"IN","value":["black"]}],"attributeIds":{"op":"IN","value":["60ad7e9d858eb50007abbb19","4aqz7e9d858eb5000cdeas12"]},"attributeTypes":{"op":"IN","value":["TEXT","BOOLEAN","LOV","NUMBER"]},"createdAt":{"op":"LTE","value":"2021-12-13T13:56:09.006Z"},"updatedAt":{"op":"LTE","value":"2021-12-13T13:56:09.006Z"}},"isRequired":true,"uniqueKey":"search","typeLabel":"object"},"sort":{"type":"string","description":"The sorting criteria. Currently, the supported values are `sku`, `type`, `productName`, `itemId`, `categoryName`, and `createdAt`. Use `-` to view the results in a descending order and `+` for ascending.","example":"+sku,-productName","uniqueKey":"sort","typeLabel":"string"},"offset":{"description":"The number of records to skip before returning records.\nFor example, when the offset is 20 and limit is 10, the system returns records from 21 to 30.","type":"integer","format":"int32","default":0,"example":2,"uniqueKey":"offset","typeLabel":"integer\u003cint32>"},"limit":{"description":"The maximum number of records per page.","type":"integer","format":"int32","default":10,"example":10,"uniqueKey":"limit","typeLabel":"integer\u003cint32>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"search":{"keyword":{"op":"CONTAINS","value":"NIKE237765"},"id":{"op":"IN","value":["6482b9524ffa4978fd9cbf5c"]},"sku":{"op":"IN","value":["NIKE237765"]},"productName":{"op":"IN","value":["Nike runner shoes"]},"image":{"op":"IN","value":["https://myawsomestore.com/is/image/nike/8801290_s7"]},"itemId":{"op":"IN","value":[2700537]},"type":{"op":"IN","value":["ITEM"]},"parentSku":{"op":"CONTAINS","value":"NIKE237765"},"parentId":{"op":"IN","value":["6482e47771609dfca2beb29f"]},"categoryId":{"op":"IN","value":["648014741adc8a9de14e1a68"]},"categoryName":{"op":"CONTAINS","value":"Shoes"},"collectionName":{"op":"CONTAINS","value":"Flash Sale"},"bundleProductSku":{"op":"CONTAINS","value":"BUNDLE237765"},"bundleProductName":{"op":"CONTAINS","value":"nike"},"bundleProductId":{"op":"IN","value":["60ad7e9d858eb50007abbb19#123124"]},"bundleProductCount":{"op":"GTE","value":10},"attributes":[{"name":"Color","op":"IN","value":["black"]}],"attributeIds":{"op":"IN","value":["60ad7e9d858eb50007abbb19","4aqz7e9d858eb5000cdeas12"]},"attributeTypes":{"op":"IN","value":["TEXT","BOOLEAN","LOV","NUMBER"]},"createdAt":{"op":"LTE","value":"2021-12-13T13:56:09.006Z"},"updatedAt":{"op":"LTE","value":"2021-12-13T13:56:09.006Z"}},"sort":"+sku,-productName","offset":2,"limit":10}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"6ba5da32-adec-412f-8b19-77bfa4046fe9":{"headers":{"x-fabric-request-id":{"schema":{"type":"string"},"required":false,"example":"263e731c-45c8-11ed-b878-0242ac120002","description":"Unique request ID"}},"description":"OK","content":{"application/json":{"schema":{"type":"object","description":"Product Search Result list by IDs","properties":{"offset":{"type":"integer","format":"int32","default":0,"example":5,"description":"The number of records to skip before returning records.\nFor example, with offset of 20 and limit of 10, the system returns the records from 21-30.","uniqueKey":"offset","typeLabel":"integer\u003cint32>"},"limit":{"description":"The maximum number of records per page.","type":"integer","format":"int32","default":10,"example":10,"uniqueKey":"limit","typeLabel":"integer\u003cint32>"},"count":{"description":"The total number of records.","type":"integer","format":"int32","example":100,"uniqueKey":"count","typeLabel":"integer\u003cint32>"},"data":{"type":"array","items":{"oneOf":[{"type":"object","description":"The details of a product based on the product type.","properties":{"productName":{"type":"string","description":"The name of the product.","example":"Nike Men's Training Shoe","uniqueKey":"data.items.[INDEX].oneOf.0.productName","typeLabel":"string"},"images":{"type":"array","description":"The list of product images.","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.images.items.[INDEX]","typeLabel":"string"},"example":["https://myawsomestore.com/is/image/nike/8801290_s7"],"uniqueKey":"data.items.[INDEX].oneOf.0.images","typeLabel":"string[]"},"attributes":{"type":"array","description":"The name of the attribute and its value.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.0.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.attributes","typeLabel":"object[]"},"createdAt":{"type":"string","description":"The time of product creation, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.0.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time of last update to product, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.0.updatedAt","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.0.sku","typeLabel":"string"},"id":{"type":"string","example":"5f7329dfd5288b0011332366","description":"A 24-character system-generated ID.","uniqueKey":"data.items.[INDEX].oneOf.0.id","typeLabel":"string"},"itemId":{"type":"integer","format":"int32","example":1682313863,"description":"A unique identifier of an item, a variant or a bundle.","uniqueKey":"data.items.[INDEX].oneOf.0.itemId","typeLabel":"integer\u003cint32>"},"categoryName":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.0.categoryName","typeLabel":"string"},"categoryId":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.0.categoryId","typeLabel":"string"},"categories":{"type":"array","description":"The list of categories, including their paths from the leaf category to the root category.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0.categories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.categories","typeLabel":"object[]"},"collections":{"type":"array","description":"The details of the collection used to display products on the storefront.","items":{"type":"object","additionalProperties":false,"description":"The collection details.","properties":{"id":{"type":"string","description":"A 24-character system-generated collection ID.","example":"648014741adc8a9de14e1a68","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the collection.","example":"Flash Sale","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].name","typeLabel":"string"},"hierarchy":{"type":"array","description":"The list of collections, including their paths from the leaf collection to the root collection.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX].hierarchy","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0.collections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.collections","typeLabel":"object[]"},"type":{"type":"string","description":"Represents the `item` product type.","enum":["ITEM"],"example":"ITEM","uniqueKey":"data.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"variants":{"type":"array","description":"The details of item variants.","items":{"type":"object","description":"A common schema for product, variants, and bundles along with their identifiers.","properties":{"productName":{"type":"string","description":"The name of the product.","example":"Nike Men's Training Shoe","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].productName","typeLabel":"string"},"images":{"type":"array","description":"The list of product images.","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].images.items.[INDEX]","typeLabel":"string"},"example":["https://myawsomestore.com/is/image/nike/8801290_s7"],"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].images","typeLabel":"string[]"},"attributes":{"type":"array","description":"The name of the attribute and its value.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].attributes","typeLabel":"object[]"},"createdAt":{"type":"string","description":"The time of product creation, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time of last update to product, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].sku","typeLabel":"string"},"id":{"type":"string","example":"5f7329dfd5288b0011332366","description":"A 24-character system-generated ID.","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].id","typeLabel":"string"},"itemId":{"type":"integer","format":"int32","example":1682313863,"description":"A unique identifier of an item, a variant or a bundle.","uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX].itemId","typeLabel":"integer\u003cint32>"}},"uniqueKey":"data.items.[INDEX].oneOf.0.variants.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.0.variants","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"The details of a product based on the product type.","properties":{"productName":{"type":"string","description":"The name of the product.","example":"Nike Men's Training Shoe","uniqueKey":"data.items.[INDEX].oneOf.1.productName","typeLabel":"string"},"images":{"type":"array","description":"The list of product images.","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.1.images.items.[INDEX]","typeLabel":"string"},"example":["https://myawsomestore.com/is/image/nike/8801290_s7"],"uniqueKey":"data.items.[INDEX].oneOf.1.images","typeLabel":"string[]"},"attributes":{"type":"array","description":"The name of the attribute and its value.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.1.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.attributes","typeLabel":"object[]"},"createdAt":{"type":"string","description":"The time of product creation, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.1.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time of last update to product, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.1.updatedAt","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.1.sku","typeLabel":"string"},"id":{"type":"string","example":"5f7329dfd5288b0011332366","description":"A 24-character system-generated ID.","uniqueKey":"data.items.[INDEX].oneOf.1.id","typeLabel":"string"},"itemId":{"type":"integer","format":"int32","example":1682313863,"description":"A unique identifier of an item, a variant or a bundle.","uniqueKey":"data.items.[INDEX].oneOf.1.itemId","typeLabel":"integer\u003cint32>"},"categoryName":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.1.categoryName","typeLabel":"string"},"categoryId":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.1.categoryId","typeLabel":"string"},"categories":{"type":"array","description":"The list of categories, including their paths from the leaf category to the root category.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.1.categories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.categories","typeLabel":"object[]"},"collections":{"type":"array","description":"The details of the collection used to display products on the storefront.","items":{"type":"object","additionalProperties":false,"description":"The collection details.","properties":{"id":{"type":"string","description":"A 24-character system-generated collection ID.","example":"648014741adc8a9de14e1a68","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the collection.","example":"Flash Sale","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].name","typeLabel":"string"},"hierarchy":{"type":"array","description":"The list of collections, including their paths from the leaf collection to the root collection.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX].hierarchy","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.1.collections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.1.collections","typeLabel":"object[]"},"type":{"type":"string","description":"Represents the `variant` product type.","enum":["VARIANT"],"example":"VARIANT","uniqueKey":"data.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"parentSku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.1.parentSku","typeLabel":"string"},"parentId":{"type":"string","description":"A 24-character system-generated ID of the parent item.","example":"648014741adc8a9de14e1a68","uniqueKey":"data.items.[INDEX].oneOf.1.parentId","typeLabel":"string"}},"uniqueKey":"data.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"The details of a product based on the product type.","properties":{"productName":{"type":"string","description":"The name of the product.","example":"Nike Men's Training Shoe","uniqueKey":"data.items.[INDEX].oneOf.2.productName","typeLabel":"string"},"images":{"type":"array","description":"The list of product images.","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.images.items.[INDEX]","typeLabel":"string"},"example":["https://myawsomestore.com/is/image/nike/8801290_s7"],"uniqueKey":"data.items.[INDEX].oneOf.2.images","typeLabel":"string[]"},"attributes":{"type":"array","description":"The name of the attribute and its value.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.2.attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.attributes","typeLabel":"object[]"},"createdAt":{"type":"string","description":"The time of product creation, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.2.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time of last update to product, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.2.updatedAt","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.2.sku","typeLabel":"string"},"id":{"type":"string","example":"5f7329dfd5288b0011332366","description":"A 24-character system-generated ID.","uniqueKey":"data.items.[INDEX].oneOf.2.id","typeLabel":"string"},"itemId":{"type":"integer","format":"int32","example":1682313863,"description":"A unique identifier of an item, a variant or a bundle.","uniqueKey":"data.items.[INDEX].oneOf.2.itemId","typeLabel":"integer\u003cint32>"},"categoryName":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.2.categoryName","typeLabel":"string"},"categoryId":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.2.categoryId","typeLabel":"string"},"categories":{"type":"array","description":"The list of categories, including their paths from the leaf category to the root category.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2.categories.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.categories","typeLabel":"object[]"},"collections":{"type":"array","description":"The details of the collection used to display products on the storefront.","items":{"type":"object","additionalProperties":false,"description":"The collection details.","properties":{"id":{"type":"string","description":"A 24-character system-generated collection ID.","example":"648014741adc8a9de14e1a68","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the collection.","example":"Flash Sale","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].name","typeLabel":"string"},"hierarchy":{"type":"array","description":"The list of collections, including their paths from the leaf collection to the root collection.","items":{"type":"object","additionalProperties":false,"description":"The details of a category.","properties":{"id":{"type":"string","description":"A 24-character system-generated category ID.","example":"648055dff4aa98d6c43e02da","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"The name of the category.","example":"Shoes","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].name","typeLabel":"string"},"isRoot":{"type":"boolean","description":"A flag indicating whether the given category is a root category. Set it to `true` if it's a root category and `false` if it isn't a root category.","example":true,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].isRoot","typeLabel":"boolean"},"attributes":{"type":"array","description":"The details of an attribute.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX].attributes","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX].hierarchy","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2.collections.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.collections","typeLabel":"object[]"},"type":{"type":"string","description":"Represents the `bundle` product type.","enum":["BUNDLE"],"example":"BUNDLE","uniqueKey":"data.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"bundleProducts":{"type":"array","description":"The details of a bundle.","items":{"type":"object","description":"The details of the bundle.","properties":{"productName":{"type":"string","description":"The name of the product.","example":"Nike Men's Training Shoe","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].productName","typeLabel":"string"},"images":{"type":"array","description":"The list of product images.","items":{"type":"string","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].images.items.[INDEX]","typeLabel":"string"},"example":["https://myawsomestore.com/is/image/nike/8801290_s7"],"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].images","typeLabel":"string[]"},"attributes":{"type":"array","description":"The name of the attribute and its value.","items":{"type":"object","additionalProperties":false,"description":"The details of the attribute.","properties":{"name":{"type":"string","description":"The name of the attribute.","example":"isOnSale","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].name","typeLabel":"string"},"value":{"oneOf":[{"type":"boolean","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.1","typeLabel":"null"},{"type":"string","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.2","typeLabel":"string"},{"type":"null","description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.3","typeLabel":"null"},{"type":"integer","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.4","typeLabel":"integer\u003cint32>"},{"type":"null","description":"The attribute value.","format":"int32","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.5","typeLabel":"null"},{"type":"number","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.6","typeLabel":"number\u003cdouble>"},{"type":"null","description":"The attribute value.","format":"double","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.7","typeLabel":"null"},{"type":"array","items":{"oneOf":[{"type":"string","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"null","description":"Represents a string schema.","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.8.items.[INDEX]","typeLabel":"string | null"},"description":"The attribute value.","example":false,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value.oneOf.8","typeLabel":"(string | null)[]"}],"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].value","typeLabel":"boolean · null · string · null · integer\u003cint32> · null · number\u003cdouble> · null · (string | null)[]"},"id":{"type":"string","description":"A 24-character system-generated attribute ID.","example":"6480216349256438cb7d53b5","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","description":"The type of attribute.","enum":["NUMBER","BOOLEAN","TEXT","LOV"],"example":"TEXT","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].attributes","typeLabel":"object[]"},"createdAt":{"type":"string","description":"The time of product creation, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","description":"The time of last update to product, in UTC format.","format":"date-time","example":"2021-12-13T13:56:09.006Z","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"sku":{"type":"string","description":"Product SKU","example":"24ggs67-e89b-12e3-a456-026614174119","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].sku","typeLabel":"string"},"id":{"type":"string","example":"5f7329dfd5288b0011332366","description":"A 24-character system-generated ID.","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].id","typeLabel":"string"},"itemId":{"type":"integer","format":"int32","example":1682313863,"description":"A unique identifier of an item, a variant or a bundle.","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].itemId","typeLabel":"integer\u003cint32>"},"quantity":{"type":"integer","format":"int32","description":"The quantity of the bundle.","example":2,"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].quantity","typeLabel":"integer\u003cint32>"},"type":{"type":"string","description":"The type of product.","enum":["BUNDLE","VARIANT","ITEM"],"example":"ITEM","uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data.items.[INDEX].oneOf.2.bundleProducts","typeLabel":"object[]"}},"uniqueKey":"data.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"data.items.[INDEX]","typeLabel":"object"},"uniqueKey":"data","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Product":{"title":"Product","value":{"offset":0,"limit":10,"count":1,"data":[{"sku":"NIKE237765","productName":"Nike runner shoes","id":"6482b9524ffa4978fd9cbf5c","itemId":2700537,"categoryName":"Sport Shoes","categoryId":"648014741adc8a9de14e1a68","images":["https://myawsomestore.com/is/image/nike/8801290_s7"],"attributes":[{"name":"Color","value":"black","id":"6480216349256438cb7d53b5","type":"TEXT"},{"name":"Wide Fit","value":false,"id":"640db94f9fc28b255d155a42","type":"BOOLEAN"}],"type":"ITEM","variants":[{"sku":"NIKE237766","productName":"Nike runner white shoes","id":"648aa9280d7b561b4663038c","itemId":2700538,"images":["https://myawsomestore.com/is/image/nike/8801291_s7"],"attributes":[{"name":"Color","value":"White","id":"6480216349256438cb7d53b5","type":"TEXT"},{"name":"Wide Fit","value":true,"id":"640db94f9fc28b255d155a42","type":"BOOLEAN"},{"name":"Brand","value":["Nike"],"id":"640db94f9fc28b255d155a42","type":"LOV"}],"createdAt":"2021-12-13T13:56:09.006Z","updatedAt":"2021-12-13T13:56:09.006Z"}],"categories":[{"name":"Sport Shoes","id":"648014741adc8a9de14e1a68","isRoot":false,"attributes":[{"name":"Fit","value":"Relaxed Fit","id":"648014741adc8a9de14e1a00","type":"TEXT"}]},{"name":"Shoes","id":"648aa9258fdef29675dbce42","isRoot":true,"attributes":[{"name":"Material","value":"Mesh"}]}],"collections":[{"name":"Flash sale","id":"648055dff4aa98d6c43e02da","hierarchy":[{"name":"Flash Sale","id":"648055dff4aa98d6c43e02da","isRoot":false,"attributes":[{"name":"Duration","value":600,"type":"NUMBER"}]},{"name":"Sales","id":"648055e0f4aa98d6c43e02f7","isRoot":true}]}],"createdAt":"2021-12-13T13:56:09.006Z","updatedAt":"2021-12-13T13:56:09.006Z"}]}}},"exampleType":"examples"}},"exampleType":"examples"},"c9bf1514-2ff2-48ac-879b-c4de1fcacc61":{"description":"Request is invalid or malformed","headers":{"x-fabric-request-id":{"schema":{"type":"string"},"required":false,"example":"263e731c-45c8-11ed-b878-0242ac120002","description":"Unique request ID"}},"content":{"application/json":{"schema":{"type":"object","description":"The details of the error.","properties":{"message":{"type":"string","description":"A placeholder error message for all the 4xx, 5xx errors","example":"Request is invalid","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","description":"A placeholder error type for all the 4xx, 5xx errors","example":"Bad request","uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type.","example":"CLIENT_ERROR","uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","description":"The error message corresponding to the `type`.","example":"Invalid request. Unable to find/create product","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Request is invalid","type":"Bad request","errors":[{"type":"CLIENT_ERROR","message":"Invalid request. Unable to find/create product"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"017bcb68-c9f8-4146-bb8d-1bf248140302":{"description":"The requester is unauthorized.","headers":{"x-fabric-request-id":{"schema":{"type":"string"},"required":false,"example":"263e731c-45c8-11ed-b878-0242ac120002","description":"Unique request ID"}},"content":{"application/json":{"schema":{"type":"object","description":"The details of the error.","properties":{"message":{"type":"string","description":"A placeholder error message for all the 4xx, 5xx errors","example":"Request is invalid","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","description":"A placeholder error type for all the 4xx, 5xx errors","example":"Bad request","uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type.","example":"CLIENT_ERROR","uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","description":"The error message corresponding to the `type`.","example":"Invalid request. Unable to find/create product","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"UNAUTHORIZED_ERROR","message":"Requester is unauthorized"},"examples":{"Example":{"title":"Example","value":{"type":"UNAUTHORIZED_ERROR","message":"Requester is unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"6b6a4270-57a6-4c40-aea4-711c7c40788c":{"description":"The payload limit is exceeded. It should be less than 10MB.","headers":{"x-fabric-request-id":{"schema":{"type":"string"},"required":false,"example":"263e731c-45c8-11ed-b878-0242ac120002","description":"Unique request ID"}},"content":{"application/json":{"schema":{"type":"object","description":"The details of the error.","properties":{"message":{"type":"string","description":"A placeholder error message for all the 4xx, 5xx errors","example":"Request is invalid","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","description":"A placeholder error type for all the 4xx, 5xx errors","example":"Bad request","uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type.","example":"CLIENT_ERROR","uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","description":"The error message corresponding to the `type`.","example":"Invalid request. Unable to find/create product","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"PAYLOAD_LIMIT_EXCEEDED_ERROR","message":"Payload exceeds maximum configured size"},"examples":{"Example":{"title":"Example","value":{"type":"PAYLOAD_LIMIT_EXCEEDED_ERROR","message":"Payload exceeds maximum configured size"}}},"exampleType":"examples"}},"exampleType":"examples"},"734d92a0-30af-4f1e-968e-0b74a2b9c4c7":{"description":"Internal server error","headers":{"x-fabric-request-id":{"schema":{"type":"string"},"required":false,"example":"263e731c-45c8-11ed-b878-0242ac120002","description":"Unique request ID"}},"content":{"application/json":{"schema":{"type":"object","description":"The details of the error.","properties":{"message":{"type":"string","description":"A placeholder error message for all the 4xx, 5xx errors","example":"Request is invalid","uniqueKey":"message","typeLabel":"string"},"type":{"type":"string","description":"A placeholder error type for all the 4xx, 5xx errors","example":"Bad request","uniqueKey":"type","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type.","example":"CLIENT_ERROR","uniqueKey":"errors.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","description":"The error message corresponding to the `type`.","example":"Invalid request. Unable to find/create product","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"SERVER_ERROR","message":"Internal Server Error"},"examples":{"Example":{"title":"Example","value":{"type":"SERVER_ERROR","message":"Internal Server Error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"09124e2c-8536-4b2d-b6cf-04cc3ae9b3cc":{"authorization":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the [Making your first API request](/v3/api-reference/getting-started/getting-started-with-fabric-apis#procedure) section.","scopes":[]}}},"servers":{"1031a83b-c45a-4788-983b-6fca55ea06a5":{"url":"https://api.fabric.inc/v3","description":"Production URL"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the [Making your first API request](/v3/api-reference/getting-started/getting-started-with-fabric-apis#procedure) section.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"This is the authorization token used to authenticate the request. You must pass the access token generated from the system app. For more information, see the [Making your first API request](/v3/api-reference/getting-started/getting-started-with-fabric-apis#procedure) section.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"authorization","name":"Authorization"}],"title":"authorization"}]},"originalFileLocation":"openapi/catalog-connector/v3/cc.openapi.yaml"},"subdomain":"fabric-demo","siteName":"Fabric","title":"Find products - Fabric","navMaps":{"firstHrefInVersion":{"Product Agent":{"href":"/home","matchLevel":4},"v3":{"href":"/v3/product-catalog/api-reference/catalog-connector/operations/search","matchLevel":0},"v2":{"href":"/v2/home","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-01-22T21:06:41.974Z","originalFileLocation":"v3/product-catalog/api-reference/catalog-connector/operations/search.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more. - Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Fabric\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Find products - Fabric\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more. - Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Fabric\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://fabric-demo.mintlify.site/_mintlify/api/og/v2?division=Operations\u0026amp;title=Find+products\u0026amp;description=Use+this+endpoint+to+search+for+products+based+on+names%2C+IDs%2C+SKUs%2C+image+URLs%2C+and+more.+By+specifying+the+appropriate+query+parameters%2C+you+can+exclude+one+or\u0026amp;theme=578f3bc8f816b5181d05040f\u0026amp;signature=684b04fccc5f90da285a5d55afe6efc5f8cc36cf1a63eeee7da1b0106a54ee3e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Find products - Fabric\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more. - Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://fabric-demo.mintlify.site/_mintlify/api/og/v2?division=Operations\u0026amp;title=Find+products\u0026amp;description=Use+this+endpoint+to+search+for+products+based+on+names%2C+IDs%2C+SKUs%2C+image+URLs%2C+and+more.+By+specifying+the+appropriate+query+parameters%2C+you+can+exclude+one+or\u0026amp;theme=578f3bc8f816b5181d05040f\u0026amp;signature=684b04fccc5f90da285a5d55afe6efc5f8cc36cf1a63eeee7da1b0106a54ee3e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/fabric-demo/4aXl3Y2Jab1lmXrs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Fabric\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff2ec1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v3/product-catalog/api-reference/catalog-connector/operations/search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developer.fabric.inc/#organization\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/fabric-demo/OzlZxX-hOwze1Aen/logo/darkneon.png?fit=max\u0026auto=format\u0026n=OzlZxX-hOwze1Aen\u0026q=85\u0026s=332d2284d5f41dc42f5b9e0bcd473872\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developer.fabric.inc#website\",\"name\":\"Fabric\",\"url\":\"https://developer.fabric.inc\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search#webpage\",\"url\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search\",\"name\":\"Find products\",\"description\":\"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more. - Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.\",\"dateModified\":\"2026-01-22T21:06:41.974Z\",\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"},\"breadcrumb\":{\"@id\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Catalog Connector API\",\"item\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/files/retrieve-import-template\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Find products\",\"item\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search#apireference\",\"headline\":\"Find products\",\"name\":\"Find products\",\"description\":\"Use this endpoint to search for products based on names, IDs, SKUs, image URLs, and more. By specifying the appropriate query parameters, you can exclude one or more types of data, such as collections, categories, variants, attributes, and products within a bundle. - Use the CONTAINS search operation to search for products based on keywords of SKU, name, and more. - Use the IN search operation to search for products based on one or more values, such as IDs, names, SKUs, image URLs, attributes, and types. - Use the less than or equals to, LTE, greater than or equals to, GTE, less than, LT, greater than, GT and equals EQ operations to search for date-specific values, such as time of creation or modification.\",\"url\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search\",\"mainEntityOfPage\":{\"@id\":\"https://developer.fabric.inc/v3/product-catalog/api-reference/catalog-connector/operations/search#webpage\"},\"dateModified\":\"2026-01-22T21:06:41.974Z\",\"publisher\":{\"@id\":\"https://developer.fabric.inc/#organization\"},\"isPartOf\":{\"@id\":\"https://developer.fabric.inc#website\"}}]}\u003c/script>","agentPointerHref":"/v3/product-catalog/api-reference/catalog-connector/operations/search.md","siteName":"Fabric","nav":{"global":null,"versions":[{"version":"Product Agent","pages":[{"title":"Product Agent","href":"/home"}]},{"version":"v3","tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/v3/home"}]},{"tab":"Getting Started","pages":[{"title":"Getting Started","href":"/v3/getting-started/overview"}]},{"tab":"Orders \u0026 Inventory","pages":[{"title":"Orders \u0026 Inventory","href":"/v3/orders-and-inventory/homepage"}]},{"tab":"Product Catalog","groups":[{"group":"Product Catalog","pages":[{"title":"Getting Started","href":"/v3/product-catalog/getting-started"},{"title":"Data Ingestion","href":"/v3/product-catalog/data-ingestion"},{"group":"Use Cases","pages":[{"title":"Centralize Product Data into a Single Source of Truth","href":"/v3/product-catalog/use-cases/centralize-product-data"},{"title":"Enrich Product Data for Optimized Sales Channel Performance","href":"/v3/product-catalog/use-cases/enrich-product-data"},{"title":"Merchandising Products through Automated Collections","href":"/v3/product-catalog/use-cases/merchandise-products"},{"title":"Distribute Product Data to Channels and Systems","href":"/v3/product-catalog/use-cases/distribute-product-data"}]}]},{"group":"Product Catalog User Guides","pages":[{"title":"Overview","href":"/v3/product-catalog/user-guides/product-catalog/overview"},{"group":"List","pages":[{"group":"Items","pages":[{"title":"Items Overview","href":"/v3/product-catalog/user-guides/product-catalog/list/items/items"},{"title":"Adding an Item","href":"/v3/product-catalog/user-guides/product-catalog/list/items/adding-an-item"},{"title":"Importing Items","href":"/v3/product-catalog/user-guides/product-catalog/list/items/importing-items"},{"title":"Bulk Operations for Items","href":"/v3/product-catalog/user-guides/product-catalog/list/items/bulk-operations-items"},{"title":"Editing an Item","href":"/v3/product-catalog/user-guides/product-catalog/list/items/editing-an-item"},{"title":"Adding Item Variants","href":"/v3/product-catalog/user-guides/product-catalog/list/items/adding-item-variants"},{"title":"Searching, Filtering, and Sorting Items","href":"/v3/product-catalog/user-guides/product-catalog/list/items/searching-filtering-sorting-items"}]},{"group":"Bundles","pages":[{"title":"Bundles Overview","href":"/v3/product-catalog/user-guides/product-catalog/list/bundles/bundles"},{"title":"Adding a Bundle","href":"/v3/product-catalog/user-guides/product-catalog/list/bundles/adding-a-bundle"},{"title":"Importing Bundles","href":"/v3/product-catalog/user-guides/product-catalog/list/bundles/importing-bundles"},{"title":"Editing a Bundle","href":"/v3/product-catalog/user-guides/product-catalog/list/bundles/editing-a-bundle"},{"title":"Searching, Filtering, and Sorting Bundles","href":"/v3/product-catalog/user-guides/product-catalog/list/bundles/searching-filtering-sorting-bundles"}]}]},{"group":"Attributes","pages":[{"group":"Product Attributes","pages":[{"title":"Product Attributes Overview","href":"/v3/product-catalog/user-guides/product-catalog/attributes/product-attributes-overview"},{"title":"Adding a Text Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-text-attribute"},{"title":"Adding a Number Only Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-number-only-attribute"},{"title":"Adding a Date Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-date-attribute"},{"title":"Adding a Boolean Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-boolean-attribute"},{"title":"Adding a List of Values Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-list-of-values-attribute"},{"title":"Adding a Serial Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-serial-attribute"},{"title":"Importing Product Attributes","href":"/v3/product-catalog/user-guides/product-catalog/attributes/importing-product-attributes"},{"title":"Managing Product Attributes","href":"/v3/product-catalog/user-guides/product-catalog/attributes/managing-product-attributes"},{"title":"Searching and Sorting Product Attributes","href":"/v3/product-catalog/user-guides/product-catalog/attributes/searching-and-sorting-product-attributes"}]},{"group":"Category Attributes","pages":[{"title":"Category Attributes Overview","href":"/v3/product-catalog/user-guides/product-catalog/attributes/category-attributes-overview"},{"title":"Adding a Number Only Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-number-only-attribute2"},{"title":"Adding a Text Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-text-attribute2"},{"title":"Adding a Date Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-date-attribute2"},{"title":"Adding a Boolean Attribute","href":"/v3/product-catalog/user-guides/product-catalog/attributes/adding-a-boolean-attribute2"},{"title":"Managing Category Attributes","href":"/v3/product-catalog/user-guides/product-catalog/attributes/managing-category-attributes"},{"title":"Searching and Sorting Category Attributes","href":"/v3/product-catalog/user-guides/product-catalog/attributes/searching-and-sorting-category-attributes"}]}]},{"group":"Categories","pages":[{"title":"Categories","sidebarTitle":"Overview","href":"/v3/product-catalog/user-guides/product-catalog/categories/overview"},{"title":"Adding a Category","href":"/v3/product-catalog/user-guides/product-catalog/categories/adding-a-category"},{"title":"Importing Categories","href":"/v3/product-catalog/user-guides/product-catalog/categories/importing-categories"},{"title":"Managing Categories","href":"/v3/product-catalog/user-guides/product-catalog/categories/managing-categories"}]},{"group":"Collections","pages":[{"title":"Collections","sidebarTitle":"Overview","href":"/v3/product-catalog/user-guides/product-catalog/collections/collections"},{"title":"Creating a Collection","href":"/v3/product-catalog/user-guides/product-catalog/collections/creating-a-collection"},{"title":"Importing Collections","sidebarTitle":"Importing Collections","href":"/v3/product-catalog/user-guides/product-catalog/collections/importing-collections"},{"title":"Managing Collections","href":"/v3/product-catalog/user-guides/product-catalog/collections/managing-collections"},{"title":"Adding Category Attributes to a Collection","href":"/v3/product-catalog/user-guides/product-catalog/collections/adding-category-attributes"}]},{"group":"Background Jobs","pages":[{"title":"Background Jobs","sidebarTitle":"Overview","href":"/v3/product-catalog/user-guides/product-catalog/background-jobs/background-jobs"},{"title":"Viewing Background Jobs History","href":"/v3/product-catalog/user-guides/product-catalog/background-jobs/viewing-background-jobs-history"},{"title":"Managing Background Jobs","href":"/v3/product-catalog/user-guides/product-catalog/background-jobs/managing-background-jobs"}]},{"group":"Settings","pages":[{"title":"Settings","sidebarTitle":"Overview","href":"/v3/product-catalog/user-guides/product-catalog/settings/settings"},{"title":"Attribute Groups Overview","href":"/v3/product-catalog/user-guides/product-catalog/settings/attribute-groups-overview"},{"title":"Creating Attribute Groups","href":"/v3/product-catalog/user-guides/product-catalog/settings/creating-attribute-groups"},{"title":"Attribute Mapping Overview","href":"/v3/product-catalog/user-guides/product-catalog/settings/attribute-mapping-overview"},{"title":"Mapping Attributes","href":"/v3/product-catalog/user-guides/product-catalog/settings/how-to-map-attributes"}]}]},{"group":"Product Catalog API","pages":[{"title":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/overview"},{"title":"API Authentication and Data Sync","sidebarTitle":"API Authentication and Data Sync","href":"/v3/product-catalog/api-reference/product-catalog/api-authentication-data-sync"},{"group":"Attributes \u0026 Attribute Mapping","pages":[{"title":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/attributes/overview"},{"group":"Attributes","pages":[{"openapi":"attribute.openapi post /product-attributes","title":"Create an Attribute","href":"/v3/product-catalog/api-reference/product-catalog/attributes/create-attribute"},{"openapi":"attribute.openapi put /product-attributes/{id}","title":"Update Single Attribute","href":"/v3/product-catalog/api-reference/product-catalog/attributes/update-single-attribute"},{"openapi":"attribute.openapi delete /product-attributes/{id}","title":"Delete Single Attribute","href":"/v3/product-catalog/api-reference/product-catalog/attributes/delete-single-attribute"},{"openapi":"attribute.openapi get /product-attributes/{id}","title":"Get Single Attribute","href":"/v3/product-catalog/api-reference/product-catalog/attributes/get-single-attribute"},{"openapi":"attribute.openapi get /product-attributes","title":"Get Attributes","href":"/v3/product-catalog/api-reference/product-catalog/attributes/get-attributes"},{"openapi":"attribute.openapi post /product-attributes/search","title":"Find Attributes","href":"/v3/product-catalog/api-reference/product-catalog/attributes/find-attributes"}]},{"group":"Mapping","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/attribute-mapping/overview"},{"openapi":"attribute.openapi get /product-attribute-mappings","title":"Get Attribute Mapping","href":"/v3/product-catalog/api-reference/product-catalog/attribute-mapping/get-attribute-mapping"}]},{"group":"Attribute Groups","pages":[{"title":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/overview"},{"openapi":"attribute.openapi post /product-attribute-groups","title":"Create Product Attribute Group","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/create-product-attribute-group"},{"openapi":"attribute.openapi put /product-attribute-groups/{id}","title":"Update Attribute Group","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/update-attribute-group"},{"openapi":"attribute.openapi delete /product-attribute-groups/{id}","title":"Delete Attribute Group","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/delete-attribute-group"},{"openapi":"attribute.openapi get /product-attribute-groups/{id}","title":"Get Single Attribute Group","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/get-single-attribute-group"},{"openapi":"attribute.openapi get /product-attribute-groups","title":"Get All Product Attribute Groups","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/get-all-product-attribute-groups"},{"openapi":"attribute.openapi post /product-attribute-groups/search","title":"Find Attribute Groups","href":"/v3/product-catalog/api-reference/product-catalog/attribute-groups/find-attribute-groups"}]}]},{"group":"Categories","pages":[{"title":"Categories","sidebarTitle":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/categories/overview"},{"group":"Create","pages":[{"openapi":"category.openapi post /categories","title":"Create Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/create-category"},{"openapi":"category.openapi post /categories/batch","title":"Create Multiple Categories","href":"/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/create-multiple-categories"}]},{"group":"Update","pages":[{"openapi":"category.openapi put /categories/{id}","title":"Update Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/update-category"},{"openapi":"category.openapi patch /categories/{id}","title":"Partially Update Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/partially-update-category"},{"openapi":"category.openapi put /categories","title":"Update Multiple Categories","href":"/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/update-multiple-categories"}]},{"group":"Delete","pages":[{"openapi":"category.openapi delete /categories/{id}","title":"Delete Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/delete-category"}]},{"group":"Get","pages":[{"openapi":"category.openapi get /categories/{id}","title":"Get a Single Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/get-a-single-category"},{"openapi":"category.openapi get /categories/{id}/products","title":"Get Products by Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/get-products-by-category"},{"openapi":"category.openapi get /categories/{id}/attribute-groups","title":"Get Attribute Groups of a Category","href":"/v3/product-catalog/api-reference/product-catalog/categories/get-attribute-groups-of-a-category"},{"openapi":"category.openapi get /categories-path","title":"Get Navigation Path for Categories","href":"/v3/product-catalog/api-reference/product-catalog/categories/get-navigation-path-for-categories"},{"openapi":"category.openapi post /categories/search","title":"Find Categories","href":"/v3/product-catalog/api-reference/product-catalog/categories/find-categories"}]}]},{"group":"Products","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/products-api"},{"group":"Create","pages":[{"openapi":"product.openapi post /products","title":"Add Product","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-product"},{"openapi":"product.openapi post /products/batch","title":"Add Products","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/add-multiple-products"}]},{"group":"Update","pages":[{"openapi":"product.openapi put /products/{id}","title":"Update Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/update-product"},{"openapi":"product.openapi put /products/sku","title":"Update Product SKUs","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/update-product-skus"},{"sidebarTitle":"Update Multiple Products","openapi":"product.openapi put /products","title":"Update Multiple Products","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/update-products"},{"openapi":"product.openapi patch /products/sku/{sku}/attributes","title":"Partially Update Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/partially-update-product-by-sku"}]},{"group":"Delete","pages":[{"openapi":"product.openapi delete /products/{id}","title":"Delete Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/delete-product-by-id"},{"openapi":"product.openapi delete /products/sku/{sku}","title":"Delete Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/delete-product-by-sku"},{"openapi":"product.openapi delete /products","title":"Delete Multiple Products","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/delete-products"}]},{"group":"Get","pages":[{"openapi":"product.openapi get /products/{id}","title":"Get Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-product-by-id"},{"openapi":"product.openapi get /products/sku/{sku}","title":"Get Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-product-by-sku"},{"openapi":"product.openapi get /products/sku","title":"Get Products by SKUs","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-products-by-skus"},{"openapi":"product.openapi post /products/search","title":"Find Products","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/find-products"},{"openapi":"product.openapi get /products","title":"Get Product List","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/get-products-list"}]},{"group":"Update Product Attributes","pages":[{"openapi":"product.openapi put /products/{id}/attributes","title":"Update Product Attributes by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/update-product-attributes-by-id"},{"openapi":"product.openapi put /products/sku/{sku}/attributes","title":"Update Product Attributes by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/update-product-attributes-by-sku"},{"openapi":"product.openapi patch /products/{id}/attributes","title":"Partially Update Product Attributes by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/partially-update-product-attributes-by-id"}]},{"group":"Add Variants","pages":[{"openapi":"product.openapi post /products/{id}/variants/actions/attach","title":"Add Variants to Products by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-variants-to-products-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/variants/actions/attach","title":"Add Variants to Products by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/add-variants-to-products-by-sku"}]},{"group":"Remove Variants","pages":[{"openapi":"product.openapi post /products/{id}/variants/actions/detach","title":"Remove Product Variants by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/remove-variants-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/variants/actions/detach","title":"Remove Product Variants by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/remove-product-variants-by-sku"}]},{"group":"Get Variants","pages":[{"openapi":"product.openapi get /products/{id}/variants","title":"Get Product Variants by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-product-variants-by-id"},{"openapi":"product.openapi get /products/sku/{sku}/variants","title":"Get Product Variants by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-product-variants-by-sku"}]},{"group":"Assign Bundle Items","pages":[{"openapi":"product.openapi post /products/{id}/bundles/actions/attach","title":"Add Products to Bundle by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/add-products-to-bundle-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/bundles/actions/attach","title":"Add Products to Bundle by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/add-products-to-bundle-by-sku"}]},{"group":"Remove Bundle Items","pages":[{"openapi":"product.openapi post /products/{id}/bundles/actions/detach","title":"Remove Products from a Bundle by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/remove-products-from-a-bundle-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/bundles/actions/detach","title":"Remove Products from a Bundle by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/remove-products-from-a-bundle-by-sku"}]},{"group":"Get Products in a Bundle","pages":[{"openapi":"product.openapi get /products/{id}/bundles","title":"Get Products in a Bundle by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/get-products-in-a-bundle-by-id"},{"openapi":"product.openapi get /products/sku/{sku}/bundles","title":"Get Products in a Bundle by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/get-products-in-a-bundle-by-sku"}]},{"group":"Change Category Assignment","pages":[{"openapi":"product.openapi post /products/{id}/actions/change-category","title":"Change Product Category","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/change-product-category"},{"openapi":"product.openapi post /products/actions/change-category","title":"Reassign Products to a Different Category Synchronously","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/reassign-products-to-a-different-category-synchronously"},{"openapi":"product.openapi post /products/actions/filter-change-category","title":"Bulk Reassign Products to a Different Category Using Filter Conditions","href":"/v3/product-catalog/api-reference/product-catalog/general-product-operations/bulk-reassign-products-to-a-different-category-using-filter-conditions"}]},{"group":"Publish","pages":[{"openapi":"product.openapi post /products/{id}/actions/publish","title":"Publish Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/publish-product-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/actions/publish","title":"Publish Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/publish-product-by-sku"}]},{"group":"Unpublish","pages":[{"openapi":"product.openapi post /products/{id}/actions/unpublish","title":"Unpublish Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-id/unpublish-product-by-id"},{"openapi":"product.openapi post /products/sku/{sku}/actions/unpublish","title":"Unpublish Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/product-operations-by-sku/unpublish-product-by-sku"}]}]},{"group":"Collections","pages":[{"title":"Collections","sidebarTitle":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/collections/overview"},{"group":"Create","pages":[{"openapi":"category.openapi post /collections","title":"Create Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/create-collection"},{"openapi":"category.openapi post /collections/batch","title":"Create Multiple Collections","href":"/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/create-multiple-collections"}]},{"group":"Update","pages":[{"openapi":"category.openapi put /collections/{id}","title":"Update Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/update-collection"},{"openapi":"category.openapi patch /collections/{id}","title":"Partially Update Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/partially-update-collection"},{"openapi":"category.openapi put /collections","title":"Update Collections Up to 25","href":"/v3/product-catalog/api-reference/product-catalog/bulk-action-for-categories-and-collections/update-collections-up-to-25"},{"openapi":"category.openapi post /collections/actions/copy-category","title":"Copy Category to Collections","href":"/v3/product-catalog/api-reference/product-catalog/collections/copy-category-to-collections"},{"openapi":"category.openapi put /collections/{id}/children","title":"Update Children of Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/update-children-of-collection"}]},{"group":"Delete","pages":[{"openapi":"category.openapi delete /collections/{id}","title":"Delete Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/delete-collection"}]},{"group":"Get","pages":[{"openapi":"category.openapi get /collections/{id}","title":"Get a Single Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/get-a-single-collection"},{"openapi":"category.openapi get /collections/{id}/products","title":"Get Products Under Collection","href":"/v3/product-catalog/api-reference/product-catalog/collections/get-products-under-collection"},{"openapi":"category.openapi get /collections-path","title":"Get Navigation Path for Collections","href":"/v3/product-catalog/api-reference/product-catalog/collections/get-navigation-path-for-collections"},{"openapi":"category.openapi post /collections/search","title":"Find Collections","href":"/v3/product-catalog/api-reference/product-catalog/collections/find-collections"}]},{"title":"Syncing Collections Using Delta Files","sidebarTitle":"Syncing Collections Using Delta Files","href":"/v3/product-catalog/api-reference/product-catalog/collections/syncing-collections-using-delta-files"}]},{"group":"Background Jobs","pages":[{"group":"Get List of Jobs","pages":[{"openapi":"files-jobs.openapi post /product-jobs/search","title":"Search Jobs","href":"/v3/product-catalog/api-reference/product-catalog/jobs/search-background-jobs"},{"openapi":"files-jobs.openapi get /product-jobs","title":"Get Jobs Related to Products","href":"/v3/product-catalog/api-reference/product-catalog/jobs/get-jobs-related-to-products"}]},{"group":"Get List of Files","pages":[{"openapi":"files-jobs.openapi get /product-files","title":"Get Available Files","href":"/v3/product-catalog/api-reference/product-catalog/files/get-files-available-for-a-merchant"}]},{"group":"Download Files","pages":[{"openapi":"files-jobs.openapi get /product-files/actions/download","title":"Download a File by ID","href":"/v3/product-catalog/api-reference/product-catalog/files/download-a-file-by-id"},{"openapi":"files-jobs.openapi post /product-jobs/actions/export","title":"Initiate Job to Export Items and Variants","href":"/v3/product-catalog/api-reference/product-catalog/jobs/initiate-job-to-export-items-and-variants"}]},{"openapi":"files-jobs.openapi post /product-jobs/{id}/actions/cancel","title":"Cancel Background Jobs Using Job IDs","href":"/v3/product-catalog/api-reference/product-catalog/jobs/cancel-background-jobs"}]},{"group":"Bulk Import \u0026 Export","pages":[{"title":"Overview","sidebarTitle":"Overview","href":"/v3/product-catalog/api-reference/product-catalog/products---files-and-jobs-api"},{"openapi":"files-jobs.openapi post /product-templates/actions/generate","title":"Generate Import Template","href":"/v3/product-catalog/api-reference/product-catalog/files/generate-the-import-template"},{"openapi":"files-jobs.openapi post /product-files","title":"Create File Object and Get File Upload Location","href":"/v3/product-catalog/api-reference/product-catalog/files/create-file-object-and-get-file-upload-location"},{"openapi":"files-jobs.openapi post /product-jobs/actions/filter-export","title":"Initiate Job to Export Items and Variants","href":"/v3/product-catalog/api-reference/product-catalog/jobs/initiate-job-to-export-items-and-variants-1"},{"openapi":"files-jobs.openapi get /product-files/actions/download","title":"Download a File by ID","href":"/v3/product-catalog/api-reference/product-catalog/files/download-a-file-by-id"}]},{"group":"Published Products","pages":[{"title":"Product Catalog - Published Product Catalog API","href":"/v3/product-catalog/api-reference/product-catalog/products---published-products-api"},{"group":"Get Products","pages":[{"openapi":"published-product.openapi get /published-products/ids","title":"Get Multiple Published Products by IDs","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-products-by-ids"},{"openapi":"published-product.openapi get /published-products/{id}","title":"Get Published Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-published-product-by-id"},{"openapi":"published-product.openapi get /published-products/skus/{sku}","title":"Get Published Product by SKU","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-published-product-by-sku"},{"openapi":"published-product.openapi get /published-products/skus","title":"Get Multiple Published Products by SKUs","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-published-products-by-skus"}]},{"group":"Get Bundles","pages":[{"openapi":"published-product.openapi get /published-products/{id}/bundle-products","title":"Get Products in a Bundle by ID","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-products-in-a-bundle-by-id"},{"openapi":"published-product.openapi get /published-products/skus/{sku}/bundle-products","title":"Get Bundle Products by Bundle SKU","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-bundle-products-by-bundle-sku"}]},{"group":"Get Variants","pages":[{"openapi":"published-product.openapi get /published-products/{id}/variants","title":"Get Variants of Published Product by ID","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-variants-of-published-product-by-id"},{"openapi":"published-product.openapi get /published-products/skus/{sku}/variants","title":"Get Variants of Published Products by SKU","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-variants-of-published-products-by-sku"}]},{"group":"Get Collections Assigned to a Product","pages":[{"openapi":"published-product.openapi get /published-products/{id}/collections","title":"Get Collections by Product ID","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-id/get-collections-by-product-id"},{"openapi":"published-product.openapi get /published-products/skus/{sku}/collections","title":"Get Collections by Product SKU","href":"/v3/product-catalog/api-reference/product-catalog/published-products-by-sku/get-collections-by-product-sku"}]}]}]},{"group":"Developer Guide","pages":[{"title":"Introduction","href":"/v3/product-catalog/api-reference/product-catalog/developer-guide/introduction"},{"title":"Configuring Product Catalog","href":"/v3/product-catalog/api-reference/product-catalog/developer-guide/configuring-product-catalog"},{"title":"Examples","href":"/v3/product-catalog/api-reference/product-catalog/developer-guide/examples"}]},{"group":"Catalog Connector User Guides","pages":[{"title":"Catalog Connector Overview","sidebarTitle":"Overview","href":"/v3/product-catalog/user-guides/catalog-connector/overview"},{"group":"Items","pages":[{"title":"Items Overview","href":"/v3/product-catalog/user-guides/catalog-connector/items-overview"},{"title":"Importing Items","href":"/v3/product-catalog/user-guides/catalog-connector/importing-items"},{"title":"Viewing Item Details","href":"/v3/product-catalog/user-guides/catalog-connector/viewing-item-attributes-variants-channels"},{"title":"Searching, Filtering, and Sorting Items","href":"/v3/product-catalog/user-guides/catalog-connector/searching-filtering-sorting-items"},{"title":"Viewing Item Import History","href":"/v3/product-catalog/user-guides/catalog-connector/viewing-item-import-history"}]},{"group":"Bundles","pages":[{"title":"Bundles Overview","href":"/v3/product-catalog/user-guides/catalog-connector/bundles-overview"},{"title":"Importing Bundles","href":"/v3/product-catalog/user-guides/catalog-connector/importing-bundles"},{"title":"Viewing Bundle Details","href":"/v3/product-catalog/user-guides/catalog-connector/viewing-bundle-attributes-variants-channels"},{"title":"Searching, Filtering, and Sorting Bundles","href":"/v3/product-catalog/user-guides/catalog-connector/searching-filtering-sorting-bundles"},{"title":"Viewing Bundle Import History","href":"/v3/product-catalog/user-guides/catalog-connector/viewing-bundle-import-history"}]}]},{"group":"Catalog Connector API","pages":[{"group":"Files","pages":[{"openapi":"cc.openapi post /catalog-connector-templates/actions/generate","title":"Retrieve an import template","href":"/v3/product-catalog/api-reference/catalog-connector/files/retrieve-import-template"},{"openapi":"cc.openapi post /catalog-connector-files","title":"Create a file object and retrieve the file upload URL","href":"/v3/product-catalog/api-reference/catalog-connector/files/create-file"},{"openapi":"cc.openapi get /catalog-connector-files","title":"Retrieve import and export history","href":"/v3/product-catalog/api-reference/catalog-connector/files/get-file"},{"openapi":"cc.openapi get /catalog-connector-files/actions/download","title":"Download a file by ID","href":"/v3/product-catalog/api-reference/catalog-connector/files/download-file"}]},{"group":"Jobs","pages":[{"openapi":"cc.openapi post /catalog-connector-jobs/actions/export","title":"Export products","href":"/v3/product-catalog/api-reference/catalog-connector/jobs/export"},{"openapi":"cc.openapi get /catalog-connector-jobs","title":"Retrieve jobs","description":"Use this endpoint to retrieve a paginated list of import and export jobs related to Catalog Connector.\nThe following constraints apply when using the query parameters:\n - The query parameter job `ids` can't be combined with any other query parameters.\n - The query parameter `inputFileIds` can only be combined with the query parameter `lastJobOnly`. \n - Pagination isn't supported when `ids` or `inputFileIds` is specified.\n","href":"/v3/product-catalog/api-reference/catalog-connector/jobs/retrieve-jobs"}]},{"group":"Operations","pages":[{"openapi":"cc.openapi post /catalog-connector/products/search","title":"Find products","href":"/v3/product-catalog/api-reference/catalog-connector/operations/search"},{"group":"Operations with SKU","pages":[{"openapi":"cc.openapi get /catalog-connector/products/skus/{skuId}","title":"Retrieve a product by SKU","description":"Use this endpoint to retrieve a single product by its SKU. You must specify the query parameters `sku` and `locale` to corresponding to the product. Optionally, you can set the following query parameters to `true` to refine the search results:\n - `excludeBundleProducts`: Exclude bundled products from the response.\n - `excludeCollections`: Exclude collections from the response.\n - `excludeCategories`: Exclude categories from the response.\n - `excludeAttributes`: Exclude attributes from the response. \n - `excludeVariants`: Exclude variants from the response. \n\nIf you don't have the product SKU, use one of the endpoints to retrieve the product: \n - [Retrieve a product by product ID](/v3/api-reference/catalog-connector/operations/product-operations/retrieve-by-product). \n - [Retrieve a product by item ID](/v3/api-reference/catalog-connector/operations/item-operations/retrieve-by-item).\n","href":"/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/retrieve-with-sku"},{"openapi":"cc.openapi put /catalog-connector/products/skus/{skuId}","title":"Update a product by SKU","href":"/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/update-with-sku"},{"openapi":"cc.openapi delete /catalog-connector/products/skus/{skuId}","title":"Delete a product by SKU","href":"/v3/product-catalog/api-reference/catalog-connector/operations/sku-operations/delete-with-sku"}]},{"group":"Operations with Product ID","pages":[{"openapi":"cc.openapi post /catalog-connector/products","title":"Add a product","href":"/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/add-product"},{"openapi":"cc.openapi get /catalog-connector/products/{productId}","title":"Retrieve a product by product ID","href":"/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/retrieve-by-product"},{"openapi":"cc.openapi put /catalog-connector/products/{productId}","title":"Update a product by product ID","href":"/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/update-by-product"},{"openapi":"cc.openapi delete /catalog-connector/products/{productId}","title":"Delete a product by product ID","href":"/v3/product-catalog/api-reference/catalog-connector/operations/product-operations/delete-by-product"}]},{"group":"Operations with Item ID","pages":[{"openapi":"cc.openapi get /catalog-connector/products/itemIds/{itemId}","title":"Retrieve a product or a variant by Item ID","href":"/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/retrieve-by-item"},{"openapi":"cc.openapi put /catalog-connector/products/itemIds/{itemId}","title":"Update a product by the Item ID.","href":"/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/update-by-item"},{"openapi":"cc.openapi delete /catalog-connector/products/itemIds/{itemId}","title":"Delete a product by Item ID","href":"/v3/product-catalog/api-reference/catalog-connector/operations/item-operations/delete-by-item"}]}]}]}]},{"tab":"Offers","pages":[{"title":"Offers","href":"/v3/offers/user-guides/offers/overview"}]},{"tab":"Dropship","pages":[{"title":"Dropship","href":"/v3/dropship/homepage"}]},{"tab":"Cart \u0026 Checkout","pages":[{"title":"Cart \u0026 Checkout","href":"/v3/cart-and-checkout/api-reference/carts-v3/overview"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/v3/integrations/overview"}]},{"tab":"Platform","pages":[{"title":"Platform","href":"/v3/platform/home/alerts/alerts-overview"}]},{"tab":"Store Fulfillment","pages":[{"title":"Store Fulfillment","href":"/v3/store-fulfillment/updating-store-location"}]},{"tab":"Release Notes","pages":[{"title":"Release Notes","href":"/v3/release-notes/july2025/release-summary"}]}]},{"version":"v2","pages":[{"title":"v2","href":"/v2/home"}]}]},"basePath":"","title":"Find products - Fabric","buildId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","deploymentId":"dpl_5joLUXmnJgwqjrHAS4dxZrQTdxgh","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DPDWPCdE.js","utils-DyjUHyLo.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BWYE1cdS.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-COAzxpEw.js","snippetPresets-DNiD_S52.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-CjwVt80x.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-ByHQMk7z.js","shallow-CaZuw1AO.js","getApiPlaygroundDisplay-DPVPOknm.js","CodeSnippet-B31CH-Mp.js","CodeSnippets-BxTYZWz6.js","Page-DDHbuAIY.js","getPastedJson-DhoAwiNO.js","icon-Dhq8z75J.js","MethodPill-DLXmKOwr.js","DuplicateIcon-jzdVwyRU.js","createIcon-eD0b3klN.js","DynamicMarkdown-BfddVCX7.js","SectionHeading-2pSCIo17.js","axios-vUo_bRtp.js","Markdown-DsWjhwJ4.js","clsx-B2t_mZQG.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CUljsAY7.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Cf70306N.js"]}