apyhub-logo
FusionPlatformAPI CatalogPricingBlog

Generate Product Categories API

Artificial IntelligenceE-commerce Quick ToolsSmart Generation#categories#ecommerce#product
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Product Categories API generates a list of suitable categories for a given product, along with their relevance scores. By providing the product name and its parameters, this API returns related categories and their weights as float values ranging from 1.0 to 10.0, where 10 represents the highest relevance.
This API is highly useful for developers building e-commerce platforms, product catalog management systems, or bulk product processing tools. It automates the categorization of products, ensuring accuracy and consistency. Use cases include populating product catalog data, enhancing product search algorithms, and improving inventory management systems.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Generate Product Categories Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_categories

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_categories' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Razer Blade 16 Gaming Laptop: NVIDIA GeForce RTX 4090-13th Gen Intel 24-Core i9 HX CPU - 16\" Dual Mode Mini LED (4K UHD+ 120Hz & FHD+ 240Hz) - 32GB RAM - 2TB SSD - Compact GaN Charger - Windows 11",
8
    "language": "English"
9
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProduct name and its parameters to generate the categories
contextStringNoThe list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories)
languageStringNoSpecify the language of the output, defaults to English
voice_toneStringNoPreferred writing style parameter. It can be adjectives like funny or joyous, or even the name of a famous writer
max_quantityNumberNoMaximum number of product categories to generate
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/ecommerce/product_categories/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles