Visual Search

This API is currently in beta; the structure and route of API may change in the future.

POST

Route: /api/search/visual (BETA)

Generate complementary products for all products

Request Payload

{ 
"url": string;
"orgId": OrganizationID;
"toggle": {
        "category": boolean;
        "colour": boolean;
        "pattern": boolean;
        "gender": boolean;
        "material": boolean;
        "sleeveLength": boolean;
        "dressLength": boolean;
    }
}

Response ( status code: 200 )

{
  "data": {
    "items": [
      {
        "category": "Shirts",
        "gender": "women",
        "colour": "White",
        "pattern": "Solid",
        "material": "Silk",
        "occasion": "Office",
        "sleeveLength": "Long sleeve",
        "dressLength": "null",
        "location": [
          50,
          40
        ]
      },
      {
        "category": "Trousers",
        "gender": "women",
        "colour": "Black",
        "pattern": "Solid",
        "material": "Cotton",
        "occasion": "Office",
        "sleeveLength": "null",
        "dressLength": "null",
        "location": [
          50,
          60
        ]
      },
      {
        "category": "Heels",
        "gender": "women",
        "colour": "Black",
        "pattern": "Solid",
        "material": "Leather",
        "occasion": "Office",
        "sleeveLength": "null",
        "dressLength": "null",
        "location": [
          50,
          80
        ]
      }
    ]
  },
  "results": [
    [
      {
        "id": "8082456281340",
        "image": "https://cdn.shopify.com/s/files/1/0629/4483/7884/products/272229_WHITE_1.jpg?v=1686664307",
        "title": "Dorahh Longline Linen Shirt White",
        "category": "Clothing",
        "subcategory": "Clothing/Shirts"
      }
      ...
    ],
    [
      {
        "id": "8005752619260",
        "image": "https://cdn.shopify.com/s/files/1/0629/4483/7884/products/265767_BLACK_1.jpg?v=1676035467",
        "title": "Frittat Tailored Cigarette Trousers With Darts Black",
        "category": "Clothing",
        "subcategory": "Clothing/Trousers"
      },
     ...
    ],
    [
      {
        "id": "8056962842876",
        "image": "https://cdn.shopify.com/s/files/1/0629/4483/7884/products/267715_BLACK_1.jpg?v=1683195570",
        "title": "Teliah Leather Bow Embellished Court Heels Black",
        "category": "Footwear",
        "subcategory": "Footwear/Heels"
      },
     ...
    ]
  ],
  "timeTaken": "5.0"
}