WooCommerce Products API

Search WooCommerce store products from a specified public store with Nexscope. Get exact prices and availability using API key authentication.

Cost10 credits / call

Try online

POST · https://api.nexscope.ai/woocommerce/productsMCP · nexscope_woocommerce_products

What this API does

Search WooCommerce store products from a specified public store with Nexscope. Get exact prices and availability using API key authentication. The request accepts storeUrl, keyword, pageNum, pageSize. Its documented result includes cacheHit, fetchedAt, hasMore, pageNum, pageSize, products.description, products.id, products.images.alt.

WooCommerce Products API API use cases

Inspect a candidate product

To inspect a candidate product, a marketplace analyst submits storeUrl and keyword to WooCommerce Products API. The returned cacheHit, fetchedAt, hasMore help inspect the documented attributes of the candidate product.

Compare listing details

A marketplace analyst uses WooCommerce Products API with storeUrl and keyword to compare listing details. The returned cacheHit, fetchedAt, hasMore help compare product details with another shortlisted listing.

Prepare product evidence for a sourcing review

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

WooCommerce Products API API FAQ

What does the WooCommerce Products API API return?

Search WooCommerce store products from a specified public store with Nexscope. Get exact prices and availability using API key authentication. The documented output includes cacheHit, fetchedAt, hasMore, pageNum, pageSize, products.description, products.id, products.images.alt. It corresponds to the supplied storeUrl, keyword, pageNum, pageSize. 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 Products 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 Products API API from my app or an MCP client?

Send a POST request to https://api.nexscope.ai/woocommerce/products 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_products. 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/products

MCP method

nexscope_woocommerce_products

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/products

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/products' \
  -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/products

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/products`
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
`keyword`	`string`	optional	Search only within this store; at most 200 characters. Example: shirt
`pageNum`	`integer`	optional	Page number, default 1. Example: 1
`pageSize`	`integer`	optional	Page size, default 20, maximum 100. Example: 20

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",
    "hasMore": false,
    "pageNum": 1,
    "pageSize": 20,
    "products": [
      {
        "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",
    "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, products, 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.fetchedAt`	`string`	required	Fetch time in epoch milliseconds, not the product modification time. Example: 1792972800000
`data.hasMore`	`any`	optional	Has more value used by this API operation.
`data.pageNum`	`integer`	required	Pagination metadata; totals are null when the store omits headers. Example: 1
`data.pageSize`	`integer`	required	Pagination metadata; totals are null when the store omits headers. Example: 20
`data.products`	`array`	required	Normalized public products. Example: []
`data.products[]`	`object`	required	Item in data products.
`data.products[].description`	`any`	optional	Description value used by this API operation.
`data.products[].id`	`any`	optional	Id value used by this API operation.
`data.products[].images`	`array`	required	Public image URLs; images are not fetched by this API. Example: []
`data.products[].images[]`	`object`	required	Item in data products[] images.
`data.products[].images[].alt`	`string`	required	Plain text alternative label. Example: Shirt
`data.products[].images[].url`	`string`	required	Image URL. Example: https://example.com/image.jpg
`data.products[].isInStock`	`any`	optional	Is in stock value used by this API operation.
`data.products[].isPasswordProtected`	`any`	optional	Is password protected value used by this API operation.
`data.products[].name`	`any`	optional	Name value used by this API operation.
`data.products[].parentId`	`any`	optional	Parent id value used by this API operation.
`data.products[].prices`	`object`	required	Anonymous store pricing; decimal values are strings for exact precision. Example: {}
`data.products[].prices.currency`	`string`	required	Currency code. Example: USD
`data.products[].prices.maxPrice`	`any`	optional	Max price value used by this API operation.
`data.products[].prices.maxPriceMinor`	`any`	optional	Max price minor value used by this API operation.
`data.products[].prices.minPrice`	`any`	optional	Min price value used by this API operation.
`data.products[].prices.minPriceMinor`	`any`	optional	Min price minor value used by this API operation.
`data.products[].prices.minorUnit`	`integer`	required	Currency decimal precision. Example: 2
`data.products[].prices.price`	`any`	optional	Price value used by this API operation.
`data.products[].prices.priceMinor`	`any`	optional	Price minor value used by this API operation.
`data.products[].prices.regularPrice`	`any`	optional	Regular price value used by this API operation.
`data.products[].prices.regularPriceMinor`	`any`	optional	Regular price minor value used by this API operation.
`data.products[].prices.salePrice`	`any`	optional	Sale price value used by this API operation.
`data.products[].prices.salePriceMinor`	`any`	optional	Sale price minor value used by this API operation.
`data.products[].shortDescription`	`any`	optional	Short description value used by this API operation.
`data.products[].sku`	`any`	optional	Sku value used by this API operation.
`data.products[].stockQuantity`	`any`	optional	Stock quantity value used by this API operation.
`data.products[].type`	`any`	optional	Type value used by this API operation.
`data.products[].url`	`any`	optional	Url value used by this API operation.
`data.products[].variation`	`any`	optional	Variation value used by this API operation.
`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.hasMore`	`boolean`	optional	Null when 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.products[].description`	`string`	optional	Plain text or public product identifier. Example: Cotton shirt.

Any of option 2

Name	Type	Required	Description
`data.products[].description`	`null`	optional	Description value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].id`	`string`	optional	Plain text or public product identifier. Example: 34

