Create persistent categorization

Create persistent categorization with the Smart Categorization API.

Learn how to submit products for asynchronous categorization and persist the result so you can retrieve and modify it later.

Endpoint

POST /public-api/categorize/persist

Submits products for categorization and persists the results. After the job completes, you can retrieve and modify persisted results.

Authentication

All requests require a valid bearer token in the Authorization header.

Authorization: Bearer {ACCESS_TOKEN}

Request

{
  "uniqueIdentifierType": "GTIN",
  "products": [
    {
      "productUniqueId": "1234567890123",
      "productTitle": "Wireless Mouse",
      "productDescription": "Ergonomic wireless mouse for laptop use.",
      "identifiers": {
        "SKU": "WM-101"
      },
      "concatenatedExtraColumns": {
        "brand": "Vertex Tech"
      }
    }
  ]
}
PropertyTypeRequiredDescription
uniqueIdentifierTypestringYesThe unique record identifier type. Supported values include GTIN, SKU, NDC, UDI-DI, HIBC, MPN, Catalog Number, UNSPSC, and HSN.
productsarrayYesOne or more products to categorize.

Example

curl --request POST \
  --url https://smartcategorization.vertexcloud.com/public-api/categorize/persist \
  --header "Authorization: Bearer {ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{
    "uniqueIdentifierType": "GTIN",
    "products": [
      {
        "productUniqueId": "1234567890123",
        "productTitle": "Wireless Mouse",
        "productDescription": "Ergonomic wireless mouse for laptop use.",
        "identifiers": {
          "SKU": "WM-101"
        }
      }
    ]
  }'

Response

{
  "id": "7ecf0bb0-8a90-4fc0-8e51-7c2f1d5a553e",
  "clientVertexId": "4e0864e9-2a1d-4d8f-aeb7-2677f1a19462",
  "startTime": "2026-09-25T12:00:00Z",
  "persistent": true,
  "numProducts": 1,
  "numIssues": 0,
  "retentionDays": 30,
  "result": "Job created"
}

Errors

StatusDescription
400 Bad RequestThe request is invalid. Common reasons include a missing or invalid uniqueIdentifierType, duplicate product IDs, or a product missing productUniqueId.
401 UnauthorizedThe bearer token is missing, expired, or invalid.
403 ForbiddenThe caller does not have permission to persist categorization results.
500 Internal Server ErrorThe service encountered an unexpected error while processing the request.

Did this page help you?