Nexscope

WooCommerce Product Collection Data

See price ranges, rating counts, and stock availability counts for WooCommerce products matching a keyword or category, where available.

Cost10 credits / call
Try online
POST · https://api.nexscope.ai/woocommerce/productCollectionDataMCP · nexscope_woocommerce_product_collection_data

What this API does

See price ranges, rating counts, and stock availability counts for WooCommerce products matching a keyword or category, where available. 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 use cases

Inspect a candidate product

To inspect a candidate product, a marketplace analyst submits storeUrl and keyword to WooCommerce Product Collection Data. 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 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 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 FAQ

What does the WooCommerce Product Collection Data API return?

See price ranges, rating counts, and stock availability counts for WooCommerce products matching a keyword or category, where available. 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 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 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 creditsConnect 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

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-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.
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.

Endpoint

MethodPOST
Pathhttps://api.nexscope.ai/woocommerce/productCollectionData
AuthBearer API key
Content-Typeapplication/json

Request parameters

NameTypeRequiredDescription
attributeTaxonomiesarrayoptional
Attribute taxonomies to count, using OR semantics, for example pa_color. Default empty.
Maximum items: 20
attributeTaxonomies[]stringrequired
Attribute taxonomies to count, using OR semantics, for example pa_color. Default empty.
Pattern: ^pa_[a-z0-9_-]{1,28}$
calculatePriceRangebooleanoptional
Calculate this aggregate; default true. Unsupported store fields may be null.
calculateRatingCountsbooleanoptional
Calculate this aggregate; default true. Unsupported store fields may be null.
calculateStockStatusCountsbooleanoptional
Calculate this aggregate; default true. Unsupported store fields may be null.
categoryIdstringoptional
Restrict to a public product category.
Pattern: ^[1-9][0-9]{0,18}$
keywordstringoptional
Search within this store; at most 200 characters.
Maximum length: 200
storeUrlstringrequired
Public HTTPS store root or WordPress installation path.
Maximum length: 2048
taxonomiesarrayoptional
Public taxonomies to count; default empty. Store support varies.
Maximum items: 20
taxonomies[]stringrequired
Public taxonomies to count; default empty. Store support varies.
Allowed: product_cat, product_tag, product_brand

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

NameTypeRequiredDescription
codeintegerrequired
0 means accepted or successful; nonzero is a platform error.
coststringrequired
Elapsed milliseconds, never credits; -1 outside web requests.
dataanyrequired
Data value used by this API operation.
msgstring | nullrequired
Msg value used by this API operation.
timestringrequired
Server local time: yyyy-MM-dd HH:mm:ss.
traceIdstring | nullrequired
Trace id value used by this API operation.
tsstringrequired
Epoch milliseconds.

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

NameTypeRequiredDescription
dataobjectrequired
Data value used by this API operation.
data.cacheHitbooleanrequired
Whether the response was served from the anonymous 60-second cache.
Example: false
data.collectionobjectrequired
Normalized public data. Missing optional values are null or empty strings.
Example: {}
data.collection.attributeCountsanyoptional
Attribute counts value used by this API operation.
data.collection.priceRangeanyoptional
Price range value used by this API operation.
data.collection.ratingCountsanyoptional
Rating counts value used by this API operation.
data.collection.stockStatusCountsanyoptional
Stock status counts value used by this API operation.
data.collection.taxonomyCountsanyoptional
Taxonomy counts value used by this API operation.
data.fetchedAtstringrequired
Fetch time in epoch milliseconds; preserved on cache hits.
Example: 1792972800000
data.storeUrlstringrequired
Normalized store identity.
Example: https://example.com

Any of option 1

NameTypeRequiredDescription
data.collection.attributeCountsarrayoptional
Null when disabled or unsupported by the store; empty array means no matches.
Example: []
data.collection.attributeCounts[]objectrequired
Item in data collection attributeCounts.
data.collection.attributeCounts[].countintegerrequired
Product count in this bucket.
Example: 1
data.collection.attributeCounts[].termIdstringrequired
Public aggregate bucket.
Example: 16

Any of option 2

NameTypeRequiredDescription
data.collection.attributeCountsnulloptional
Attribute counts value used by this API operation.

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

NameTypeRequiredDescription
data.collection.priceRangeobjectoptional
Null when disabled or unavailable; exact decimal strings.
Example: {}
data.collection.priceRange.currencystringrequired
Currency code.
Example: USD
data.collection.priceRange.maxPricestringrequired
Exact amount; Minor suffix denotes original smallest-unit value.
Example: 10.00
data.collection.priceRange.maxPriceMinorstringrequired
Exact amount; Minor suffix denotes original smallest-unit value.
Example: 1000
data.collection.priceRange.minPricestringrequired
Exact amount; Minor suffix denotes original smallest-unit value.
Example: 10.00
data.collection.priceRange.minPriceMinorstringrequired
Exact amount; Minor suffix denotes original smallest-unit value.
Example: 1000
data.collection.priceRange.minorUnitintegerrequired
Currency decimal precision.
Example: 2

