Response

The response for the Seller Products operation is designed to provide a transparent view of a seller's product listings and associated data. Every request returns a structured JSON object containing product ASINs, pricing, ratings, and other key product attributes.

API Response Structure Overview

The JSON response is organized into four primary sections:

  1. request_info: Contains the status of the API call, unique request ID, and detailed credit consumption information.

  2. request_parameters: Echoes back the parameters you sent, such as seller ID or URL, to confirm what was processed.

  3. request_metadata: Includes timestamps regarding when the request was created and processed.

  4. result: Contains the core payload with product listings and related data.

These fields provide essential information about the transaction status, parameters, and processing timing.

1. Top Level Meta Fields (Outside of result)

These fields provide essential information about the transaction status, parameters, and processing timing.

request_info (object)

The request_info object provides the technical status of your API call and real-time updates on your credit usage. It is the primary reference for debugging and monitoring your account's consumption limits.

Field
Type
Description

id

String

A unique identifier assigned to this specific request for tracking.

success

Boolean

Indicates if the operation was completed successfully.

status_code

Integer

The standard HTTP response code for the request.

error_details

Array

An array containing error details, if any.

credits_used

Integer

The total amount of credits deducted for this individual request.

credit_used_this_request

Integer

The amount of credits used for this specific request.

credits_remaining

Integer

Your updated total credit balance after the consumption.

credits_reset_at

String

Timestamp indicating when credits will reset.

address

Object

Address information associated with the request.

request_metadata (object)

The request_metadata object captures performance-related metrics and timestamps throughout the lifecycle of the request. These details help you evaluate system latency and data freshness.

Field
Type
Description

created_at

String

The exact timestamp when the request was received.

processed_at

String

The timestamp when the data extraction was completed.

total_time_taken

Float

Duration in seconds to complete the entire operation.

request_parameters (object)

The request_parameters object serves as an echo of the input values you provided in your request. This allows for programmatic verification that the correct parameters were used to generate the response.

Field
Type
Description

output

String

The output format (e.g., json).

language

String

The language code used for the marketplace request.

include_html

Boolean

Indicates whether HTML content was included.

seller_id

String

The unique ID of the target seller processed by the system.

type

String

The operation type, set to SELLER_PRODUCTS.

2. Core Payload (Inside result)

The result object contains the specific product data retrieved from the marketplace.

seller_products (array)

An array of the seller's product listings.

Field
Type
Description

asin

String

The Amazon Standard Identification Number for the product.

brand

String

The brand of the product.

categories

Array

The categories the product belongs to.

color_options

Object

Color options available for the product and their total count.

image

String

The URL of the product's main image.

is_prime

Boolean

Indicates if the product is eligible for Amazon Prime.

is_sponsored

Boolean

Indicates if the product is sponsored.

link

String

The direct link to the product on Amazon.

position

Integer

The position of the product in the search results.

price

Object

Pricing information for the product (currency, raw value, symbol, value).

prices

Array

Different pricing options for the product.

product_type

String

The type of the product.

rating

String

The average star rating of the product.

rating_text

String

The rating text (e.g., "4.5 out of 5 stars").

ratings_total

Integer

The total number of ratings the product has received.

shipping_details

String

Shipping details for the product.

title

String

The title of the product.

availability

Object

The availability status of the product.

quantity

Object

The available quantity of the product.

refinements (object)

Options available to filter search results.

Field
Type
Description

availability

Array

Filtering options for product availability.

condition

Array

Filtering options for product condition.

customer_reviews

Array

Filtering options based on customer reviews.

delivery_day

Array

Filtering options for delivery day.

department

Array

Filtering options by department.

eligible_for_free_shipping

Array

Filtering options for free shipping eligibility.

international_shipping

Array

Filtering options for international shipping.

pagination (array)

Field
Type
Description

current_page

Integer

The current page number.

current_page_link

String

The link to the current page.

next_page_link

String

The link to the next page.

result_count

Integer

The number of results on the current page.

not_match

Array

Items that did not match the criteria.

Sample JSON Output

Last updated