Vizit Public APIAPI
Product Details

Retrieve PDP scores by GTIN

Fetch the current state and scores for a PDP submitted by GTIN.

GET/v1/pdps/gtin/{gtin}

Returns the current scores and processing state for a PDP submitted via Submit a PDP by GTIN. Poll until status moves from processing to scored.

During a rescore the previous scores remain visible alongside status: processing and the prior scored_at timestamp, so clients can keep showing the last known result while a new one is computed.

Authorization

bearerAuth
Authorization<token>

Short-lived access token issued by Create a token. Send it on every request as Authorization: Bearer <token>.

In: header

Path Parameters

gtin*string

GTIN-8, GTIN-12 (UPC-A), GTIN-13 (EAN-13), or GTIN-14

Match^\d{8}$|^\d{12}$|^\d{13}$|^\d{14}$

Response Body

application/json

application/json

curl -X GET "https://ext.vizit.com/v1/pdps/gtin/00012345678905"
{  "gtin": "string",  "external_id": "string",  "pdp_id": "2ed2d86b-85b6-49b8-bfaf-11ce19f11301",  "status": "processing",  "name": "string",  "category": "string",  "pdp_score": 0,  "listing_score_at_ingest": 0,  "score_change": 0,  "conversion_ready": true,  "carousel_score": 0,  "hero": {    "image_id": "84c230fd-5520-4984-8119-37365b66fd80",    "image_url": "string",    "hero_score": 0.1,    "conversion_ready": true,    "score_breakdown": {      "heroism": 0.1,      "category_edge": 0.1,      "technical_integrity": 0.1,      "local_support": 0    },    "hero_gs1_components": {      "property1": 0,      "property2": 0    },    "mobile_readiness": {      "brand_clarity": 0,      "product_type_clarity": 0,      "variant_clarity": 0,      "count_clarity": 0,      "size_clarity": 0,      "mobile_ready": true    },    "classification": "Lifestyle"  },  "carousel_images": [    {      "image_id": "84c230fd-5520-4984-8119-37365b66fd80",      "image_url": "string",      "position": 1,      "vizit_score": 0,      "conversion_ready": true,      "classification": "Lifestyle"    }  ],  "asset_mix": {    "total_images": 0,    "by_classification": {      "Packshot": 1,      "Lifestyle": 2,      "Feature highlight": 1    }  },  "scored_at": "2019-08-24T14:15:22Z"}
Empty
{  "detail": "string",  "status_code": 0,  "error_code": "INVALID_GTIN",  "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",  "extra": {    "failed_urls": [      {        "url": "https://cdn.example.com/broken.jpg",        "reason": "IMAGE_DOWNLOAD_TIMEOUT"      },      {        "url": "https://cdn.example.com/icon.svg",        "reason": "UNSUPPORTED_IMAGE_FORMAT"      }    ]  },  "timestamp": "2019-08-24T14:15:22Z"}

GETList product retailers

Lists the retailer regions you can use to scope product category discovery. Pass a returned retailer's `id` (e.g. `amazon_us`, `walmart_us`) as the `retailer` query parameter on [list product categories](/api/product-details/listProductCategories).

PUTSubmit a PDP by GTIN

Submitting a PDP by GTIN sends its hero and carousel images for scoring. If the submission changes the PDP, it will be processed and the response is 202 with status processing. Use [Retrieve a PDP by GTIN](/api/product-details/getPdpByGtin) to watch the scores come in. If nothing has changed, the PDP won't be processed and the response is 200 with status scored or error. Subsequent submissions are reconciled by filename: a filename already on the PDP is reused (no re-download, no re-score), while a new filename replaces the previous image in that slot. An identical payload is a no-op. Use this endpoint when you can supply your own image URLs (for example, from a PIM). To have Vizit scrape an Amazon listing instead, use [Submit a PDP by ASIN](/api/product-details/upsertPdpByAsin).