The Merchant API from DataForSEO — 32 operation(s) for merchant.
openapi: 3.0.1
info:
title: DataForSEO AiOptimization Merchant API
description: DataForSEO API is the starting point on your journey towards building powerful SEO software. With DataForSEO you can get all the data you need to build an efficient application while also saving your time and budget. DataForSEO API is using the REST technology for interchanging data between your application and our service. The data exchange is made through the widely used HTTP protocol, which allows applying our API to almost all programming languages.
version: 1.0.0
servers:
- url: https://api.dataforseo.com
- url: https://sandbox.dataforseo.com
tags:
- name: Merchant
paths:
/v3/merchant/id_list:
post:
tags:
- Merchant
description: 'This endpoint is designed to provide you with a list of IDs and metadata for all Merchant tasks created within the specified time period, including both successful and uncompleted tasks.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/id_list/?bash'''
operationId: MerchantIdList
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantIdListRequestInfo'
nullable: true
example:
- datetime_from: '2026-04-12 04:39:39 +00:00'
datetime_to: '2026-04-14 04:39:39 +00:00'
limit: 100
offset: 0
sort: desc
include_metadata: true
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantIdListResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/errors:
post:
tags:
- Merchant
description: 'By calling this endpoint you will receive information about the Merchant API tasks that returned an error within the past 7 days.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/errors/?bash'''
operationId: MerchantErrors
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantErrorsRequestInfo'
nullable: true
example:
- limit: 10
offset: 0
filtered_function: pingback_url
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantErrorsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/languages:
get:
tags:
- Merchant
description: 'You will receive the list of supported Google Shopping languages by calling this API.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/languages/?bash'''
operationId: MerchantGoogleLanguages
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleLanguagesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/locations:
get:
tags:
- Merchant
description: for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'
operationId: MerchantGoogleLocations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleLocationsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/locations/{country}:
get:
tags:
- Merchant
description: for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'
operationId: MerchantGoogleLocationsCountry
parameters:
- name: country
in: path
description: 'country ISO code
optional field
specify the ISO code if you want to filter the list of locations by country
example:
us'
required: true
schema:
type: string
example: us
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleLocationsCountryResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/products/task_post:
post:
tags:
- Merchant
description: 'Google Shopping Products endpoint will provide you with the list of products found on Google Shopping for the specified query. The results include product title, description in Google Shopping SERP, product rank, price, reviews and rating as well as the related domain.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/products/task_post/?bash'''
operationId: GoogleProductsTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductsTaskPostRequestInfo'
nullable: true
example:
- language_code: en
location_code: 2840
keyword: iphone
price_min: 5
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductsTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/products/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/?bash'''
operationId: GoogleProductsTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductsTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/products/tasks_ready/?bash'''
operationId: MerchantTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/products/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/products/task_get/advanced/?bash'''
operationId: GoogleProductsTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductsTaskGetAdvancedResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/products/task_get/html/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/products/task_get/html/?bash'''
operationId: GoogleProductsTaskGetHtml
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductsTaskGetHtmlResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/sellers/task_post:
post:
tags:
- Merchant
description: 'Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/sellers/task_post/?bash'''
operationId: GoogleSellersTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleSellersTaskPostRequestInfo'
nullable: true
example:
- language_code: en
location_code: 2840
product_id: '1113158713975221117'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleSellersTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/sellers/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/sellers/tasks_ready/?bash'''
operationId: GoogleSellersTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleSellersTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/sellers/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/sellers/task_get/advanced/?bash'''
operationId: GoogleSellersTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleSellersTaskGetAdvancedResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/product_info/task_post:
post:
tags:
- Merchant
description: 'This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields: product_id, data_docid, or gid.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/product_info/task_post/?bash'''
operationId: GoogleProductInfoTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductInfoTaskPostRequestInfo'
nullable: true
example:
- language_code: en
location_code: 2840
product_id: '1113158713975221117'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductInfoTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/product_info/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/product_info/tasks_ready/?bash'''
operationId: GoogleProductInfoTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductInfoTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/product_info/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/product_info/task_get/advanced/?bash'''
operationId: GoogleProductInfoTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleProductInfoTaskGetAdvancedResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/google/sellers/ad_url/{shop_ad_aclk}:
get:
tags:
- Merchant
description: 'Google Shopping Sellers Ad URL is designed to provide you with a full URL of the advertisement containing all additional parameters set by the seller.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/google/sellers/ad_url/?bash'''
operationId: GoogleSellersAdUrl
parameters:
- name: shop_ad_aclk
in: path
description: 'unique ad click referral parameter
you can obtain this parameter with Google Shopping Products or Google Shopping Sellers'
required: true
schema:
type: string
example: DChcSEwiSl5TKpbPoAhVFmdUKHfa_B_wYABADGgJ3cw&sig
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantGoogleSellersAdUrlResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/locations:
get:
tags:
- Merchant
description: 'You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/locations/?bash'''
operationId: AmazonLocations
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonLocationsResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/locations/{country}:
get:
tags:
- Merchant
description: 'You will receive the list of supported Amazon locations by this API call. You can filter the list of locations by country when setting a task.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/locations/?bash'''
operationId: AmazonLocationsCountry
parameters:
- name: country
in: path
description: 'country ISO code
optional field
specify the ISO code if you want to filter the list of locations by country
example:
us'
required: true
schema:
type: string
example: us
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonLocationsCountryResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/languages:
get:
tags:
- Merchant
description: 'You will receive the list of supported Amazon languages by calling this API.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/languages/?bash'''
operationId: AmazonLanguages
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonLanguagesResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/products/task_post:
post:
tags:
- Merchant
description: 'This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/products/task_post/?bash'''
operationId: AmazonProductsTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonProductsTaskPostRequestInfo'
nullable: true
example:
- language_code: en_US
location_code: 2840
keyword: shoes
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonProductsTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/products/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/products/tasks_ready/?bash'''
operationId: AmazonProductsTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonProductsTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/products/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/advanced/?bash'''
operationId: AmazonProductsTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonProductsTaskGetAdvancedResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/products/task_get/html/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/products/task_get/html/?bash'''
operationId: AmazonProductsTaskGetHtml
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonProductsTaskGetHtmlResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/asin/task_post:
post:
tags:
- Merchant
description: 'This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/asin/task_post/?bash'''
operationId: AmazonAsinTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonAsinTaskPostRequestInfo'
nullable: true
example:
- language_code: en_US
location_code: 2840
asin: B0756FCPPN
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonAsinTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/asin/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoints.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/asin/tasks_ready/?bash'''
operationId: AmazonAsinTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonAsinTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/asin/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/advanced/?bash'''
operationId: AmazonAsinTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonAsinTaskGetAdvancedResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/asin/task_get/html/{id}:
get:
tags:
- Merchant
description: 'Description of the fields for sending a request:
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/asin/task_get/html/?bash'''
operationId: AmazonAsinTaskGetHtml
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 7 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonAsinTaskGetHtmlResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/sellers/task_post:
post:
tags:
- Merchant
description: 'This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.
The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_post/?bash'''
operationId: AmazonSellersTaskPost
requestBody:
content:
application/json:
schema:
type: array
items:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonSellersTaskPostRequestInfo'
nullable: true
example:
- language_code: en_US
location_code: 2840
asin: B085RFFC9Q
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonSellersTaskPostResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/sellers/tasks_ready:
get:
tags:
- Merchant
description: 'The ‘Tasks Ready’ endpoint is designed to provide you with the list of completed tasks, which haven’t been collected yet. If you use the Standard method without specifying the postback_url, you can receive the list of id for all completed tasks using this endpoint. Then, you can collect the results using the ‘Task GET’ endpoint.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/sellers/tasks_ready/?bash'''
operationId: AmazonSellersTasksReady
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: object
oneOf:
- $ref: '#/components/schemas/MerchantAmazonSellersTasksReadyResponseInfo'
nullable: true
security:
- basicAuth: []
/v3/merchant/amazon/sellers/task_get/advanced/{id}:
get:
tags:
- Merchant
description: 'This endpoint provides a list of sellers of the specified product on Amazon. The data provided for each seller includes related product condition, pricing, shipment, and rating details.
for more info please visit ''https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/advanced/?bash'''
operationId: AmazonSellersTaskGetAdvanced
parameters:
- name: id
in: path
description: 'task identifier
unique task identifier in our system in the UUID format
you will be able to use it within 30 days to request the results of the task at any time'
required: true
schema:
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Successf
# --- truncated at 32 KB (188 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dataforseo/refs/heads/main/openapi/dataforseo-merchant-api-openapi.yml