product

Version 2024-11-01

📘

Important

The Buy with Prime API is offered as a preview and might change as we receive feedback and iterate on the interfaces. We are sharing this early documentation to help you learn about the Buy with Prime API as we write and iterate on the content.

Overview

Returns a product

ℹī¸

Required scope(s)

View & Edit Catalog Data

Response

Return type Product

Arguments

ArgumentDescription
identifier (ProductIdentifierInput)

Product identifiers to locate a product.

Examples


Query By Sku

Request

query product { product(identifier: { sku: "example-sku" }) { id externalId { value } sku { value } amazonSku { value } offerPrime productDetailPageUrl image { displayReadyUrl sourceUrl } } }

Response

{ "data": { "product": { "id": "abcdef01234567", "externalId": { "value": "example-external-id" }, "sku": { "value": "example-sku" }, "amazonSku": { "value": "example-amazon-sku" }, "offerPrime": true, "productDetailPageUrl": "example.com", "image": { "displayReadyUrl": "example.com/display-ready-product-image.jpeg", "sourceUrl": "example.com/product-image.jpeg" } } } }

Query By Amazon Sku

Request

query product { product(identifier: { amazonSku: { value: "example-amazon-sku" } }) { id externalId { value } sku { value } amazonSku { value } offerPrime productDetailPageUrl image { displayReadyUrl sourceUrl } } }

Response

{ "data": { "product": { "id": "abcdef01234567", "externalId": { "value": "example-external-id" }, "sku": { "value": "example-sku" }, "amazonSku": { "value": "example-amazon-sku" }, "offerPrime": true, "productDetailPageUrl": "example.com", "image": { "displayReadyUrl": "example.com/display-ready-product-image.jpeg", "sourceUrl": "example.com/product-image.jpeg" } } } }

Query By External Id

Request

query product { product(identifier: { externalId: "example-external-id" }) { id externalId { value } sku { value } amazonSku { value } offerPrime productDetailPageUrl image { displayReadyUrl sourceUrl } } }

Response

{ "data": { "product": { "id": "abcdef01234567", "externalId": { "value": "example-external-id" }, "sku": { "value": "example-sku" }, "amazonSku": { "value": "example-amazon-sku" }, "offerPrime": true, "productDetailPageUrl": "example.com", "image": { "displayReadyUrl": "example.com/display-ready-product-image.jpeg", "sourceUrl": "example.com/product-image.jpeg" } } } }

Query By Product Id

Request

query product { product(identifier: { productId: "abcdef01234567" }) { id externalId { value } sku { value } amazonSku { value } offerPrime productDetailPageUrl image { displayReadyUrl sourceUrl } } }

Response

{ "data": { "product": { "id": "abcdef01234567", "externalId": { "value": "example-external-id" }, "sku": { "value": "example-sku" }, "amazonSku": { "value": "example-amazon-sku" }, "offerPrime": true, "productDetailPageUrl": "example.com", "image": { "displayReadyUrl": "example.com/display-ready-product-image.jpeg", "sourceUrl": "example.com/product-image.jpeg" } } } }


Did this page help you?