{ "openapi": "3.1.0", "info": { "title": "Catalogix API", "description": "\n
API documentation for Catalogix services.
\n**Base URL:** `https://api.catalogix.ai`
\nUse this base URL to access all API endpoints.\n\n# Introduction\nOur suite of headless APIs enable end to end management of your fashion store. If you have any questions, please do not hesitate to contact us at support@catalogix.ai\n\n# Getting Started\n\nIn Catalogix Headless Platform, your company or organization is treated as a Workspace. Within the workspace, a store is defined as a channel for selling your products. Stores can be an eCommerce website in a specific country, a mobile app, a printed catalog, a chatbot, a 3rd party marketplace, or even physical retail locations. \n\nOnce you share your store's product feed or product images with Catalogix via our Feed API or using a CSV/XML file, we process your catalog and enable our APIs and services for your store.\n\n# Authentication\n\n\n\nCatalogix's REST APIs use Bearer token authentication to authenticate and authorize calls. Follow the steps listed here to get started.\n\n

Step 1: Registering your store and getting your API token

\n\nCatalogix will register your store and provide you an API token. Please reach out to support@catalogix.ai to get started.\n\n \n
\n\n

Step 2: Calling an API

\nYou can call any API included in your subscription using the generated API token.\n\nPass the token in the Authorization header as follows:\n\nAuthorization: Bearer {token}\n\n

You can use the same token for all APIs.

\n\n# Errors\nCatalogix Platform uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.\n\n|Status Code | Description |\n|--|--|\n| `200` | **Success**: The request was successfully completed. |\n| `201` | **Created**: The request was a success and one or more resources have been created. |\n| `400` | **Bad request**: The request cannot be performed. Usually because of malformed parameter or missing parameter. |\n| `401` | **Unauthorized (Invalid AuthToken)**: Request was rejected because of invalid API Key |\n| `404` | **Resource Not Found**: The URL you\u02bcve sent is wrong. It\u02bcs possible that the resource you\u02bcve requested has been moved to another URL. |\n| `405` |**Method Not Found**: The HTTP method that the API is calling with is not supported for this API. |\n| `413` |**Payload too large**: The API accepts upto 100 data items at a time. |\n| `422` |**validation Error**: It failed validation. Please refer to the data format given in the description of each API |\n| `429` | **Too many requests**: Too many requests within a certain time frame. To know more about api call limits, click here. |\n| `500` | **Server error**: Catalogix Platform server encountered an error which prevents it from fulfilling the request. Although this rarely happens, we recommend you to contact us at support@catalogix.ai if you receive this error. |\n\nFor details about the structure and application-specific error-codes of a specific Catalogix service, consult the documentation dedicated to that service.\n\n# Product Information\n\n

What is a Product?

\n

A product is a uniquely identified item in a store catalog which can be sold to customers. A product typically contains information such as an identifier (eg: SKU, Style Code, GTIN), a title, a description, images, brand name, price, sale price, and other such attributes.

\n\n

Where can it be implemented?

\n

The APIs shown in the section below help you to create new products in the Catalogix platform, modify existing product information, and fetch product information which can be used in many ways such as populating the content of a Product Details Page.

\n", "contact": { "name": "Catalogix Support", "email": "support@catalogix.ai" }, "license": { "name": "Catalogix License" }, "version": "1.0.0" }, "servers": [ { "url": "https://api.catalogix.ai/v1", "description": "Catalogix APIs" } ], "paths": { "/products": { "post": { "tags": [ "Product APIs" ], "summary": "Create Product", "description": "Inserts new product data into the system.", "operationId": "insert_data_products_post", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "title": "Store Uuid" }, "example": "67762d4ce590324df813bd8c" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SkuDataModel" }, "title": "Data" } } } }, "responses": { "200": { "description": "Insert successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertDataResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "413": { "description": "Payload too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "Mapping profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request POST 'https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"product_code\": \"CI001\",\n \"parent_code\": \"SC001\",\n \"Product Name\": \"Blue shirts\",\n \"Department\": \"Men\",\n \"Category\": \"Dupatta\",\n \"Selling Price\": \"1000\",\n \"Currency\": \"INR\",\n \"Image URL 1\": \"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\",\n \"Image URL 2\": \"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\",\n \"Image URL 3\": \"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\",\n \"Image URL 4\": \"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\",\n \"Image URL 5\": \"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\",\n \"Image URL 6\": \"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\"\n }\n]'" }, { "lang": "Python", "label": "Python", "source": "import requests\nimport json\n\nurl = \"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\"\n\npayload = json.dumps([\n {\n \"product_code\": \"CI001\",\n \"parent_code\": \"SC001\",\n \"Product Name\": \"Blue shirts\",\n \"Department\": \"Men\",\n \"Category\": \"Dupatta\",\n \"Selling Price\": \"1000\",\n \"Currency\": \"INR\",\n \"Image URL 1\": \"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\",\n \"Image URL 2\": \"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\",\n \"Image URL 3\": \"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\",\n \"Image URL 4\": \"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\",\n \"Image URL 5\": \"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\",\n \"Image URL 6\": \"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\"\n }\n])\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "lang": "JavaScript", "label": "JavaScript", "source": "var myHeaders = new Headers();\nmyHeaders.append(\"Authorization\", \"Bearer YOUR_TOKEN\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"product_code\": \"CI001\",\n \"parent_code\": \"SC001\",\n \"Product Name\": \"Blue shirts\",\n \"Department\": \"Men\",\n \"Category\": \"Dupatta\",\n \"Selling Price\": \"1000\",\n \"Currency\": \"INR\",\n \"Image URL 1\": \"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\",\n \"Image URL 2\": \"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\",\n \"Image URL 3\": \"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\",\n \"Image URL 4\": \"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\",\n \"Image URL 5\": \"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\",\n \"Image URL 6\": \"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\"\n }\n]);\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "lang": "PHP", "label": "PHP", "source": " 'https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'POST',\n CURLOPT_POSTFIELDS =>'[\n {\n \"product_code\": \"CI001\",\n \"parent_code\": \"SC001\",\n \"Product Name\": \"Blue shirts\",\n \"Department\": \"Men\",\n \"Category\": \"Dupatta\",\n \"Selling Price\": \"1000\",\n \"Currency\": \"INR\",\n \"Image URL 1\": \"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\",\n \"Image URL 2\": \"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\",\n \"Image URL 3\": \"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\",\n \"Image URL 4\": \"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\",\n \"Image URL 5\": \"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\",\n \"Image URL 6\": \"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\"\n }\n]',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer YOUR_TOKEN',\n 'Content-Type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" }, { "lang": "Go", "label": "Go", "source": "package main\n\nimport (\n \"fmt\"\n \"strings\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\"\n method := \"POST\"\n\n payload := strings.NewReader(`[\n {\n \"product_code\": \"CI001\",\n \"parent_code\": \"SC001\",\n \"Product Name\": \"Blue shirts\",\n \"Department\": \"Men\",\n \"Category\": \"Dupatta\",\n \"Selling Price\": \"1000\",\n \"Currency\": \"INR\",\n \"Image URL 1\": \"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\",\n \"Image URL 2\": \"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\",\n \"Image URL 3\": \"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\",\n \"Image URL 4\": \"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\",\n \"Image URL 5\": \"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\",\n \"Image URL 6\": \"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\"\n }\n]`)\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, payload)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Authorization\", \"Bearer YOUR_TOKEN\")\n req.Header.Add(\"Content-Type\", \"application/json\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "lang": "Java", "label": "Java", "source": "Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.post(\"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\")\n .header(\"Authorization\", \"Bearer YOUR_TOKEN\")\n .header(\"Content-Type\", \"application/json\")\n .body(\"[\\n {\\n \\\"product_code\\\": \\\"CI001\\\",\\n \\\"parent_code\\\": \\\"SC001\\\",\\n \\\"Product Name\\\": \\\"Blue shirts\\\",\\n \\\"Department\\\": \\\"Men\\\",\\n \\\"Category\\\": \\\"Dupatta\\\",\\n \\\"Selling Price\\\": \\\"1000\\\",\\n \\\"Currency\\\": \\\"INR\\\",\\n \\\"Image URL 1\\\": \\\"https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a\\\",\\n \\\"Image URL 2\\\": \\\"https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57\\\",\\n \\\"Image URL 3\\\": \\\"https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6\\\",\\n \\\"Image URL 4\\\": \\\"https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa\\\",\\n \\\"Image URL 5\\\": \\\"https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a\\\",\\n \\\"Image URL 6\\\": \\\"https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1\\\"\\n }\\n]\")\n .asString();\n" } ] }, "put": { "tags": [ "Product APIs" ], "summary": "Update Product", "description": "Updates existing product data.", "operationId": "update_data_products_put", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "title": "Store Uuid" }, "example": "67762d4ce590324df813bd8c" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UpdateSkuDataModel" }, "title": "Data" } } } }, "responses": { "200": { "description": "Update successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "413": { "description": "Payload too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "Mapping profile not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request PUT 'https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\n {\n \"product_code\": \"CI001\",\n \"Category\": \"Shirts\",\n \"Department\": \"Men\",\n \"Status\": \"inactive\"\n }\n]'" }, { "lang": "Python", "label": "Python", "source": "import requests\nimport json\n\nurl = \"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\"\n\npayload = json.dumps([\n {\n \"product_code\": \"CI001\",\n \"Category\": \"Shirts\",\n \"Department\": \"Men\",\n \"Status\": \"inactive\"\n }\n])\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"PUT\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "lang": "JavaScript", "label": "JavaScript", "source": "var myHeaders = new Headers();\nmyHeaders.append(\"Authorization\", \"Bearer YOUR_TOKEN\");\nmyHeaders.append(\"Content-Type\", \"application/json\");\n\nvar raw = JSON.stringify([\n {\n \"product_code\": \"CI001\",\n \"Category\": \"Shirts\",\n \"Department\": \"Men\",\n \"Status\": \"inactive\"\n }\n]);\n\nvar requestOptions = {\n method: 'PUT',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "lang": "PHP", "label": "PHP", "source": " 'https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'PUT',\n CURLOPT_POSTFIELDS =>'[\n {\n \"product_code\": \"CI001\",\n \"Category\": \"Shirts\",\n \"Department\": \"Men\",\n \"Status\": \"inactive\"\n }\n]',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer YOUR_TOKEN',\n 'Content-Type: application/json'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" }, { "lang": "Go", "label": "Go", "source": "package main\n\nimport (\n \"fmt\"\n \"strings\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\"\n method := \"PUT\"\n\n payload := strings.NewReader(`[\n {\n \"product_code\": \"CI001\",\n \"Category\": \"Shirts\",\n \"Department\": \"Men\",\n \"Status\": \"inactive\"\n }\n]`)\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, payload)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Authorization\", \"Bearer YOUR_TOKEN\")\n req.Header.Add(\"Content-Type\", \"application/json\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "lang": "Java", "label": "Java", "source": "Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.put(\"https://api.catalogix.ai/v1/products?store_uuid=67762d4ce590324df813bd8c\")\n .header(\"Authorization\", \"Bearer YOUR_TOKEN\")\n .header(\"Content-Type\", \"application/json\")\n .body(\"[\\n {\\n \\\"product_code\\\": \\\"CI001\\\",\\n \\\"Category\\\": \\\"Shirts\\\",\\n \\\"Department\\\": \\\"Men\\\",\\n \\\"Status\\\": \\\"inactive\\\"\\n }\\n]\")\n .asString();\n" } ] }, "get": { "tags": [ "Product APIs" ], "summary": "Retrieve Product", "description": "Retrieves product data.", "operationId": "retrieve_product_data_products_get", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "title": "Store Uuid", "example": "67762d4ce590324df813bd8c" } }, { "name": "sku_codes", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of SKU Codes or Style codes based on selected type to be retrieved", "title": "Sku Codes", "example": "CI001" } }, { "name": "ontology", "in": "query", "required": false, "schema": { "type": "string", "example": "SMP" }, "description": "Ontology name for product taxonomy (e.g. SMP, amazon, brand). If not provided, auto-detected from store taxonomy settings." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0, "title": "Offset", "example": 0 } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "exclusiveMinimum": 0, "default": 100, "title": "Limit", "example": 100 } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "active", "new", "problem", "inactive", "draft", "under review" ] }, "description": "Filter by product status." }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "responses": { "200": { "description": "Data retrieval successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveDataResponse" }, "example": { "status": { "code": 0, "message": "success" }, "data": { "store_uuid": "67762d4ce590324df813bd8c", "products": [ { "CI001": { "Category": "shirts", "product_code": "CI001", "status": "active", "assets": { "images": [ "https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a", "https://assets-test.catalogix.ai/b9e0a674584b15df799a2d2a7bcb6f57", "https://assets-test.catalogix.ai/3d8f430ce3bc623e8037aac988a889c6", "https://assets-test.catalogix.ai/e263183310aa0093381bf48a6d8540aa", "https://assets-test.catalogix.ai/38d253f0fb7aad878ae270e2c612467a", "https://assets-test.catalogix.ai/5733be608a3f9303af5d7dd14621d2d1" ], "videos": [ "https://assets-test.catalogix.ai/cac950f7a787813a1d99fbb20e159ee2" ] } } } ] } } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "Data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request GET 'https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP' \\\n--header 'Authorization: Bearer YOUR_TOKEN'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP\"\n\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers)\n\nprint(response.text)\n" }, { "lang": "JavaScript", "label": "JavaScript", "source": "var myHeaders = new Headers();\nmyHeaders.append(\"Authorization\", \"Bearer YOUR_TOKEN\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "lang": "PHP", "label": "PHP", "source": " 'https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'GET',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer YOUR_TOKEN'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" }, { "lang": "Go", "label": "Go", "source": "package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP\"\n method := \"GET\"\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, nil)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Authorization\", \"Bearer YOUR_TOKEN\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "lang": "Java", "label": "Java", "source": "Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.get(\"https://api.catalogix.ai/v1/products?sku_codes=CI001&store_uuid=67762d4ce590324df813bd8c&ontology=SMP\")\n .header(\"Authorization\", \"Bearer YOUR_TOKEN\")\n .asString();\n" } ] }, "delete": { "tags": [ "Product APIs" ], "summary": "Delete Product", "description": "Delete product data", "operationId": "delete_data_products_delete_delete", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "title": "Store Uuid" }, "example": "67762d4ce590324df813bd8c" }, { "name": "sku_codes", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "description": "List of SKU Codes needs to be deleted", "title": "Sku Codes" } }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "responses": { "200": { "description": "Data deletion successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDataResponse" }, "example": { "status": { "code": 0, "message": "success" } } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "Data not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request DELETE 'https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c' \\\n--header 'Authorization: Bearer YOUR_TOKEN'" }, { "lang": "Python", "label": "Python", "source": "import requests\n\nurl = \"https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c\"\n\npayload={}\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "lang": "JavaScript", "label": "JavaScript", "source": "var myHeaders = new Headers();\nmyHeaders.append(\"Authorization\", \"Bearer YOUR_TOKEN\");\n\nvar requestOptions = {\n method: 'DELETE',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "lang": "PHP", "label": "PHP", "source": " 'https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c',\n CURLOPT_RETURNTRANSFER => true,\n CURLOPT_ENCODING => '',\n CURLOPT_MAXREDIRS => 10,\n CURLOPT_TIMEOUT => 0,\n CURLOPT_FOLLOWLOCATION => true,\n CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n CURLOPT_CUSTOMREQUEST => 'DELETE',\n CURLOPT_HTTPHEADER => array(\n 'Authorization: Bearer YOUR_TOKEN'\n ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n" }, { "lang": "Go", "label": "Go", "source": "package main\n\nimport (\n \"fmt\"\n \"net/http\"\n \"io/ioutil\"\n)\n\nfunc main() {\n\n url := \"https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c\"\n method := \"DELETE\"\n\n client := &http.Client {\n }\n req, err := http.NewRequest(method, url, nil)\n\n if err != nil {\n fmt.Println(err)\n return\n }\n req.Header.Add(\"Authorization\", \"Bearer YOUR_TOKEN\")\n\n res, err := client.Do(req)\n if err != nil {\n fmt.Println(err)\n return\n }\n defer res.Body.Close()\n\n body, err := ioutil.ReadAll(res.Body)\n if err != nil {\n fmt.Println(err)\n return\n }\n fmt.Println(string(body))\n}" }, { "lang": "Java", "label": "Java", "source": "Unirest.setTimeouts(0, 0);\nHttpResponse response = Unirest.delete(\"https://api.catalogix.ai/v1/products?sku_codes=code&store_uuid=67762d4ce590324df813bd8c\")\n .header(\"Authorization\", \"Bearer YOUR_TOKEN\")\n .asString();\n" } ] } }, "/rate-limit-info": { "get": { "tags": [ "API Information" ], "summary": "Rate Limiting Info", "description": "rate_limit: 20 requests per minute \nExceeding this limit will result in a 429 Too Many Requests error.", "operationId": "rate_limit_info_rate_limit_info_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } } }, "security": [] } }, "/stores": { "post": { "tags": [ "Store" ], "summary": "Create Store", "operationId": "store_v1_store_post", "parameters": [ { "name": "copy_taxonomy", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Copy Taxonomy" } }, { "name": "linked_store_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Linked Store Id" } }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCreateModel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreCreateResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "413": { "description": "Payload too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } }, "get": { "tags": [ "Store" ], "summary": "Retrieve Store Details", "operationId": "retrieve_store_info_v1_store__store_id__get", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "example": "67762d4ce590324df813bd8c" }, "description": "Store identifier" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrieveStoreResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } }, "put": { "tags": [ "Store" ], "summary": "Update Store", "operationId": "store_v1_store__store_id__put", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "example": "67762d4ce590324df813bd8c" }, "description": "Store identifier" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreUpdateModel" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoreUpdateResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "413": { "description": "Payload too large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } }, "delete": { "tags": [ "Store" ], "summary": "Delete Store", "operationId": "store_v1_store__store_id__delete", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string", "example": "67762d4ce590324df813bd8c" }, "description": "Store identifier" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteStoreResponse" } } } }, "400": { "description": "Invalid data format", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "404": { "description": "not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/assets": { "get": { "tags": [ "Asset APIs" ], "summary": "Get Assets", "description": "Fetch assets grouped by `parent_code` and `channel`.", "operationId": "get_assets", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "699ec31355208b213e56059a", "description": "Store identifier" }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "default": "SMP" }, "description": "Channel filter" }, { "name": "asset_format", "in": "query", "required": false, "schema": { "type": "string", "default": "image", "enum": [ "image", "video", "pdf", "3D", "text" ] }, "description": "Asset format filter. Valid values: image, video, pdf, 3D, text." }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Pagination offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 50, "maximum": 50 }, "description": "Results per page (max 50)" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID. If not provided, one is generated automatically" } ], "responses": { "200": { "description": "Assets fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAssetsResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } }, "post": { "tags": [ "Asset APIs" ], "summary": "Create Assets", "description": "Create or update asset links with rank assignment. Supports batch input.", "operationId": "create_update_asset", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "699ec31355208b213e56059a", "description": "Store identifier" }, { "name": "channel", "in": "query", "required": false, "schema": { "type": "string", "default": "SMP" }, "description": "Channel for all assets in the request" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetUpsertItem" } }, "example": [ { "parent_code": "SKU001", "asset_type": "image", "assets": { "Image URL 1": "https://cdn.example.com/img1.jpg", "Image URL 2": "https://cdn.example.com/img2.jpg" } } ] } } }, "responses": { "200": { "description": "Assets created or updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUpsertResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request POST 'https://api.catalogix.ai/v1/assets?store_uuid=67762d4ce590324df813bd8c&channel=SMP' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\\n {\\n \"parent_code\": \"SKU001\",\\n \"asset_type\": \"image\",\\n \"assets\": {\\n \"Image URL 1\": \"https://cdn.example.com/img1.jpg\"\\n }\\n }\\n]'" }, { "lang": "Python", "label": "Python", "source": "import requests\nimport json\n\nurl = \"https://api.catalogix.ai/v1/assets?store_uuid=67762d4ce590324df813bd8c&channel=SMP\"\n\npayload = json.dumps([\n {\n \"parent_code\": \"SKU001\",\n \"asset_type\": \"image\",\n \"assets\": {\n \"Image URL 1\": \"https://cdn.example.com/img1.jpg\"\n }\n }\n])\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\nprint(response.text)\n" } ] }, "delete": { "tags": [ "Asset APIs" ], "summary": "Delete Assets", "description": "Delete assets based on supported filters. Although the public API is DELETE, the service internally calls the downstream delete-by-filter API using POST.", "operationId": "delete_asset", "parameters": [ { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetDeleteItem" } }, "example": [ { "store_uuid": "699ec31355208b213e56059a", "channel": "SMP", "parent_code": "SKU001", "asset_id": [ "id1", "id2" ] } ] } } }, "responses": { "200": { "description": "Assets deleted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDeleteResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } }, "x-codeSamples": [ { "lang": "cURL", "label": "cUrl", "source": "curl --location --request DELETE 'https://api.catalogix.ai/v1/assets' \\\n--header 'Authorization: Bearer YOUR_TOKEN' \\\n--header 'Content-Type: application/json' \\\n--data-raw '[\\n {\\n \"store_uuid\": \"699ec31355208b213e56059a\",\\n \"channel\": \"SMP\",\\n \"parent_code\": \"SKU001\",\\n \"asset_id\": [\"id1\", \"id2\"]\\n }\\n]'" }, { "lang": "Python", "label": "Python", "source": "import requests\nimport json\n\nurl = \"https://api.catalogix.ai/v1/assets\"\n\npayload = json.dumps([\n {\n \"store_uuid\": \"699ec31355208b213e56059a\",\n \"channel\": \"SMP\",\n \"parent_code\": \"SKU001\",\n \"asset_id\": [\"id1\", \"id2\"]\n }\n])\nheaders = {\n 'Authorization': 'Bearer YOUR_TOKEN',\n 'Content-Type': 'application/json'\n}\n\nresponse = requests.request(\"DELETE\", url, headers=headers, data=payload)\nprint(response.text)\n" } ] } }, "/assets/unlink": { "post": { "tags": [ "Asset APIs" ], "summary": "Unlink Assets", "description": "Unlink one or more assets from a given `parent_code` and `channel`.", "operationId": "unlink_assets", "parameters": [ { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AssetUnlinkItem" } }, "example": [ { "store_uuid": "699ec31355208b213e56059a", "parent_code": "SKU001", "channel": "SMP", "asset_id": "e263183310aa0093381bf48a6d8540aa" } ] } } }, "responses": { "200": { "description": "Assets unlinked", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUnlinkResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/collection": { "get": { "tags": [ "Collection APIs" ], "summary": "Get Collections", "description": "Retrieve collections for a store, with optional status filtering.", "operationId": "get_collections", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "69785f41c2c01fdb81c697b3", "description": "Store identifier" }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string" }, "example": "active,inactive", "description": "Comma-separated status filter. Allowed values: active, inactive, hidden." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 1000 }, "description": "Maximum number of collections to return (max: 1000)." }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "responses": { "200": { "description": "Collections retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectionsResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/collection/hierarchy": { "get": { "tags": [ "Collection APIs" ], "summary": "Get Collection Hierarchy", "description": "Retrieve the collection hierarchy (parent-child structure) for a store.", "operationId": "get_collection_hierarchy", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "69785f41c2c01fdb81c697b3", "description": "Store identifier" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "responses": { "200": { "description": "Collection hierarchy retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetCollectionHierarchyResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/search": { "get": { "tags": [ "Search APIs" ], "summary": "Text Search", "description": "Search products by text query.", "operationId": "text_search", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "69b3a770f5006c4b0be47c85", "description": "Store identifier" }, { "name": "text", "in": "query", "required": true, "schema": { "type": "string" }, "example": "shirt", "description": "Search query text" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Pagination offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of results" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "responses": { "200": { "description": "Search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextSearchResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/visual-search": { "post": { "tags": [ "Search APIs" ], "summary": "Visual Search", "description": "Search products by uploading an image.", "operationId": "visual_search", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "69b3a770f5006c4b0be47c85", "description": "Store identifier" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Pagination offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of results" }, { "name": "filters", "in": "query", "required": false, "schema": { "type": "string", "default": "{}", "example": "{\"Category\": \"Tops\", \"Color\": \"Blue\"}" }, "description": "Filters as a JSON-encoded string. Example: '{\"Category\": \"Tops\", \"Color\": \"Blue\"}'. Must be valid JSON if provided." }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "image" ], "properties": { "image": { "type": "string", "format": "binary", "description": "Image file for visual search" } } } } } }, "responses": { "200": { "description": "Visual search results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisualSearchResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } }, "502": { "description": "Downstream service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } } } } }, "/similar": { "get": { "tags": [ "Recommendation APIs" ], "summary": "Similar Products", "description": "Return a list of products similar to the given product code.", "operationId": "similar_products", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "699ec31355208b213e56059a", "description": "Store identifier used to resolve store name" }, { "name": "product_code", "in": "query", "required": true, "schema": { "type": "string" }, "example": "SKU001", "description": "Product code of the source product" }, { "name": "offset", "in": "query", "required": false, "schema": { "type": "integer", "default": 0 }, "description": "Pagination offset" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10, "maximum": 10 }, "description": "Maximum results (max 10)" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "responses": { "200": { "description": "Similar products", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimilarProductsResponse" } } } }, "404": { "description": "Store not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "502": { "description": "External API failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } } } } }, "/complementary": { "get": { "tags": [ "Recommendation APIs" ], "summary": "Complementary Products", "description": "Return categories of products that complement the given product code.", "operationId": "complementary_products", "parameters": [ { "name": "store_uuid", "in": "query", "required": true, "schema": { "type": "string" }, "example": "699ec31355208b213e56059a", "description": "Store identifier used to resolve store name" }, { "name": "product_code", "in": "query", "required": true, "schema": { "type": "string" }, "example": "SKU001", "description": "Product code of the source product" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Optional trace ID" } ], "responses": { "200": { "description": "Complementary product categories", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComplementaryProductsResponse" } } } }, "404": { "description": "Store not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "502": { "description": "External API failure", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseModel" } } } }, "401": { "description": "Unauthorized \u2013 Bearer token missing or invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedError" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InternalServerError" } } } } } } } }, "components": { "schemas": { "DeleteDataResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation, including code and message" }, "failed_codes": { "type": "object", "title": "Failed Codes", "description": "SKU codes that failed to delete. Keyed by sku_code with reason as value.", "example": { "SKU003": "Product not found" }, "additionalProperties": { "type": "string" } } }, "type": "object", "required": [ "status" ], "title": "DeleteDataResponse" }, "ErrorResponseModel": { "properties": { "status": { "type": "string", "title": "Status", "description": "The status of the request, typically 'error'", "default": "error" }, "detail": { "type": "string", "title": "Detail", "description": "A description of the error" } }, "type": "object", "required": [ "detail" ], "title": "ErrorResponseModel" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InsertData": { "properties": { "store_uuid": { "type": "string", "title": "Store Uuid", "description": "Unique identifier for the store", "example": "67762d4ce590324df813bd8c" }, "failed_products": { "type": "object", "title": "Failed Products", "description": "Products that failed to insert. Keyed by product_code with error details as value.", "example": { "SKU003": { "Color": "invalid value" } }, "additionalProperties": { "type": "object" } }, "successful_product_codes": { "items": { "type": "string" }, "type": "array", "title": "Successful Product Codes", "example": [ "CI001" ] }, "existing_product_codes": { "items": { "type": "string" }, "type": "array", "title": "Existing Product Codes", "default": [ "CI001" ] } }, "type": "object", "required": [ "store_uuid" ], "title": "InsertData" }, "InsertDataResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation" }, "data": { "allOf": [ { "$ref": "#/components/schemas/InsertData" } ], "description": "Information related to insertion of each products" } }, "type": "object", "required": [ "status", "data" ], "title": "InsertDataResponse" }, "RetrieveDataModel": { "properties": { "store_uuid": { "type": "string", "title": "Store Uuid", "description": "Unique identifier for the store" }, "products": { "items": { "type": "object" }, "type": "array", "title": "Products", "description": "List of products with their attributes and assets", "default": [] }, "total": { "type": "integer", "title": "Total", "description": "Total count of matching products", "example": 42 } }, "type": "object", "required": [ "store_uuid" ], "title": "RetrieveDataModel" }, "RetrieveDataResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation, including code and message" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveDataModel" } ], "description": "Data including store UUID, marketplace, and associated SKU data" } }, "type": "object", "required": [ "status", "data" ], "title": "RetrieveDataResponse" }, "SkuDataModel": { "properties": { "parent_code": { "type": "string", "title": "parent_code", "description": "product parent code", "example": "CI001" }, "Image URL 1": { "type": "string", "title": "Image Url 1", "description": "Image URL 1", "example": "https://assets-test.catalogix.ai/dee9c181338099b931cde78787df567a" }, "status": { "type": "string", "enum": [ "active", "new", "problem", "inactive", "draft", "under review" ], "title": "Status", "example": "inactive", "default": "new" }, "product_code": { "type": "string", "title": "product_code", "description": "Unique identifier for the product (SKU code)", "example": "CI001-BLU" } }, "type": "object", "required": [ "product_code", "parent_code" ], "title": "SkuDataModel", "description": "Product images are supplied as flat \"Image URL 1\", \"Image URL 2\", ... fields on this object (see the request examples) — there is no nested \"assets\" input field. The \"assets\": {images, videos} shape only appears in GET /products responses; POST /assets is a separate endpoint with its own shape." }, "StatusModel": { "properties": { "code": { "type": "integer", "title": "Code", "description": "Status code of the operation. 1 means success. -1 means failure. 0 means process moved to background", "example": 0 }, "message": { "type": "string", "title": "Message", "description": "Message describing the status", "example": "success" }, "request_id": { "type": "string", "title": "Request Id", "description": "Unique trace ID for the request. Echoed from X-Request-Id header or auto-generated.", "example": "8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312" } }, "type": "object", "required": [ "code", "message" ], "title": "StatusModel" }, "UpdateDataModel": { "properties": { "store_uuid": { "type": "string", "title": "Store Uuid", "description": "Unique identifier for the store", "example": "67762d4ce590324df813bd8c" }, "failed_products": { "type": "object", "title": "Failed Products", "description": "Products that failed to update. Keyed by product_code with error details as value.", "example": { "SKU003": { "Color": "invalid value" } }, "additionalProperties": { "type": "object" } }, "updated_skus": { "items": { "type": "string" }, "type": "array", "title": "Updated products", "description": "List of Products that were successfully updated", "default": [ "CI001" ] }, "unavailable_skus": { "items": { "type": "string" }, "type": "array", "title": "Unavailable products", "description": "List of Products that were unavailable for update", "default": [ "CI00000000" ] } }, "type": "object", "required": [ "store_uuid" ], "title": "UpdateDataModel" }, "UpdateDataResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation" }, "data": { "allOf": [ { "$ref": "#/components/schemas/UpdateDataModel" } ], "description": "Data containing updated and unavailable SKUs" } }, "type": "object", "required": [ "status", "data" ], "title": "UpdateDataResponse" }, "UpdateSkuDataModel": { "properties": { "status": { "type": "string", "enum": [ "active", "new", "problem", "inactive", "draft", "under review" ], "title": "Status", "example": "inactive" }, "product_code": { "type": "string", "title": "product_code", "description": "Unique identifier for the product (SKU code)", "example": "CI001" } }, "type": "object", "required": [ "product_code" ], "title": "UpdateSkuDataModel" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location", "default": [ "body", "" ] }, "msg": { "type": "string", "title": "Message", "default": "Field Required" }, "type": { "type": "string", "title": "Error Type", "default": "missing" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ChannelEnum": { "type": "string", "enum": [ "ajiob2c", "amazon-vendor", "flipkart_vendor", "firstcry", "ajio_offline", "limeroad", "flipkart_b2b", "tatacliq", "fynd", "ajiob2b", "trell", "myntra_b2b", "snapdeal", "meesho", "dealshare", "myntra", "jiomart", "bewakoof", "nykaa", "tatacliq-vendor", "levis", "flipkart", "amazon", "ajio-vendor", "shopsy", "shoppers_stop", "amazon_home_and_kitchen", "nnnow", "magento", "inorbit", "myntra-OR", "amazon-seller", "megamart", "eshopbox", "shopify", "facebook", "SMP", "google" ], "title": "ChannelEnum" }, "DefaultAutomation": { "type": "string", "enum": [ "color_distribution", "analyze_attribute", "analyze_image", "mask_computation", "product_listing_audit", "image_automation", "bulk_actions", "uniqueness_checker", "product_quality_score", "detail_shot_generator", "infographic_creator", "video_generation", "size_chart_creator", "data_sync_to_external", "delete_product_images", "bulk_edit", "data_export", "text_classifier", "optical_character_recognition", "image_classifier", "image_classifier_express", "image_classifier_precise", "conditional_attribution", "product_description", "product_title_generation", "SEO_Automations", "swatch_generation", "image_type", "image_upload", "bulk_image_upload", "hotspot_generation", "unique_content_generator", "master_automation", "multimedia_visibility", "background_removal", "face_swap", "service-1", "service-2", "service-3", "service-4", "service-5", "metadata_translation", "image_translation", "update_availability", "smp_upgrade", "SMP_image_upsert" ], "title": "DefaultAutomation" }, "RegionEnum": { "type": "string", "enum": [ "India", "Africa", "Asia", "Europe", "Global", "Middle East", "North America", "Oceania", "South America" ], "title": "RegionEnum" }, "StoreCreateModel": { "properties": { "store_name": { "type": "string", "title": "Store Name" }, "store_taxonomy": { "type": "string", "enum": [ "catalogix", "brand" ], "title": "Store Taxonomy" }, "store_website": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Store Website" }, "region": { "type": "array", "items": { "type": "string", "enum": [ "India", "Africa", "Asia", "Europe", "Global", "Middle East", "North America", "Oceania", "South America" ] }, "title": "Region", "description": "List of regions for the store.", "example": [ "India", "Africa" ] }, "channels": { "items": { "$ref": "#/components/schemas/ChannelEnum" }, "type": "array", "title": "Channels" }, "default_automation": { "items": { "$ref": "#/components/schemas/DefaultAutomation" }, "type": "array", "title": "Default Automation" } }, "type": "object", "required": [ "store_name", "store_taxonomy", "region", "channels", "default_automation" ], "title": "StoreCreateSchema", "example": { "channels": [ "ajiob2c", "SMP" ], "default_automation": [ "analyze_image" ], "region": [ "India", "Africa" ], "store_name": "sample store", "store_taxonomy": "catalogix", "store_website": "https://test.com" } }, "StoreUpdateModel": { "properties": { "store_name": { "type": "string", "title": "Store Name" }, "store_website": { "type": "string", "title": "Store Website" }, "region": { "type": "array", "items": { "type": "string", "enum": [ "India", "Africa", "Asia", "Europe", "Global", "Middle East", "North America", "Oceania", "South America" ] }, "title": "Region", "description": "Updated list of regions.", "example": [ "India" ] }, "channels": { "items": { "$ref": "#/components/schemas/ChannelEnum" }, "type": "array", "title": "Channels" }, "default_automation": { "items": { "$ref": "#/components/schemas/DefaultAutomation" }, "type": "array", "title": "Default Automation" } }, "type": "object", "required": [], "title": "StoreUpdatePayload", "example": { "channels": [ "ajiob2c", "SMP" ], "default_automation": [], "region": [ "India", "Africa" ], "store_name": "sample store", "store_website": "https://test.com" } }, "StoreCreateResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation" }, "data": { "type": "object", "properties": { "store_uuid": { "type": "string", "example": "699ec31355208b213e56059a" }, "store_group": { "type": "string", "example": "linked_store_id_abc" } }, "description": "Created store identifiers" } }, "type": "object", "required": [ "status", "data" ], "title": "StoreCreateResponse" }, "StoreUpdateResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation" } }, "type": "object", "required": [ "status" ], "title": "StoreUpdateResponse" }, "RetrieveStoreModel": { "properties": { "store_name": { "type": "string", "example": "Sample store" }, "workspace_id": { "type": "string", "example": "Sample store" }, "linked_store_id": { "type": "string", "example": "linked store" }, "store_website": { "type": "string", "example": "https://test.com" }, "country": { "type": "array", "items": { "type": "string" }, "example": [ "India" ] }, "channels": { "type": "object", "example": { "SMP": 34 } }, "store_taxonomy": { "type": "string", "example": "Catalogix" } }, "type": "object", "required": [ "store_uuid" ], "title": "RetrieveStoreModel" }, "RetrieveStoreResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation, including code and message" }, "data": { "allOf": [ { "$ref": "#/components/schemas/RetrieveStoreModel" } ], "description": "store UUID, marketplace, and associated store info" } }, "type": "object", "required": [ "status", "data" ], "title": "RetrieveStoreResponse" }, "DeleteStoreResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation, including code and message" } }, "type": "object", "required": [ "status" ], "title": "DeleteStoreResponse" }, "AssetUploadModel": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_images_v1_asset_upload_post" }, "AssetUploadResponse": { "properties": { "status": { "allOf": [ { "$ref": "#/components/schemas/StatusModel" } ], "description": "Status of the operation" }, "data": { "type": "object", "properties": { "asset_id": { "type": "string", "example": "abc123def456", "description": "Unique ID of the uploaded asset" }, "url": { "type": "string", "example": "https://assets.catalogix.ai/abc123", "description": "Public URL of the uploaded asset" }, "file_name": { "type": "string", "example": "product_image.jpg" }, "file_size": { "type": "integer", "example": 204800, "description": "File size in bytes" }, "mime_type": { "type": "string", "example": "image/jpeg" } }, "description": "Details of the uploaded asset" } }, "type": "object", "required": [ "status", "data" ], "title": "AssetUploadResponse" }, "StandardStatus": { "type": "object", "properties": { "code": { "type": "integer", "example": 0, "description": "0 = success, -1 = error" }, "message": { "type": "string", "example": "SUCCESS" }, "request_id": { "type": "string", "example": "8c8b2b7e-23d7-4c2a-91b0-2a7c4dfbb312" } } }, "AssetItem": { "type": "object", "properties": { "channel": { "type": "string", "example": "SMP" }, "asset_type": { "type": "string", "example": "image" }, "store_uuid": { "type": "string", "example": "699ec31355208b213e56059a" }, "assets": { "type": "array", "items": { "type": "object" } } } }, "GetAssetsResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "total_groups": { "type": "integer", "example": 10 }, "returned_groups": { "type": "integer", "example": 2 }, "assets": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/AssetItem" }, "example": { "SKU001": { "channel": "SMP", "asset_type": "image", "store_uuid": "abc123", "assets": [ { "Image URL 1": "https://cdn.example.com/img1.jpg", "asset_id": "abc123" } ] } } } } } } }, "AssetUpsertItem": { "type": "object", "required": [ "parent_code", "assets", "asset_type" ], "properties": { "parent_code": { "type": "string", "example": "SKU001", "description": "Parent/product code" }, "asset_type": { "type": "string", "example": "image", "description": "Defaults to image" }, "product_uuid": { "type": "string", "description": "Optional; resolved via search API if not provided" }, "assets": { "type": "object", "additionalProperties": { "type": "string" }, "example": { "Image URL 1": "https://cdn.example.com/img1.jpg" }, "description": "Map of image attribute name to URL" } } }, "AssetUpsertResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "created": { "type": "integer", "example": 1 }, "updated": { "type": "integer", "example": 0 }, "failed": { "type": "integer", "example": 0 }, "error_info": { "type": "array", "items": { "type": "object" } } } } } }, "AssetUnlinkItem": { "type": "object", "required": [ "store_uuid", "parent_code", "channel", "asset_id" ], "properties": { "store_uuid": { "type": "string", "example": "699ec31355208b213e56059a" }, "parent_code": { "type": "string", "example": "SKU001" }, "channel": { "type": "string", "example": "SMP" }, "asset_id": { "type": "string" } } }, "AssetUnlinkResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "unlinked": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 0 }, "error_info": { "type": "array", "items": { "type": "object" } } } } } }, "AssetDeleteItem": { "type": "object", "required": [ "store_uuid" ], "properties": { "store_uuid": { "type": "string", "example": "699ec31355208b213e56059a" }, "channel": { "type": "string", "example": "SMP" }, "parent_code": { "type": "string", "example": "SKU001" }, "asset_id": { "type": "array", "items": { "type": "string" }, "example": [ "id1", "id2" ] } } }, "AssetDeleteResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "deleted_count": { "type": "integer", "example": 2 }, "failed": { "type": "integer", "example": 0 }, "error_info": { "type": "array", "items": { "type": "object" } } } } } }, "CollectionItem": { "type": "object", "properties": { "name": { "type": "string", "example": "Shirts" }, "description": { "type": "string" }, "thumbnail": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "inactive", "hidden" ], "example": "active" }, "url": { "type": "string", "example": "Shirts69b29578c653e5cf72206d77" }, "displayPreference": { "type": "string", "example": "product" }, "autoRefresh": { "type": "boolean" }, "minProducts": { "type": "integer" }, "totalProducts": { "type": "integer" }, "meta": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" } } }, "sortBy": { "type": "object", "properties": { "static": { "type": "object", "properties": { "qualityScore": { "type": "boolean", "example": false }, "trendScore": { "type": "boolean", "example": false }, "personalization": { "type": "boolean", "example": false } } }, "dynamic": { "type": "array", "items": { "type": "object" } } } }, "filters": { "type": "object" }, "heroProducts": { "type": "array", "items": { "type": "string" } }, "groups": { "type": "array", "items": { "type": "object" } }, "bannerUrl": { "type": "string" }, "static": { "type": "string" } } }, "GetCollectionsResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionItem" } } } }, "CollectionAssociation": { "type": "object", "properties": { "children": { "type": "array", "items": { "type": "object" } }, "collectionId": { "type": "string" }, "collectionName": { "type": "string" }, "collectionUrl": { "type": "string" } } }, "GetCollectionHierarchyResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "vendor": { "type": "string", "example": "69785f41c2c01fdb81c697b3" }, "association": { "type": "array", "items": { "$ref": "#/components/schemas/CollectionAssociation" } } } } } }, "TextSearchResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TextSearchResult" }, "description": "List of matching products returned directly from upstream search API." } } }, "VisualSearchResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/VisualSearchResult" }, "description": "List of visually similar products with relevance scores." } } }, "SimilarProduct": { "type": "object", "properties": { "product_code": { "type": "string", "example": "SKU002" }, "score": { "type": "number", "example": 0.97 } } }, "SimilarProductsResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "products": { "type": "array", "items": { "$ref": "#/components/schemas/SimilarProduct" } }, "numFound": { "type": "integer", "example": 142 } } } } }, "ComplementaryCategory": { "type": "object", "properties": { "title": { "type": "string", "example": "TOPWEAR" }, "products": { "type": "array", "items": { "type": "object" } } } }, "ComplementaryProductsResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/StandardStatus" }, "data": { "type": "object", "properties": { "categories": { "type": "array", "items": { "$ref": "#/components/schemas/ComplementaryCategory" } } } } } }, "UnauthorizedError": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "integer", "example": -1 }, "message": { "type": "string", "example": "Unauthorized \u2013 invalid or missing Bearer token" } } } }, "title": "UnauthorizedError" }, "InternalServerError": { "type": "object", "properties": { "status": { "type": "object", "properties": { "code": { "type": "integer", "example": -1 }, "message": { "type": "string", "example": "Internal server error. Please contact support@catalogix.ai" } } } }, "title": "InternalServerError" }, "TextSearchResult": { "type": "object", "properties": { "product_code": { "type": "string", "example": "SKU001" }, "title": { "type": "string", "example": "Blue Shirt" }, "score": { "type": "number", "example": 0.95, "description": "Relevance score" } } }, "VisualSearchResult": { "type": "object", "properties": { "product_code": { "type": "string", "example": "SKU001" }, "score": { "type": "number", "example": 0.92 }, "image_url": { "type": "string", "example": "https://cdn.example.com/img1.jpg" } } } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Pass the API token as a Bearer token in the Authorization header." } } }, "security": [ { "bearerAuth": [] } ] }