For the complete documentation index, see llms.txt. This page is also available as Markdown.

Data Service Response

Overview

This page describes the structure of the data returned by the Data Service when you retrieve a completed query by its id. This is the parsed content you fetch after a bulk job finishes; it is not the webhook payload. The webhook only notifies you that your result IDs are ready.

The outer structure is the same for every operation. Only the content of json_result.result changes, since each operation returns its own kind of Amazon data.

Top-Level Fields

Field
Type
Description

success

boolean

Whether the Data Service request itself succeeded.

data

object

The query record, including its status and the parsed result.

data Object

Echoes back the query as it was submitted and carries the parsed content once processing is complete.

Field
Type
Parent
Description

id

string

data

Unique identifier of the query. This is the id you received in the bulk response.

account_id

number

data

Identifier of the account that submitted the query.

status

string

data

Processing status of the query. See Query Status below.

platform

string

data

The platform the query targets (e.g. AMZ).

operation

string

data

The operation that was executed (e.g. DETAIL, OFFER, SELLER_FEEDBACK).

domain

string

data

Domain of the target marketplace (e.g. .com, .de).

payload

object

data

The original input you submitted for this query (e.g. { "asin": "..." }).

callback_url

string

data

The callback URL submitted with the bulk request.

create_date

string (ISO datetime)

data

When the query was created.

json_result

object

data

The parsed result and its request metadata. Present once processing has finished.

Query Status

The status field tells you whether the result is ready.

Value
Meaning

pending

The query has been accepted and is still being processed. No json_result yet.

success

Processing finished successfully. json_result contains the parsed data.

failure

Processing finished but failed. json_result.result is empty and request_info.error_details explains why.

Check status before reading json_result. A pending query has no result data yet, so retry after a short interval.

A bulk request has a processing timeout of 5 minutes, regardless of how many items it contains. Queries that do not complete within that window end with failure.

Sample Response – pending query
Sample Response – failed query

For a success response, see Example Responses below. The result object there is abbreviated; the operation's own response page lists every field it returns.

json_result Object

Present once the query has finished processing. It holds the parsed data and the technical details of the fetch.

Field
Type
Parent
Description

request_info

object

json_result

Technical details of the fetch, including status, errors, and location.

result

object

json_result

The parsed Amazon data. Its structure depends on the operation.

request_info

Diagnostic information about how the query was fetched and parsed.

Field
Type
Parent
Description

id

string

request_info

Query ID, matching data.id. Useful for tracing and re-fetching.

success

boolean

request_info

Whether the result was fetched and parsed successfully.

status_code

number

request_info

Status code of the fetch. 200 on success. 0 indicates the page could not be fetched or parsed.

error_details

array of objects

request_info

Errors encountered during processing. Empty when the query succeeded.

error_code

number

error_details[]

Numeric code identifying the error (e.g. 5002).

message

string

error_details[]

Description of the error (e.g. "Something Went Wrong.").

address

object

request_info

Location used to localize the request. May be absent for operations that do not use location (e.g. SALES_ANALYSIS_HISTORY).

zipCode

array of strings

request_info > address

Zip code(s) used to localize the request.

city

string | null

request_info > address

Resolved city, when available.

country_code

string | null

request_info > address

Resolved country code, when available.

district

string | null

request_info > address

Resolved district, when available.

result

Contains the parsed Amazon data. The structure of this object is specific to the operation you ran, and matches the result structure returned by the same operation in the Real-Time Integration.

The table below lists the top-level keys of result for each operation. For the full field-by-field breakdown, see the response page of the corresponding operation.

Operation

Top-level keys in result

Full reference

DETAIL

The product object itself (asin, title, brand, buybox_winner, variants, images, videos, specifications, rating_breakdown, top_reviews, customer_say, and more)

OFFER

offer.offer_results[], pagination, product

SEARCH

search_results[], pagination, refinements, related_searches, result_information, delivered_to

SELLER_PROFILE

seller_details, feedback_summary, feedback, ask_a_question, not_match

SELLER_PRODUCTS

seller_products[], pagination, refinements, delivered_to

SELLER_FEEDBACK

seller_feedback[], pagination

PRODUCT_LOOKUP

search_result.products[], country_code

PACKAGE_DIMENSION

package, product, country_code

BEST_SELLERS_RANK

product (including bestseller), country_code

SALES_ANALYSIS_HISTORY

history[], product

Several operations return a pagination object inside result, but its fields differ by operation. For example, SEARCH and SELLER_PRODUCTS return current_page, last_visible_page, and result_count, while SELLER_FEEDBACK returns current_page, has_next_page, and next_page. See the operation's own response page for the exact shape.

Example Responses

The envelope is identical for every operation. The example below shows a DETAIL query, followed by a section showing how result differs per operation. In both cases the result object is abbreviated: only a few representative fields are shown, not the complete field list.

The result object by operation Each snippet below is abbreviated and shows only the top-level shape of result for that operation. The actual response returns many more fields. For the complete field list of any operation, see its response page linked in the table above.

Next Steps

Once you have retrieved a result, store it on your side within the 24-hour availability window. To interpret the contents of result, refer to the response page of the operation you ran. If a query returns failure, check request_info.error_details for the reason before retrying.

Last updated