TOtopi
ops
ops-sellers

Categorize products with AI

Changed on

For the given product IDs, categorize them automatically with AI (open AI ChatGPT) For categorizing all seller products (that are not categorized) send an empty list for ids

post/ops/sellers/{seller_id}/catalog/categorize

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/sellers/{seller_id}/catalog/categorize
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: catalog:edit

Path parameters

seller_idstring regexp required

Seller ID

Example:739b63c2-9e58-4964-b38d-4ebb424de242

Query parameters

batch_sizeinteger

number of products per batch to be sent to openAI

Example:1
num_workersinteger

number of workers to use for processing product batches

Example:2

Request body

idsstring[] required

List of IDs of topi products

Example request

{
  "ids": [
    "abc123"
  ]
}

Response

OK response.

Example response

{
  "result": {
    "errors": [
      "abc123"
    ],
    "total_categorized": 1,
    "total_errors": 1,
    "total_products": 1
  }
}

Changes

  • ac6979514123Revision changes
    • info

      api operation id catalog.CategorizeProducts removed and replaced with catalog#CategorizeProducts

  • 7ff7ee94b30eRevision changes
    • info

      api operation id catalog#CategorizeProducts removed and replaced with catalog.CategorizeProducts

    • info

      api tag ops-sellers added