Any of option 2

Name	Type	Required	Description
`data.products[].id`	`null`	optional	Id value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].isInStock`	`boolean`	optional	Store value, null when unavailable. Example: true

Any of option 2

Name	Type	Required	Description
`data.products[].isInStock`	`null`	optional	Is in stock value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].isPasswordProtected`	`boolean`	optional	Store value, null when unavailable. Example: false

Any of option 2

Name	Type	Required	Description
`data.products[].isPasswordProtected`	`null`	optional	Is password protected value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].name`	`string`	optional	Plain text or public product identifier. Example: Cotton Shirt

Any of option 2

Name	Type	Required	Description
`data.products[].name`	`null`	optional	Name value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].parentId`	`string`	optional	Store value; null when unavailable. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].parentId`	`null`	optional	Parent id value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.maxPrice`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.maxPrice`	`null`	optional	Max price value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.maxPriceMinor`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.maxPriceMinor`	`null`	optional	Max price minor value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.minPrice`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.minPrice`	`null`	optional	Min price value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.minPriceMinor`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.minPriceMinor`	`null`	optional	Min price minor value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.price`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: 11.05

Any of option 2

Name	Type	Required	Description
`data.products[].prices.price`	`null`	optional	Price value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.priceMinor`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.priceMinor`	`null`	optional	Price minor value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.regularPrice`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.regularPrice`	`null`	optional	Regular price value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.regularPriceMinor`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.regularPriceMinor`	`null`	optional	Regular price minor value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.salePrice`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.salePrice`	`null`	optional	Sale price value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].prices.salePriceMinor`	`string`	optional	Exact amount string; null when unavailable. Minor suffix denotes original smallest-unit amount. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].prices.salePriceMinor`	`null`	optional	Sale price minor value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].shortDescription`	`string`	optional	Plain text or public product identifier. Example: Cotton shirt.

Any of option 2

Name	Type	Required	Description
`data.products[].shortDescription`	`null`	optional	Short description value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].sku`	`string`	optional	Plain text or public product identifier. Example: SHIRT-34

Any of option 2

Name	Type	Required	Description
`data.products[].sku`	`null`	optional	Sku value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].stockQuantity`	`integer`	optional	Always null: public Store API does not expose exact inventory. Example: null

Any of option 2

Name	Type	Required	Description
`data.products[].stockQuantity`	`null`	optional	Stock quantity value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].type`	`string`	optional	Store value; null when unavailable. Example: simple

Any of option 2

Name	Type	Required	Description
`data.products[].type`	`null`	optional	Type value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].url`	`string`	optional	Plain text or public product identifier. Example: https://example.com/product/shirt

Any of option 2

Name	Type	Required	Description
`data.products[].url`	`null`	optional	Url value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.products[].variation`	`string`	optional	Plain text or public product identifier. Example:

Any of option 2

Name	Type	Required	Description
`data.products[].variation`	`null`	optional	Variation value used by this API operation.

Any of option 1

Name	Type	Required	Description
`data.total`	`integer`	optional	Pagination metadata; totals are null when the store omits headers. 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; totals are null when the store omits headers. 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.

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_products",
    "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",
  "pageSize": 2
}

Response

{
  "code": 0,
  "msg": null,
  "data": {
    "storeUrl": "https://cipherskincare.com",
    "products": [
      {
        "id": "20183",
        "parentId": "0",
        "type": "variable",
        "name": "The Anomaly",
        "sku": "CIP-ANM",
        "url": "https://cipherskincare.com/product/the-anomaly/",
        "description": "",
        "shortDescription": "An eye serum that visibly lifts the upper lid as well as the under-eye. Its 70% active technologies depuff, brighten dark circles and smooth fine lines, so your eyes look rested even when you aren’t.",
        "variation": "",
        "isInStock": true,
        "stockQuantity": null,
        "prices": {
          "currency": "USD",
          "minorUnit": 2,
          "priceMinor": "10500",
          "price": "105.00",
          "regularPriceMinor": "10500",
          "regularPrice": "105.00",
          "salePriceMinor": "10500",
          "salePrice": "105.00",
          "minPrice": null,
          "maxPrice": null,
          "minPriceMinor": null,
          "maxPriceMinor": null
        },
        "images": [
          {
            "url": "https://cipherskincare.com/wp-content/uploads/2024/08/cipher-skincare-the-anomaly-eye-matrix-serum-concentrate-15ml-1.jpg",
            "alt": "best eye serum cipher skincare the anomaly eye matrix concentrate targets under eye and lids"
          },
          {
            "url": "https://cipherskincare.com/wp-content/uploads/2024/08/the-anomaly-with-box.jpg",
            "alt": "eye serum cipher skincare the anomaly eye matrix concentrate targets under eye and lids"
          }
        ]
      },
      {
        "id": "19611",
        "parentId": "0",
        "type": "variable",
        "name": "Stimpack",
        "sku": "CIP-STP",
        "url": "https://cipherskincare.com/product/stimpack/",
        "description": "",
        "shortDescription": "A leave-in scalp serum that controls oil, clears flaking and calms itch, so you can go longer between washes. Stimulating actives amplify vitality at the root to prevent thinning and deliver fuller, denser-looking hair.",
        "variation": "",
        "isInStock": true,
        "stockQuantity": null,
        "prices": {
          "currency": "USD",
          "minorUnit": 2,
          "priceMinor": "9500",
          "price": "95.00",
          "regularPriceMinor": "9500",
          "regularPrice": "95.00",
          "salePriceMinor": "9500",
          "salePrice": "95.00",
          "minPrice": null,
          "maxPrice": null,
          "minPriceMinor": null,
          "maxPriceMinor": null
        },
        "images": [
          {
            "url": "https://cipherskincare.com/wp-content/uploads/2024/08/stimpack-complete-scalp-serum-variation-100ml.jpg",
            "alt": "Cipher Skincare Complete Scalp Serum, Exfoliating Scalp Treatment"
          },
          {
            "url": "https://cipherskincare.com/wp-content/uploads/2024/04/cipher-skincare-stimpack-complete-scalp-serum-main-hand-shot.jpg",
            "alt": "Cipher Skincare Complete Scalp Serum, Exfoliating Scalp Treatment"
          }
        ]
      }
    ],
    "pageNum": 1,
    "pageSize": 2,
    "total": 14,
    "totalPages": 7,
    "hasMore": true,
    "fetchedAt": "1793089066609",
    "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/products

MCP method

nexscope_woocommerce_products

API key*

JSON payload*

cURL

curl -X POST \
  https://api.nexscope.ai/woocommerce/products \
  -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.