WooCommerce Product Collection Data API

Retrieve WooCommerce product collection data from a specified public store with Nexscope. Access structured catalog data without a merchant key.

Cost10 credits / call

Try online

POST · https://api.nexscope.ai/woocommerce/productCollectionDataMCP · nexscope_woocommerce_product_collection_data

What this API does

Retrieve WooCommerce product collection data from a specified public store with Nexscope. The request accepts storeUrl, keyword, categoryId, calculatePriceRange, calculateRatingCounts. Its documented result includes cacheHit, collection.attributeCounts.count, collection.attributeCounts.termId, collection.priceRange.currency, collection.priceRange.maxPrice, collection.priceRange.maxPriceMinor, collection.priceRange.minPrice, collection.priceRange.minPriceMinor.

WooCommerce Product Collection Data API API use cases

Inspect a candidate product

To inspect a candidate product, a marketplace analyst submits storeUrl and keyword to WooCommerce Product Collection Data API. The returned cacheHit, collection.attributeCounts.count, collection.attributeCounts.termId help inspect the documented attributes of the candidate product.

Compare listing details

A marketplace analyst uses WooCommerce Product Collection Data API with storeUrl and keyword to compare listing details. The returned cacheHit, collection.attributeCounts.count, collection.attributeCounts.termId help compare product details with another shortlisted listing.

Prepare product evidence for a sourcing review

For this workflow, a marketplace analyst calls WooCommerce Product Collection Data API with storeUrl and keyword to prepare product evidence for a sourcing review. The result helps record product facts before a sourcing discussion.

WooCommerce Product Collection Data API API FAQ

What does the WooCommerce Product Collection Data API API return?

Retrieve WooCommerce product collection data from a specified public store with Nexscope. The documented output includes cacheHit, collection.attributeCounts.count, collection.attributeCounts.termId, collection.priceRange.currency, collection.priceRange.maxPrice, collection.priceRange.maxPriceMinor, collection.priceRange.minPrice, collection.priceRange.minPriceMinor. It corresponds to the supplied storeUrl, keyword, categoryId, calculatePriceRange, calculateRatingCounts. Optional fields can be absent; a missing value should not be interpreted as a measured zero. Example values illustrate the response shape, rather than live account results.

How many credits does the WooCommerce Product Collection Data API API cost?

The current documented cost is 10 credits / call. This is the same cost shown at the top of this page. If a range or estimate is displayed, the final charge depends on the request. Review your available credits and the pricing page before calling the API, and check API usage records for the actual charge.

How do I call the WooCommerce Product Collection Data API API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/woocommerce/productCollectionData with your API key as a Bearer token and the JSON inputs shown in API integration. In a compatible MCP client such as Claude or Cursor, connect Nexscope and call nexscope_woocommerce_product_collection_data. Use the MCP arguments shown in the MCP guide, or switch Online test to MCP to review its request before adding it to your app.

View plans and credits Connect this API with MCP

Try this API

Endpoint

https://api.nexscope.ai/woocommerce/productCollectionData

MCP method

nexscope_woocommerce_product_collection_data

Step 1 of 3 · Authenticate

Authentication

All run endpoints require a user API key. Send it as a bearer token in the Authorization header.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

Missing or invalid API keys return an authentication error. Manage keys from .

Step 2 of 3 · Send a request

POSThttps://api.nexscope.ai/woocommerce/productCollectionData

Run an API

Send a JSON request body using the parameters described below.

Example request

Replace YOUR_API_KEY, then run this command in your terminal.

curl -X POST 'https://api.nexscope.ai/woocommerce/productCollectionData' \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "storeUrl": "https://example.com"
}'

Code example

{
  "storeUrl": "https://example.com"
}

Step 3 of 3 · Inspect the result

Check the response

Read code for the request status and data for the result. Open the parameter and response reference for the full field definitions.

HTTP status codes

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.

View parameters & response Try online

All categories/ WooCommerce

POSThttps://api.nexscope.ai/woocommerce/productCollectionData

Run this API

Send a JSON request to execute this API and receive the documented response payload.

Open tester

Endpoint

