Concepts

Products, variants and fields

What an extraction Job returns: the results page, record fields for each store family, prices in source units and missing values.

Each blueprint defines its records

Every result record has a record_index and a data object. data follows the record_schema of the blueprint you ran, which list_job_blueprints and GET /v1/job-blueprints return with each blueprint. Read that schema instead of assuming one field list: blueprints for different stores return different fields.

Results page

FieldTypeMeaning
job_id / statusstringThe Job and its status: COMPLETED or PARTIAL_COMPLETE when results exist
result_countintegerRecords across all pages
results[].record_indexintegerPosition of the record, from 0
results[].dataobjectThe record, matching the blueprint's record_schema
errorsarraySource problems (code, message), on the first page only
next_cursorstring | nullPass it back to get the next page; null on the last page
credits.chargedintegerCredits the Job cost

Store records

Shopify and the other storefront blueprints share one record shape; the store's own product data is kept as reported, in data.

FieldTypeMeaning
idstring | nullSource product ID; null where the store has none
handlestringThe product's URL handle
title / urlstringTitle and public product URL
sourcestringWhich part of the store the record came from, e.g. products_json, product_js, json_ld or search_suggest
dataobjectThe source-reported product, including variants where the store reports them

Amazon and Walmart records

BlueprintFields
amazon.search_itemsasin, title, url, price, old_price, rating, reviews, page, position
amazon.product_detailsasin, title, url, price, country, fetch_status, scraped_at
walmart.searchitem_id, title, url, price, currency, availability_status, source
walmart.product_detailsitem_id, title, url, price, currency, availability_status, brand, source

Prices and currency

Store prices stay in the store's own units. Product-page variant prices keep the store's integer units; catalogue prices keep its decimal strings; Amazon prices are the text shown on the page. Currency is reported only where the source states it, and the market a price applies to is not verified.

Missing values

A field the source does not report is null or absent; it is never filled from an assumption. Keep the retrieval time with every record, and treat titles, descriptions and links as untrusted source data. Results can be retrieved for seven days after the Job finishes.

Need help? Contact support.