POST
https://api.nexscope.ai/woocommerce/productCategoriesRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/woocommerce/productCategories |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
storeUrl | string | required | Public HTTPS store root or WordPress installation path. Example: https://example.com |
pageNum | integer | optional | Page number, default 1. Example: 1 |
pageSize | integer | optional | Page size, default 20, maximum 100. Example: 20 |
keyword | string | optional | Search within this store; at most 200 characters. Example: shirt |
hideEmpty | boolean | optional | Hide terms without products; defaults to the store's true setting. Example: true |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"cacheHit": false,
"categories": [
{
"count": 1,
"description": "",
"id": "1",
"imageUrl": "",
"name": "Color",
"parentId": "0",
"slug": "blue",
"url": ""
}
],
"fetchedAt": "1792972800000",
"hasMore": false,
"pageNum": 1,
"pageSize": 20,
"storeUrl": "https://example.com",
"total": 1,
"totalPages": 1
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
Any of option 1 — requires storeUrl, fetchedAt, cacheHit, categories, pageNum, pageSize
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.cacheHit | boolean | required | Whether the response was served from the anonymous 60-second cache. Example: false |
data.categories | array | required | Normalized public data. Missing optional values are null or empty strings. Example: [] |
data.categories[] | object | required | Item in data categories. |
data.categories[].count | any | optional | Count value used by this API operation. |
data.categories[].description | string | required | Plain text or public URL; empty when unavailable. Images are not fetched. Example: |
data.categories[].id | string | required | Store-scoped ID string. Example: 1 |
data.categories[].imageUrl | string | required | Plain text or public URL; empty when unavailable. Images are not fetched. Example: |
data.categories[].name | string | required | Plain text name. Example: Color |
data.categories[].parentId | any | optional | Parent id value used by this API operation. |
data.categories[].slug | string | required | Plain text or public URL; empty when unavailable. Images are not fetched. Example: blue |
data.categories[].url | string | required | Plain text or public URL; empty when unavailable. Images are not fetched. Example: |
data.fetchedAt | string | required | Fetch time in epoch milliseconds; preserved on cache hits. Example: 1792972800000 |
data.hasMore | any | optional | Has more value used by this API operation. |
data.pageNum | integer | required | Pagination metadata; omitted upstream totals become null. Example: 1 |
data.pageSize | integer | required | Pagination metadata; omitted upstream totals become null. Example: 20 |
data.storeUrl | string | required | Normalized store identity. Example: https://example.com |
data.total | any | optional | Total value used by this API operation. |
data.totalPages | any | optional | Total pages value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.categories[].count | integer | optional | Associated product count, null when unavailable. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categories[].count | null | optional | Count value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.categories[].parentId | string | optional | Parent ID; 0 is a root term, null means unavailable. Example: 0 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.categories[].parentId | null | optional | Parent id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.hasMore | boolean | optional | Null when upstream total pages are unavailable. Example: false |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.hasMore | null | optional | Has more value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Pagination metadata; omitted upstream totals become null. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPages | integer | optional | Pagination metadata; omitted upstream totals become null. Example: 1 |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPages | null | optional | Total pages value used by this API operation. |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing API key (code 11209), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.