Method	`POST`
Path	`https://api.nexscope.ai/woocommerce/productCollectionData`
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
`keyword`	`string`	optional	Search within this store; at most 200 characters. Example: shirt
`categoryId`	`string`	optional	Restrict to a public product category. Example: 16
`calculatePriceRange`	`boolean`	optional	Calculate this aggregate; default true. Unsupported store fields may be null. Example: true
`calculateRatingCounts`	`boolean`	optional	Calculate this aggregate; default true. Unsupported store fields may be null. Example: true
`calculateStockStatusCounts`	`boolean`	optional	Calculate this aggregate; default true. Unsupported store fields may be null. Example: true
`attributeTaxonomies`	`array`	optional	Attribute taxonomies to count, using OR semantics, for example pa_color. Default empty. Example: [ "pa_color" ]
`taxonomies`	`array`	optional	Public taxonomies to count; default empty. Store support varies. Example: [ "product_cat" ]

Response example

Platform response envelope. code 0 indicates success or acceptance; data contains the business result.

{
  "code": 0,
  "cost": "-1",
  "data": {
    "cacheHit": false,
    "collection": {
      "attributeCounts": [
        {
          "count": 1,
          "termId": "16"
        }
      ],
      "priceRange": {
        "currency": "USD",
        "maxPrice": "10.00",
        "maxPriceMinor": "1000",
        "minPrice": "10.00",
        "minPriceMinor": "1000",
        "minorUnit": 2
      },
      "ratingCounts": [
        {
          "count": 1,
          "rating": 5
        }
      ],
      "stockStatusCounts": [
        {
          "count": 1,
          "status": "instock"
        }
      ],
      "taxonomyCounts": [
        {
          "count": 1,
          "termId": "16"
        }
      ]
    },
    "fetchedAt": "1792972800000",
    "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.

Any of option 1 — requires storeUrl, fetchedAt, cacheHit, collection

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.collection`	`object`	required	Normalized public data. Missing optional values are null or empty strings. Example: {}
`data.collection.attributeCounts`	`any`	optional	Attribute counts value used by this API operation.
`data.collection.priceRange`	`any`	optional	Price range value used by this API operation.
`data.collection.ratingCounts`	`any`	optional	Rating counts value used by this API operation.
`data.collection.stockStatusCounts`	`any`	optional	Stock status counts value used by this API operation.
`data.collection.taxonomyCounts`	`any`	optional	Taxonomy counts value used by this API operation.
`data.fetchedAt`	`string`	required	Fetch time in epoch milliseconds; preserved on cache hits. Example: 1792972800000
`data.storeUrl`	`string`	required	Normalized store identity. Example: https://example.com

Any of option 1

Name	Type	Required	Description
`data.collection.attributeCounts`	`array`	optional	Null when disabled or unsupported by the store; empty array means no matches. Example: []
`data.collection.attributeCounts[]`	`object`	required	Item in data collection attributeCounts.
`data.collection.attributeCounts[].count`	`integer`	required	Product count in this bucket. Example: 1
`data.collection.attributeCounts[].termId`	`string`	required	Public aggregate bucket. Example: 16

Any of option 2

Name	Type	Required	Description
`data.collection.attributeCounts`	`null`	optional	Attribute counts value used by this API operation.

Any of option 1 — requires currency, minorUnit, minPrice, maxPrice, minPriceMinor, maxPriceMinor

Name	Type	Required	Description
`data.collection.priceRange`	`object`	optional	Null when disabled or unavailable; exact decimal strings. Example: {}
`data.collection.priceRange.currency`	`string`	required	Currency code. Example: USD
`data.collection.priceRange.maxPrice`	`string`	required	Exact amount; Minor suffix denotes original smallest-unit value. Example: 10.00
`data.collection.priceRange.maxPriceMinor`	`string`	required	Exact amount; Minor suffix denotes original smallest-unit value. Example: 1000
`data.collection.priceRange.minPrice`	`string`	required	Exact amount; Minor suffix denotes original smallest-unit value. Example: 10.00
`data.collection.priceRange.minPriceMinor`	`string`	required	Exact amount; Minor suffix denotes original smallest-unit value. Example: 1000
`data.collection.priceRange.minorUnit`	`integer`	required	Currency decimal precision. Example: 2

Any of option 2

Name	Type	Required	Description
`data.collection.priceRange`	`null`	optional	Price range value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.collection.ratingCounts`	`array`	optional	Null when disabled or unsupported by the store; empty array means no matches. Example: []
`data.collection.ratingCounts[]`	`object`	required	Item in data collection ratingCounts.
`data.collection.ratingCounts[].count`	`integer`	required	Product count in this bucket. Example: 1
`data.collection.ratingCounts[].rating`	`integer`	required	Public aggregate bucket. Example: 5

Any of option 2

Name	Type	Required	Description
`data.collection.ratingCounts`	`null`	optional	Rating counts value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.collection.stockStatusCounts`	`array`	optional	Null when disabled or unsupported by the store; empty array means no matches. Example: []
`data.collection.stockStatusCounts[]`	`object`	required	Item in data collection stockStatusCounts.
`data.collection.stockStatusCounts[].count`	`integer`	required	Product count in this bucket. Example: 1
`data.collection.stockStatusCounts[].status`	`string`	required	Public aggregate bucket. Example: instock

Any of option 2

Name	Type	Required	Description
`data.collection.stockStatusCounts`	`null`	optional	Stock status counts value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.collection.taxonomyCounts`	`array`	optional	Null when disabled or unsupported by the store; empty array means no matches. Example: []
`data.collection.taxonomyCounts[]`	`object`	required	Item in data collection taxonomyCounts.
`data.collection.taxonomyCounts[].count`	`integer`	required	Product count in this bucket. Example: 1
`data.collection.taxonomyCounts[].termId`	`string`	required	Public aggregate bucket. Example: 16

Any of option 2

Name	Type	Required	Description
`data.collection.taxonomyCounts`	`null`	optional	Taxonomy counts 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.

Step 1 of 2 · Connect your MCP client

MCP

V2 recommended

Connect remote agents through the standard MCP 2025-11-25 Streamable HTTP endpoint. Use OAuth 2.1 Authorization Code with PKCE, or an API key for compatibility.

POST https://api.nexscope.ai/mcp
MCP-Protocol-Version: 2025-11-25
Content-Type: application/json

Authentication

OAuth clients request the mcp:tools scope. The endpoint's 401 response advertises protected-resource metadata for authorization discovery.

Step 2 of 2 · Call the tool

Call a tool

{
  "jsonrpc": "2.0",
  "id": "tool-call-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_woocommerce_product_collection_data",
    "arguments": {
      "storeUrl": "https://example.com"
    }
  }
}

Legacy MCP v1

Existing API-key clients can continue using the compatibility endpoint. New integrations should use MCP v2.

GET / POST /mcp/legacy

Data Example

Request parameters

{
  "storeUrl": "https://cipherskincare.com"
}

Response

{
  "code": 0,
  "msg": null,
  "data": {
    "storeUrl": "https://cipherskincare.com",
    "collection": {
      "priceRange": {
        "currency": "USD",
        "minorUnit": 2,
        "minPriceMinor": "5200",
        "minPrice": "52.00",
        "maxPriceMinor": "999999999900",
        "maxPrice": "9999999999.00"
      },
      "attributeCounts": null,
      "ratingCounts": [
        {
          "rating": 5,
          "count": 8
        }
      ],
      "stockStatusCounts": [
        {
          "status": "instock",
          "count": 13
        },
        {
          "status": "outofstock",
          "count": 1
        },
        {
          "status": "onbackorder",
          "count": 0
        }
      ],
      "taxonomyCounts": null
    },
    "fetchedAt": "1793089762877",
    "cacheHit": false
  }
}

Online test

Execute the current API with your API key and JSON payload. Online tests use this site's configured API environment; the Endpoint and copyable examples use the public integration address.

10 credits / callAPI usage records

Try it

Send a real request with the same contract shown in the reference.

Endpoint

/woocommerce/productCollectionData

MCP method

nexscope_woocommerce_product_collection_data

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/woocommerce/productCollectionData \
  -H "Authorization: Bearer nk-..." \
  -H "Content-Type: application/json" \
  -d '{ "storeUrl": "https://example.com" }'

Response

No response yet. Run the request to see the response here.

Related APIs

WooCommerce Product Attribute Detail

Retrieve WooCommerce product attribute detail from a specified public store with Nexscope.

WooCommerce Product Attribute Terms

Retrieve WooCommerce product attribute terms from a specified public store with Nexscope.

WooCommerce Product Attributes

Retrieve WooCommerce product attributes from a specified public store with Nexscope.

WooCommerce Product Brands

Retrieve WooCommerce product brands from a specified public store with Nexscope.