Any of option 2

NameTypeRequiredDescription
data.collection.priceRangenulloptional
Price range value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.collection.ratingCountsarrayoptional
Null when disabled or unsupported by the store; empty array means no matches.
Example: []
data.collection.ratingCounts[]objectrequired
Item in data collection ratingCounts.
data.collection.ratingCounts[].countintegerrequired
Product count in this bucket.
Example: 1
data.collection.ratingCounts[].ratingintegerrequired
Public aggregate bucket.
Example: 5

Any of option 2

NameTypeRequiredDescription
data.collection.ratingCountsnulloptional
Rating counts value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.collection.stockStatusCountsarrayoptional
Null when disabled or unsupported by the store; empty array means no matches.
Example: []
data.collection.stockStatusCounts[]objectrequired
Item in data collection stockStatusCounts.
data.collection.stockStatusCounts[].countintegerrequired
Product count in this bucket.
Example: 1
data.collection.stockStatusCounts[].statusstringrequired
Public aggregate bucket.
Example: instock

Any of option 2

NameTypeRequiredDescription
data.collection.stockStatusCountsnulloptional
Stock status counts value used by this API operation.

Any of option 1

NameTypeRequiredDescription
data.collection.taxonomyCountsarrayoptional
Null when disabled or unsupported by the store; empty array means no matches.
Example: []
data.collection.taxonomyCounts[]objectrequired
Item in data collection taxonomyCounts.
data.collection.taxonomyCounts[].countintegerrequired
Product count in this bucket.
Example: 1
data.collection.taxonomyCounts[].termIdstringrequired
Public aggregate bucket.
Example: 16

Any of option 2

NameTypeRequiredDescription
data.collection.taxonomyCountsnulloptional
Taxonomy counts value used by this API operation.

Any of option 2

NameTypeRequiredDescription
datanullrequired
Data value used by this API operation.

Responses

CodeDescription
200Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result.
429Execution admission rate limit; honor Retry-After when present.
503Execution admission is temporarily unavailable; honor Retry-After when present.
Opt-inX-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.

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

What can you do with this API?

Data explained and practical use cases

AI Guide

Question

What data can WooCommerce Product Collection Data provide, and how might I use it?

AI answer

This API returns aggregate data for a public store’s product collection, optionally narrowed by keyword or category. You can request price, rating, stock, attribute-term, and taxonomy-term counts. Store support varies, and unsupported aggregate fields may be null.

Data categoryDocumented fieldsWhat the values mean
Price rangecollection.priceRange.currency, collection.priceRange.minorUnit, collection.priceRange.minPrice, collection.priceRange.maxPrice, collection.priceRange.minPriceMinor, collection.priceRange.maxPriceMinorThe collection’s reported minimum and maximum prices, currency, and minor-unit representation.
Attribute termscollection.attributeCounts.termId, collection.attributeCounts.countReported counts for requested attribute terms.
Ratingscollection.ratingCounts.rating, collection.ratingCounts.countReported product counts by rating.
Stock statuscollection.stockStatusCounts.status, collection.stockStatusCounts.countReported counts by stock status, such as instock.
Taxonomy termscollection.taxonomyCounts.termId, collection.taxonomyCounts.countReported counts for requested public taxonomy terms.

You could use it to:

  • Set a price-range filter using the reported bounds for a keyword search or category.
    • Prompt example: “I manage an online store catalog. Could you set a price-range filter using the reported bounds for a keyword search or category? Show matching records and source links where the API provides them; ask me for any required identifier or filter.”
  • Show counts alongside requested color or other attribute terms.
    • Prompt example: “I manage an online store catalog. Could you show counts alongside requested color or other attribute terms? Show the relevant returned evidence and tell me what input you need from me.”
  • Summarize how many matching products fall into each reported rating group.
    • Prompt example: “I manage an online store catalog. Could you summarize how many matching products fall into each reported rating group? Show the relevant returned evidence and tell me what input you need from me.”
  • Show the reported mix of in-stock and other stock statuses.
    • Prompt example: “I manage an online store catalog. Could you show the reported mix of in-stock and other stock statuses? Show the relevant returned evidence and tell me what input you need from me.”
  • Compare counts for requested category, tag, or brand terms when the store supports those taxonomies.
    • Prompt example: “I manage an online store catalog. Could you compare counts for requested category, tag, or brand terms when the store supports those taxonomies? Show the returned values behind the comparison, and mark missing data.”

Data Example

Sample request and response

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
  }
}

Related APIs