Check Product and Offer structured data

Embed
Preview of the card
<a href="https://seolyticize.com/docs/ref-validate-product-schema"><img src="https://seolyticize.com/docs/_api/public/orgs/71cb2b7a-a719-4003-b3ea-6321dc1db8ab/spaces/3bf2dbf7-3faa-473c-ba3b-30588f5f8de4/pages/35c62405-06f0-4a5a-9aff-25df5bfe5a93/social-card.svg?v=3e7ae33eec8b" alt="Check Product and Offer structured data" width="600" height="315"></a>
POSThttps://seolyticize.com/api/v1/tools/validate_product_schema

Reads product pages and checks their Product and Offer JSON-LD against what Google's merchant listings need — errors: name, image, offers as Offer (not AggregateOffer) with a price above 0 and an ISO 4217 priceCurrency (or a priceSpecification), a valid availability; warnings: brand (its name not empty or N/A), a GTIN or MPN or SKU, description, offers.url, itemCondition, priceValidUntil when it has passed, validFrom without an end date, shipping details with shippingDestination and deliveryTime, a return policy with applicableCountry and returnPolicyCategory, a rating with ratingValue and reviewCount, hasAdultConsideration values, a ProductGroup's productGroupID, variesBy and hasVariant, and with eu: true the energy efficiency class; notes: returnPolicyCountry, member programs, variants — says whether each page is eligible, and gives a completenessScore (required fields 50, aggregateRating 65, an identifier 75, shippingDetails 85, a return policy 90, three or more reviews 100). With no urls, the latest crawl's pages that carry Product markup (up to limit). render 'auto' renders a page in a browser when its HTML carries no Product markup, for stores that inject their JSON-LD with JavaScript. Answers 'is our product schema right' and 'why don't our products show prices in Google'. Free.

Parameters

Idempotency-Keystringheader
Any unique string, up to 200 characters. A retry with the same key and body is answered from the first answer (Idempotent-Replayed: true) for a day, so it never buys or writes twice; the same key with another body is refused.

Request body

application/json
clientIdstringrequired
urlsstring[]
= []
limitinteger
= 10
euboolean
Sold in the EU: require the energy efficiency class EPREL asks for.
= false
renderstring
off | auto = auto
{
  "clientId": "string",
  "urls": [],
  "limit": 10,
  "eu": false,
  "render": "auto"
}

Code samples

cURL
curl -X POST "https://seolyticize.com/api/v1/tools/validate_product_schema" \
  -H "Authorization: Bearer $SEOLYTICIZE_API_KEY" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","urls":[],"limit":10,"eu":false,"render":"auto"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 The tool's result under data, and its meta.
Example
{
  "data": {},
  "meta": {
    "requestId": "string",
    "costMicros": 0,
    "cached": true,
    "cachedFrom": "string",
    "dataAsOf": "string",
    "sources": [
      "string"
    ],
    "partial": true,
    "next": [
      {
        "tool": "string",
        "args": {},
        "why": "string"
      }
    ],
    "nextCursor": "string",
    "dryRun": true
  }
}
Schema
datarequired
metaobjectrequired
Beside every answer: what it cost, whether it came from cache, how fresh it is, whether it is complete, and what to call next.
Show child parameters
requestIdstringrequired
costMicrosintegerrequired
Charged by this call, micro-USD (1,000,000 = $1).
cachedbooleanrequired
True when nothing was bought.
cachedFromstring
When the oldest cached answer used was bought.
dataAsOfstring
sourcesstring[]
partialbooleanrequired
True when the data is incomplete: a running crawl, unfinished days, unread pages.
nextobject[]required
Show child parameters
toolstring
argsobject
whystring
nextCursorstring
Pass as cursor for the next page.
dryRunboolean
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
X-Request-Idstring
The id to quote about this request.
400 The body was not JSON or did not match the tool's input schema.
Example
{
  "error": "string",
  "code": "string",
  "next": "string",
  "requestId": "string"
}
Schema
errorstringrequired
A sentence written for the caller. Internal failures are reduced to 'The request could not be completed.' and never carry detail.
codestring
A stable snake_case reason to branch on; GET /api/v1/errors lists them all.
nextstring
The call or step that fixes it, when there is one.
requestIdstring
Quote it when asking about a failure.
Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
401 No key, or a key that is unknown or revoked.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
WWW-Authenticatestring
403 The key's role does not permit the tool, or the key may not reach the named client.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
404 No tool by that name.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
409 A request with this Idempotency-Key is still running.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
422 A well-formed request the product declined, with the reason — a duplicate name, a plan limit, nothing configured to run.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
429 This key has used its window.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Retry-Afterinteger
Seconds to wait before retrying.
500 The request could not be completed.

Same as 400 · POST /api/v1/tools/validate_product_schema

Headers
X-RateLimit-Limitinteger
Requests this key may make per window.
X-RateLimit-Remaininginteger
Requests left in the current window.
X-RateLimit-Resetinteger
Seconds until the current window resets.
Updated