Response

🌳 API Response Structure Overview

Root

├── request_info # Meta information about the request and credit usage

├── request_parameters # Parameters submitted in the request

├── request_metadata # Timing and processing details

├── result # Main response content

│ ├── search_result # Contains product search results

│ │ ├── products[] # Array of product objects

│ │ │ ├── asin

│ │ │ ├── title

│ │ │ ├── image_url

│ │ │ ├── customer_reviews_count

│ │ │ ├── customer_reviews_rating

│ │ │ ├── offer_count

│ │ │ ├── price

│ │ │ ├── dimension_unit / weight_unit

│ │ │ └── ...

│ │ └── total_product_count # Total number of matched products

│ ├── pagination # Details about fetched pages (status and page index)

│ ├── country_code # Amazon marketplace region (e.g., US)

│ └── search_key # Input value used for lookup (keyword, EAN, etc.)

📦 Top-Level Meta Fields (Outside of result)

Contains general metadata about the request, such as status, credits, parameters, and processing information.

📌request_info(object)

Contains meta-information about the API request itself, including its status, error details, and credit usage.

Field
Type
Parent
Description

id

string

request_info

Unique identifier for the request, useful for tracking and logs.

success

boolean

request_info

Indicates if the request was successfully processed.

status_code

integer

request_info

HTTP-like status code of the request (200 = OK).

error_details

array

request_info

Contains error information if any occurred; empty if no errors.

credits_used

integer

request_info

Total credits used by the user up to this request.

credit_used_this_request

integer

request_info

Number of credits consumed by this particular request.

credits_remaining

integer

request_info

Number of credits left after this request.

credits_reset_at

datetime

request_info

Timestamp when the credit count will reset.

📌request_parameters (object)

Field
Type
Parent
Description

output

string

request_parameters

Requested response format (e.g., json).

include_html

boolean

request_parameters

Whether HTML formatting is included in result text.

keyword

string

request_parameters

The keyword used for the search, e.g., product ASIN, UPC, or ISBN.

type

string

request_parameters

The type of operation performed. For Product Lookup, this is "PRODUCT_LOOKUP".

📌request_metadata (object)

Contains timing and processing information about the API request, including creation time, completion time, and total processing duration.

Field
Type
Parent
Description

created_at

datetime

request_metadata

Timestamp when the API request was created.

processed_at

datetime

request_metadata

Timestamp when the request processing was completed.

total_time_taken

float

request_metadata

Total time taken to process the request, in seconds.

📦Core Response Payload – result Section

Contains the main response content of the API request, including product-level data, search results, and pagination information. This section holds the actual data returned by the Product Lookup operation.

📌 search_result (object)

Contains the core search results returned by the Product Lookup operation. It includes an array of product objects and summary information like total product count.

Field
Type
Parent
Description

products

array of objects

search_result

This array holds the actual list of products returned. Each element represents a product with various attributes such as ASIN, title, image URL, dimensions, reviews, and price.

total_product_count

integer

search_result

Total number of products found for the given search query.

📌 products[] (object) Example Attributes

Each product object in the products array can contain multiple fields:

Field
Type
Parent
Description

asin

string

products[]

Amazon Standard Identification Number (ASIN) of the product.

title

string

products[]

The title of the product.

image_url

string

products[]

URL of the product's main image.

thumb_string_url

string

products[]

URL of the product's thumbnail image.

customer_reviews_count

integer

products[]

Total number of customer reviews.

customer_reviews_rating

string

products[]

Average rating in human-readable format (e.g., "4.8 out of 5 stars").

customer_reviews_rating_value

float

products[]

Average rating as a numeric value.

customer_reviews_ratingfull_star_count

integer

products[]

Full star rating count (max 5).

price

float

products[]

Current product price (if available).

link

string

products[]

Direct URL to the product page.

is_my_product

boolean

products[]

Indicates whether the product belongs to the account owner.

offer_count

integer

products[]

Number of offers available for this product.

weight

float

products[]

Product weight.

weight_unit

string

products[]

Unit of weight (e.g., pounds, kg).

weight_unit_string_id

string

products[]

Internal ID for the weight unit.

height

float

products[]

Product height.

width

float

products[]

Product width.

length

float

products[]

Product length.

dimension_unit

string

products[]

Unit of dimensions (e.g., inches, cm).

dimension_unit_string_id

string

products[]

Internal ID for the dimension unit.

gl

string

products[]

Product category or global identifier (e.g., "gl_camera").

country_code

string

products[]

Country code for the product listing (e.g., "US").

📌 pagination (object)

Provides information about the pages returned in the search results, including status codes for each page. Useful for handling multi-page results in the Product Lookup operation.

Field
Type
Parent
Description

pages

array of objects

pagination

Array containing metadata for each page of results. Each object represents a single page.

📌 pages[] (object) Example Attributes

Field
Type
Parent
Description

status_code

integer

pages[]

HTTP-like status code for the page (200 = OK).

page

integer

pages[]

The page number within the search results.

Last updated