Zyte Data product list schema v1.0#

Documentation Powered by Redocly

Standard ProductList Schema (1.0)

Standard ProductList Schema used in Zyte offering. Covers the typical set of product list attributes used in common e-commerce data applications.

Standard ProductList Schema v1.0

Responses

Response Schema: application/json
url
required
string (URL)

The main URL of the product listing.
Format:
Required attribute. The URL of the final response, after any redirects.
In case there is no product list data on the page, the returned item still contains "url" field, "metadata" field with a timestamp in "dateDownloaded" and all the other available datapoints.

canonicalUrl
string

The canonical form of the product listing URL, selected by the website.

Array of objects[ items ]

List of product details found on the page.
The order of the products reflects their position on the page.

Array
name
string

The name of the product, as appears on the page (no post-processing).
Format: trimmed.

price
string

The price at which the product is being offered.
The value should be lower than regularPrice.
Format:
- no thousands separator,
- full stop as decimal separator.

regularPrice
string

The price at which the product was being offered and which is presented as a reference to the current price. It may be represented by original price, list price or maximum retail price for which the product is sold. This field is only returned if it is explicitly mentioned in the offer or the product page.
The value should be higher than price.
Format:
- no thousands separator,
- full stop as decimal separator.

currency
string

The currency associated with the price, in ISO 4217 standard (e.g. USD).

currencyRaw
string

The currency associated with the price, as appears on the page (no post-processing).

productId
string

Product identifier, unique across dataset. It may come in the form of an SKU, any other identifier, a hash or even a URL.
Unique across dataset.

object (Image)

The details of the main image of the product.
Data URL is not allowed.

url
required
string (URL)

A URL of an image

url
string (URL)

The main URL of the detailed product page.

object

Contains metadata about the data extraction process.

probability
number [ 0 .. 1 ]

Reflects the probability that extracted data is of a product data type.

Array of objects or objects[ items ]

The list of breadcrumbs with URL and optional category name.
At least one of "name" or "url" is required.
All levels of breadcrumbs should be included (e.g. "Home" or product category, if they are included in the breadcrumbs).

Array
Any of
string

Breadcrumb name or category name.

string (URL)

Breadcrumb link.

object

Details of the next page, if available.

url
string (URL)

The URL of the pagination link

text
string

Text of the pagination link

categoryName
string

Name of the category/page with the product list.
Format: trimmed.

pageNumber
integer

Current page number, if displayed explicitly on the listing page.
Numeration starts with 1.

object

Contains metadata about the data extraction process.

dateDownloaded
string

The timestamp at which the product list data was downloaded.
Timezone: UTC.
Format: ISO 8601 format. YYYY-MM-DDThh:mm:ssZ

Response samples

Content type
application/json
{}