https://api.nexscope.ai/woocommerce/productDetailRun 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/productDetail |
| 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, without query or fragment. Example: https://example.com |
productId | string | required | Store-scoped positive product ID, at most 19 decimal digits. Example: 34 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"cacheHit": false,
"fetchedAt": "1792972800000",
"product": {
"description": "Cotton shirt.",
"id": "34",
"images": [
{
"alt": "Shirt",
"url": "https://example.com/image.jpg"
}
],
"isInStock": true,
"isPasswordProtected": false,
"name": "Cotton Shirt",
"prices": {
"currency": "USD",
"minorUnit": 2,
"price": "11.05"
},
"shortDescription": "Cotton shirt.",
"sku": "SHIRT-34",
"type": "simple",
"url": "https://example.com/product/shirt",
"variation": ""
},
"storeUrl": "https://example.com"
},
"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. |
data: object · variant 1 — requires storeUrl, fetchedAt, cacheHit, product 34 fields
| 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.fetchedAt | string | required | Fetch time in epoch milliseconds, not the product modification time. Example: 1792972800000 |
data.product | object | required | Normalized public products. Example: {} |
data.product.description | any | optional | Description value used by this API operation. |
data.product.id | any | optional | Id value used by this API operation. |
data.product.images | array | required | Public image URLs; images are not fetched by this API. Example: [] |
data.product.images[] | object | required | Item in data product images. |
data.product.images[].alt | string | required | Plain text alternative label. Example: Shirt |
data.product.images[].url | string | required | Image URL. Example: https://example.com/image.jpg |
data.product.isInStock | any | optional | Is in stock value used by this API operation. |
data.product.isPasswordProtected | any | optional | Is password protected value used by this API operation. |
data.product.name | any | optional | Name value used by this API operation. |
data.product.parentId | any | optional | Parent id value used by this API operation. |
data.product.prices | object | required | Anonymous store pricing; decimal values are strings for exact precision. Example: {} |
data.product.prices.currency | string | required | Currency code. Example: USD |
data.product.prices.maxPrice | any | optional | Max price value used by this API operation. |
data.product.prices.maxPriceMinor | any | optional | Max price minor value used by this API operation. |
data.product.prices.minPrice | any | optional | Min price value used by this API operation. |
data.product.prices.minPriceMinor | any | optional | Min price minor value used by this API operation. |
data.product.prices.minorUnit | integer | required | Currency decimal precision. Example: 2 |
data.product.prices.price | any | optional | Price value used by this API operation. |
data.product.prices.priceMinor | any | optional | Price minor value used by this API operation. |
data.product.prices.regularPrice | any | optional | Regular price value used by this API operation. |
data.product.prices.regularPriceMinor | any | optional | Regular price minor value used by this API operation. |
data.product.prices.salePrice | any | optional | Sale price value used by this API operation. |
data.product.prices.salePriceMinor | any | optional | Sale price minor value used by this API operation. |
data.product.shortDescription | any | optional | Short description value used by this API operation. |
data.product.sku | any | optional | Sku value used by this API operation. |
data.product.stockQuantity | any | optional | Stock quantity value used by this API operation. |
data.product.type | any | optional | Type value used by this API operation. |
data.product.url | any | optional | Url value used by this API operation. |
data.product.variation | any | optional | Variation value used by this API operation. |
data.storeUrl | string | required | Normalized store identity. Example: https://example.com |
data.product.description: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.description | string | optional | Plain text or public product identifier. Example: Cotton shirt. |
data.product.description: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.description | null | optional | Description value used by this API operation. |
data.product.id: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.id | string | optional | Plain text or public product identifier. Example: 34 |
data.product.id: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.id | null | optional | Id value used by this API operation. |
data.product.isInStock: boolean · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.isInStock | boolean | optional | Store value, null when unavailable. Example: true |
data.product.isInStock: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.isInStock | null | optional | Is in stock value used by this API operation. |
data.product.isPasswordProtected: boolean · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.isPasswordProtected | boolean | optional | Store value, null when unavailable. Example: false |
data.product.isPasswordProtected: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.isPasswordProtected | null | optional | Is password protected value used by this API operation. |
data.product.name: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.name | string | optional | Plain text or public product identifier. Example: Cotton Shirt |
data.product.name: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.name | null | optional | Name value used by this API operation. |
data.product.parentId: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.parentId | string | optional | Store value; null when unavailable. Example: null |
data.product.parentId: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.parentId | null | optional | Parent id value used by this API operation. |
data.product.prices.maxPrice: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.maxPrice | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.maxPrice: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.maxPrice | null | optional | Max price value used by this API operation. |
data.product.prices.maxPriceMinor: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.maxPriceMinor | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.maxPriceMinor: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.maxPriceMinor | null | optional | Max price minor value used by this API operation. |
data.product.prices.minPrice: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.minPrice | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.minPrice: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.minPrice | null | optional | Min price value used by this API operation. |
data.product.prices.minPriceMinor: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.minPriceMinor | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.minPriceMinor: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.minPriceMinor | null | optional | Min price minor value used by this API operation. |
data.product.prices.price: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.price | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: 11.05 |
data.product.prices.price: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.price | null | optional | Price value used by this API operation. |
data.product.prices.priceMinor: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.priceMinor | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.priceMinor: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.priceMinor | null | optional | Price minor value used by this API operation. |
data.product.prices.regularPrice: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.regularPrice | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.regularPrice: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.regularPrice | null | optional | Regular price value used by this API operation. |
data.product.prices.regularPriceMinor: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.regularPriceMinor | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.regularPriceMinor: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.regularPriceMinor | null | optional | Regular price minor value used by this API operation. |
data.product.prices.salePrice: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.salePrice | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.salePrice: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.salePrice | null | optional | Sale price value used by this API operation. |
data.product.prices.salePriceMinor: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.salePriceMinor | string | optional | Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null |
data.product.prices.salePriceMinor: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.prices.salePriceMinor | null | optional | Sale price minor value used by this API operation. |
data.product.shortDescription: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.shortDescription | string | optional | Plain text or public product identifier. Example: Cotton shirt. |
data.product.shortDescription: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.shortDescription | null | optional | Short description value used by this API operation. |
data.product.sku: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.sku | string | optional | Plain text or public product identifier. Example: SHIRT-34 |
data.product.sku: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.sku | null | optional | Sku value used by this API operation. |
data.product.stockQuantity: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.stockQuantity | integer | optional | Always null: public Store API does not expose exact inventory. Example: null |
data.product.stockQuantity: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.stockQuantity | null | optional | Stock quantity value used by this API operation. |
data.product.type: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.type | string | optional | Store value; null when unavailable. Example: simple |
data.product.type: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.type | null | optional | Type value used by this API operation. |
data.product.url: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.url | string | optional | Plain text or public product identifier. Example: https://example.com/product/shirt |
data.product.url: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.url | null | optional | Url value used by this API operation. |
data.product.variation: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.variation | string | optional | Plain text or public product identifier. Example: |
data.product.variation: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.product.variation | null | optional | Variation value used by this API operation. |
data: null · variant 2 1 fields
| 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 or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), 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.