MerchantApi.md

dataforseo_client.MerchantApi

All URIs are relative to https://api.dataforseo.com

Method	HTTP request	Description
amazon_asin_task_get_advanced	GET /v3/merchant/amazon/asin/task_get/advanced/{id}
amazon_asin_task_get_html	GET /v3/merchant/amazon/asin/task_get/html/{id}
amazon_asin_task_post	POST /v3/merchant/amazon/asin/task_post
amazon_asin_tasks_ready	GET /v3/merchant/amazon/asin/tasks_ready
amazon_products_task_get_advanced	GET /v3/merchant/amazon/products/task_get/advanced/{id}
amazon_products_task_get_html	GET /v3/merchant/amazon/products/task_get/html/{id}
amazon_products_task_post	POST /v3/merchant/amazon/products/task_post
amazon_products_tasks_ready	GET /v3/merchant/amazon/products/tasks_ready
amazon_reviews_task_get_advanced	GET /v3/merchant/amazon/reviews/task_get/advanced/{id}
amazon_reviews_task_get_html	GET /v3/merchant/amazon/reviews/task_get/html/{id}
amazon_reviews_task_post	POST /v3/merchant/amazon/reviews/task_post
amazon_reviews_tasks_ready	GET /v3/merchant/amazon/reviews/tasks_ready
amazon_sellers_task_get_advanced	GET /v3/merchant/amazon/sellers/task_get/advanced/{id}
amazon_sellers_task_get_html	GET /v3/merchant/amazon/sellers/task_get/html/{id}
amazon_sellers_task_post	POST /v3/merchant/amazon/sellers/task_post
amazon_sellers_tasks_ready	GET /v3/merchant/amazon/sellers/tasks_ready
google_product_info_task_get_advanced	GET /v3/merchant/google/product_info/task_get/advanced/{id}
google_product_info_task_post	POST /v3/merchant/google/product_info/task_post
google_product_info_tasks_ready	GET /v3/merchant/google/product_info/tasks_ready
google_product_spec_task_get_advanced	GET /v3/merchant/google/product_spec/task_get/advanced/{id}
google_product_spec_task_get_html	GET /v3/merchant/google/product_spec/task_get/html/{id}
google_product_spec_task_post	POST /v3/merchant/google/product_spec/task_post
google_product_spec_tasks_ready	GET /v3/merchant/google/product_spec/tasks_ready
google_products_task_get_advanced	GET /v3/merchant/google/products/task_get/advanced/{id}
google_products_task_get_html	GET /v3/merchant/google/products/task_get/html/{id}
google_products_task_post	POST /v3/merchant/google/products/task_post
google_products_tasks_ready	GET /v3/merchant/google/products/tasks_ready
google_sellers_ad_url	GET /v3/merchant/google/sellers/ad_url/{shop_ad_aclk}
google_sellers_task_get_advanced	GET /v3/merchant/google/sellers/task_get/advanced/{id}
google_sellers_task_get_html	GET /v3/merchant/google/sellers/task_get/html/{id}
google_sellers_task_post	POST /v3/merchant/google/sellers/task_post
google_sellers_tasks_ready	GET /v3/merchant/google/sellers/tasks_ready
merchant_amazon_languages	GET /v3/merchant/amazon/languages
merchant_amazon_locations	GET /v3/merchant/amazon/locations
merchant_amazon_locations_country	GET /v3/merchant/amazon/locations/{country}
merchant_errors	POST /v3/merchant/errors
merchant_google_languages	GET /v3/merchant/google/languages
merchant_google_locations	GET /v3/merchant/google/locations
merchant_google_locations_country	GET /v3/merchant/google/locations/{country}
merchant_id_list	POST /v3/merchant/id_list
merchant_tasks_ready	GET /v3/merchant/tasks_ready

amazon_asin_task_get_advanced

MerchantAmazonAsinTaskGetAdvancedResponseInfo amazon_asin_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_asin_task_get_advanced_response_info import MerchantAmazonAsinTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.amazon_asin_task_get_advanced(id)
        print("The response of MerchantApi->amazon_asin_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_asin_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonAsinTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_asin_task_get_html

MerchantAmazonAsinTaskGetHtmlResponseInfo amazon_asin_task_get_html(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_asin_task_get_html_response_info import MerchantAmazonAsinTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '05b22c4c-fe30-47a2-b368-98509992dc13' # str | 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

    try:
        api_response = api_instance.amazon_asin_task_get_html(id)
        print("The response of MerchantApi->amazon_asin_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_asin_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonAsinTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_asin_task_post

MerchantAmazonAsinTaskPostResponseInfo amazon_asin_task_post(merchant_amazon_asin_task_post_request_info=merchant_amazon_asin_task_post_request_info)

‌‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_asin_task_post_request_info import MerchantAmazonAsinTaskPostRequestInfo
from dataforseo_client.models.merchant_amazon_asin_task_post_response_info import MerchantAmazonAsinTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_amazon_asin_task_post_request_info = [dataforseo_client.MerchantAmazonAsinTaskPostRequestInfo()] # List[MerchantAmazonAsinTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.amazon_asin_task_post(merchant_amazon_asin_task_post_request_info=merchant_amazon_asin_task_post_request_info)
        print("The response of MerchantApi->amazon_asin_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_asin_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_amazon_asin_task_post_request_info	List[MerchantAmazonAsinTaskPostRequestInfo]		[optional]

Return type

MerchantAmazonAsinTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_asin_tasks_ready

MerchantAmazonAsinTasksReadyResponseInfo amazon_asin_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_asin_tasks_ready_response_info import MerchantAmazonAsinTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.amazon_asin_tasks_ready()
        print("The response of MerchantApi->amazon_asin_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_asin_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonAsinTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_products_task_get_advanced

MerchantAmazonProductsTaskGetAdvancedResponseInfo amazon_products_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_products_task_get_advanced_response_info import MerchantAmazonProductsTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.amazon_products_task_get_advanced(id)
        print("The response of MerchantApi->amazon_products_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_products_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonProductsTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_products_task_get_html

MerchantAmazonProductsTaskGetHtmlResponseInfo amazon_products_task_get_html(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_products_task_get_html_response_info import MerchantAmazonProductsTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '025cc326-2d4e-4080-89ac-06326a29ae91' # str | 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

    try:
        api_response = api_instance.amazon_products_task_get_html(id)
        print("The response of MerchantApi->amazon_products_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_products_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonProductsTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_products_task_post

MerchantAmazonProductsTaskPostResponseInfo amazon_products_task_post(merchant_amazon_products_task_post_request_info=merchant_amazon_products_task_post_request_info)

‌‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_products_task_post_request_info import MerchantAmazonProductsTaskPostRequestInfo
from dataforseo_client.models.merchant_amazon_products_task_post_response_info import MerchantAmazonProductsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_amazon_products_task_post_request_info = [dataforseo_client.MerchantAmazonProductsTaskPostRequestInfo()] # List[MerchantAmazonProductsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.amazon_products_task_post(merchant_amazon_products_task_post_request_info=merchant_amazon_products_task_post_request_info)
        print("The response of MerchantApi->amazon_products_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_products_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_amazon_products_task_post_request_info	List[MerchantAmazonProductsTaskPostRequestInfo]		[optional]

Return type

MerchantAmazonProductsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_products_tasks_ready

MerchantAmazonProductsTasksReadyResponseInfo amazon_products_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_products_tasks_ready_response_info import MerchantAmazonProductsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.amazon_products_tasks_ready()
        print("The response of MerchantApi->amazon_products_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_products_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonProductsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_reviews_task_get_advanced

MerchantAmazonReviewsTaskGetAdvancedResponseInfo amazon_reviews_task_get_advanced(id)

This endpoint provides feedback data on products listed on the Amazon marketplace, including their titles, images, ratings, review content, user profile info, review publication dates, and more. The results are specific to the asin specified in the POST request. for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/reviews/task_get/advanced/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_reviews_task_get_advanced_response_info import MerchantAmazonReviewsTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.amazon_reviews_task_get_advanced(id)
        print("The response of MerchantApi->amazon_reviews_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_reviews_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonReviewsTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_reviews_task_get_html

MerchantAmazonReviewsTaskGetHtmlResponseInfo amazon_reviews_task_get_html(id)

Description of the fields for sending a request: for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/reviews/task_get/html/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_reviews_task_get_html_response_info import MerchantAmazonReviewsTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = 'c7aa69bc-c350-4802-bf52-d7c763faa79a' # str | 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

    try:
        api_response = api_instance.amazon_reviews_task_get_html(id)
        print("The response of MerchantApi->amazon_reviews_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_reviews_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonReviewsTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_reviews_task_post

MerchantAmazonReviewsTaskPostResponseInfo amazon_reviews_task_post(merchant_amazon_reviews_task_post_request_info=merchant_amazon_reviews_task_post_request_info)

‌‌ for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/reviews/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_reviews_task_post_request_info import MerchantAmazonReviewsTaskPostRequestInfo
from dataforseo_client.models.merchant_amazon_reviews_task_post_response_info import MerchantAmazonReviewsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_amazon_reviews_task_post_request_info = [dataforseo_client.MerchantAmazonReviewsTaskPostRequestInfo()] # List[MerchantAmazonReviewsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.amazon_reviews_task_post(merchant_amazon_reviews_task_post_request_info=merchant_amazon_reviews_task_post_request_info)
        print("The response of MerchantApi->amazon_reviews_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_reviews_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_amazon_reviews_task_post_request_info	List[MerchantAmazonReviewsTaskPostRequestInfo]		[optional]

Return type

MerchantAmazonReviewsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_reviews_tasks_ready

MerchantAmazonReviewsTasksReadyResponseInfo amazon_reviews_tasks_ready()

‌ The ‘Tasks Ready’ endpoint is designed to provide you with a list of completed tasks that 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/reviews/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_reviews_tasks_ready_response_info import MerchantAmazonReviewsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.amazon_reviews_tasks_ready()
        print("The response of MerchantApi->amazon_reviews_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_reviews_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonReviewsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_sellers_task_get_advanced

MerchantAmazonSellersTaskGetAdvancedResponseInfo amazon_sellers_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_sellers_task_get_advanced_response_info import MerchantAmazonSellersTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.amazon_sellers_task_get_advanced(id)
        print("The response of MerchantApi->amazon_sellers_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_sellers_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonSellersTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_sellers_task_get_html

MerchantAmazonSellersTaskGetHtmlResponseInfo amazon_sellers_task_get_html(id)

Description of the fields for sending a request: for more info please visit 'https://docs.dataforseo.com/v3/merchant/amazon/sellers/task_get/html/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_sellers_task_get_html_response_info import MerchantAmazonSellersTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = 'dc1124ba-3204-4659-8089-5318288cb427' # str | 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

    try:
        api_response = api_instance.amazon_sellers_task_get_html(id)
        print("The response of MerchantApi->amazon_sellers_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_sellers_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantAmazonSellersTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_sellers_task_post

MerchantAmazonSellersTaskPostResponseInfo amazon_sellers_task_post(merchant_amazon_sellers_task_post_request_info=merchant_amazon_sellers_task_post_request_info)

‌‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_sellers_task_post_request_info import MerchantAmazonSellersTaskPostRequestInfo
from dataforseo_client.models.merchant_amazon_sellers_task_post_response_info import MerchantAmazonSellersTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_amazon_sellers_task_post_request_info = [dataforseo_client.MerchantAmazonSellersTaskPostRequestInfo()] # List[MerchantAmazonSellersTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.amazon_sellers_task_post(merchant_amazon_sellers_task_post_request_info=merchant_amazon_sellers_task_post_request_info)
        print("The response of MerchantApi->amazon_sellers_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_sellers_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_amazon_sellers_task_post_request_info	List[MerchantAmazonSellersTaskPostRequestInfo]		[optional]

Return type

MerchantAmazonSellersTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

amazon_sellers_tasks_ready

MerchantAmazonSellersTasksReadyResponseInfo amazon_sellers_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_sellers_tasks_ready_response_info import MerchantAmazonSellersTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.amazon_sellers_tasks_ready()
        print("The response of MerchantApi->amazon_sellers_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->amazon_sellers_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonSellersTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_info_task_get_advanced

MerchantGoogleProductInfoTaskGetAdvancedResponseInfo google_product_info_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_info_task_get_advanced_response_info import MerchantGoogleProductInfoTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.google_product_info_task_get_advanced(id)
        print("The response of MerchantApi->google_product_info_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_info_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleProductInfoTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_info_task_post

MerchantGoogleProductInfoTaskPostResponseInfo google_product_info_task_post(merchant_google_product_info_task_post_request_info=merchant_google_product_info_task_post_request_info)

‌‌ This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, and sellers. In order to set a task, you have to specify the product_id. for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_info/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_info_task_post_request_info import MerchantGoogleProductInfoTaskPostRequestInfo
from dataforseo_client.models.merchant_google_product_info_task_post_response_info import MerchantGoogleProductInfoTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_google_product_info_task_post_request_info = [dataforseo_client.MerchantGoogleProductInfoTaskPostRequestInfo()] # List[MerchantGoogleProductInfoTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_product_info_task_post(merchant_google_product_info_task_post_request_info=merchant_google_product_info_task_post_request_info)
        print("The response of MerchantApi->google_product_info_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_info_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_google_product_info_task_post_request_info	List[MerchantGoogleProductInfoTaskPostRequestInfo]		[optional]

Return type

MerchantGoogleProductInfoTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_info_tasks_ready

MerchantGoogleProductInfoTasksReadyResponseInfo google_product_info_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_info_tasks_ready_response_info import MerchantGoogleProductInfoTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.google_product_info_tasks_ready()
        print("The response of MerchantApi->google_product_info_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_info_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleProductInfoTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_spec_task_get_advanced

MerchantGoogleProductSpecTaskGetAdvancedResponseInfo google_product_spec_task_get_advanced(id)

Description of the fields for sending a request: for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_spec/task_get/advanced/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_spec_task_get_advanced_response_info import MerchantGoogleProductSpecTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.google_product_spec_task_get_advanced(id)
        print("The response of MerchantApi->google_product_spec_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_spec_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleProductSpecTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_spec_task_get_html

MerchantGoogleProductSpecTaskGetHtmlResponseInfo google_product_spec_task_get_html(id)

Description of the fields for sending a request: for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_spec/task_get/html/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_spec_task_get_html_response_info import MerchantGoogleProductSpecTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '0aea0dad-7969-4196-8b2f-5feb12f62537' # str | 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

    try:
        api_response = api_instance.google_product_spec_task_get_html(id)
        print("The response of MerchantApi->google_product_spec_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_spec_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleProductSpecTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_spec_task_post

MerchantGoogleProductSpecTaskPostResponseInfo google_product_spec_task_post(merchant_google_product_spec_task_post_request_info=merchant_google_product_spec_task_post_request_info)

‌‌ This endpoint provides product data from Google Shopping based on the specified product_id. You will get a full detailed product description as it is given on the Google Shopping product specification page. Product data can include parameters of the product, brand name, part numbers, GTIN, etc. for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/product_spec/task_post/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_spec_task_post_request_info import MerchantGoogleProductSpecTaskPostRequestInfo
from dataforseo_client.models.merchant_google_product_spec_task_post_response_info import MerchantGoogleProductSpecTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_google_product_spec_task_post_request_info = [dataforseo_client.MerchantGoogleProductSpecTaskPostRequestInfo()] # List[MerchantGoogleProductSpecTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_product_spec_task_post(merchant_google_product_spec_task_post_request_info=merchant_google_product_spec_task_post_request_info)
        print("The response of MerchantApi->google_product_spec_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_spec_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_google_product_spec_task_post_request_info	List[MerchantGoogleProductSpecTaskPostRequestInfo]		[optional]

Return type

MerchantGoogleProductSpecTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_product_spec_tasks_ready

MerchantGoogleProductSpecTasksReadyResponseInfo google_product_spec_tasks_ready()

‌ 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_spec/tasks_ready/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_product_spec_tasks_ready_response_info import MerchantGoogleProductSpecTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.google_product_spec_tasks_ready()
        print("The response of MerchantApi->google_product_spec_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_product_spec_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleProductSpecTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_products_task_get_advanced

MerchantGoogleProductsTaskGetAdvancedResponseInfo google_products_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_products_task_get_advanced_response_info import MerchantGoogleProductsTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.google_products_task_get_advanced(id)
        print("The response of MerchantApi->google_products_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_products_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleProductsTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_products_task_get_html

MerchantGoogleProductsTaskGetHtmlResponseInfo google_products_task_get_html(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_products_task_get_html_response_info import MerchantGoogleProductsTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '476084d4-faf0-4d76-98a4-ef78d8f39df9' # str | 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

    try:
        api_response = api_instance.google_products_task_get_html(id)
        print("The response of MerchantApi->google_products_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_products_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleProductsTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_products_task_post

MerchantGoogleProductsTaskPostResponseInfo google_products_task_post(merchant_google_products_task_post_request_info=merchant_google_products_task_post_request_info)

‌‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_products_task_post_request_info import MerchantGoogleProductsTaskPostRequestInfo
from dataforseo_client.models.merchant_google_products_task_post_response_info import MerchantGoogleProductsTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_google_products_task_post_request_info = [dataforseo_client.MerchantGoogleProductsTaskPostRequestInfo()] # List[MerchantGoogleProductsTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_products_task_post(merchant_google_products_task_post_request_info=merchant_google_products_task_post_request_info)
        print("The response of MerchantApi->google_products_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_products_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_google_products_task_post_request_info	List[MerchantGoogleProductsTaskPostRequestInfo]		[optional]

Return type

MerchantGoogleProductsTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_products_tasks_ready

MerchantGoogleProductsTasksReadyResponseInfo google_products_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_products_tasks_ready_response_info import MerchantGoogleProductsTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.google_products_tasks_ready()
        print("The response of MerchantApi->google_products_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_products_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleProductsTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_sellers_ad_url

MerchantGoogleSellersAdUrlResponseInfo google_sellers_ad_url(shop_ad_aclk)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_sellers_ad_url_response_info import MerchantGoogleSellersAdUrlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    shop_ad_aclk = 'DChcSEwiSl5TKpbPoAhVFmdUKHfa_B_wYABADGgJ3cw&sig' # str | unique ad click referral parameter you can obtain this parameter with Google Shopping Products or Google Shopping Sellers

    try:
        api_response = api_instance.google_sellers_ad_url(shop_ad_aclk)
        print("The response of MerchantApi->google_sellers_ad_url:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_sellers_ad_url: %s\n" % e)

Parameters

Name	Type	Description	Notes
shop_ad_aclk	str	unique ad click referral parameter you can obtain this parameter with Google Shopping Products or Google Shopping Sellers

Return type

MerchantGoogleSellersAdUrlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_sellers_task_get_advanced

MerchantGoogleSellersTaskGetAdvancedResponseInfo google_sellers_task_get_advanced(id)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_sellers_task_get_advanced_response_info import MerchantGoogleSellersTaskGetAdvancedResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '00000000-0000-0000-0000-000000000000' # str | 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

    try:
        api_response = api_instance.google_sellers_task_get_advanced(id)
        print("The response of MerchantApi->google_sellers_task_get_advanced:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_sellers_task_get_advanced: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleSellersTaskGetAdvancedResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_sellers_task_get_html

MerchantGoogleSellersTaskGetHtmlResponseInfo google_sellers_task_get_html(id)

Description of the fields for sending a request: for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/sellers/task_get/html/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_sellers_task_get_html_response_info import MerchantGoogleSellersTaskGetHtmlResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    id = '11ef35fc-a8b7-4333-a4b4-b27bfb666a45' # str | 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

    try:
        api_response = api_instance.google_sellers_task_get_html(id)
        print("The response of MerchantApi->google_sellers_task_get_html:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_sellers_task_get_html: %s\n" % e)

Parameters

Name	Type	Description	Notes
id	str	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

Return type

MerchantGoogleSellersTaskGetHtmlResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_sellers_task_post

MerchantGoogleSellersTaskPostResponseInfo google_sellers_task_post(merchant_google_sellers_task_post_request_info=merchant_google_sellers_task_post_request_info)

‌‌ Google Shopping Sellers endpoint will provide you with the list of 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_sellers_task_post_request_info import MerchantGoogleSellersTaskPostRequestInfo
from dataforseo_client.models.merchant_google_sellers_task_post_response_info import MerchantGoogleSellersTaskPostResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_google_sellers_task_post_request_info = [dataforseo_client.MerchantGoogleSellersTaskPostRequestInfo()] # List[MerchantGoogleSellersTaskPostRequestInfo] |  (optional)

    try:
        api_response = api_instance.google_sellers_task_post(merchant_google_sellers_task_post_request_info=merchant_google_sellers_task_post_request_info)
        print("The response of MerchantApi->google_sellers_task_post:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_sellers_task_post: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_google_sellers_task_post_request_info	List[MerchantGoogleSellersTaskPostRequestInfo]		[optional]

Return type

MerchantGoogleSellersTaskPostResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

google_sellers_tasks_ready

MerchantGoogleSellersTasksReadyResponseInfo google_sellers_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_sellers_tasks_ready_response_info import MerchantGoogleSellersTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.google_sellers_tasks_ready()
        print("The response of MerchantApi->google_sellers_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->google_sellers_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleSellersTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_amazon_languages

MerchantAmazonLanguagesResponseInfo merchant_amazon_languages()

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_languages_response_info import MerchantAmazonLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.merchant_amazon_languages()
        print("The response of MerchantApi->merchant_amazon_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_amazon_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_amazon_locations

MerchantAmazonLocationsResponseInfo merchant_amazon_locations()

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_locations_response_info import MerchantAmazonLocationsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.merchant_amazon_locations()
        print("The response of MerchantApi->merchant_amazon_locations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_amazon_locations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantAmazonLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_amazon_locations_country

MerchantAmazonLocationsCountryResponseInfo merchant_amazon_locations_country(country)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_amazon_locations_country_response_info import MerchantAmazonLocationsCountryResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    country = 'us' # str | country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

    try:
        api_response = api_instance.merchant_amazon_locations_country(country)
        print("The response of MerchantApi->merchant_amazon_locations_country:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_amazon_locations_country: %s\n" % e)

Parameters

Name	Type	Description	Notes
country	str	country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

Return type

MerchantAmazonLocationsCountryResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_errors

MerchantErrorsResponseInfo merchant_errors(merchant_errors_request_info=merchant_errors_request_info)

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_errors_request_info import MerchantErrorsRequestInfo
from dataforseo_client.models.merchant_errors_response_info import MerchantErrorsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_errors_request_info = [dataforseo_client.MerchantErrorsRequestInfo()] # List[MerchantErrorsRequestInfo] |  (optional)

    try:
        api_response = api_instance.merchant_errors(merchant_errors_request_info=merchant_errors_request_info)
        print("The response of MerchantApi->merchant_errors:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_errors: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_errors_request_info	List[MerchantErrorsRequestInfo]		[optional]

Return type

MerchantErrorsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_google_languages

MerchantGoogleLanguagesResponseInfo merchant_google_languages()

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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_languages_response_info import MerchantGoogleLanguagesResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.merchant_google_languages()
        print("The response of MerchantApi->merchant_google_languages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_google_languages: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleLanguagesResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_google_locations

MerchantGoogleLocationsResponseInfo merchant_google_locations()

for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_locations_response_info import MerchantGoogleLocationsResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.merchant_google_locations()
        print("The response of MerchantApi->merchant_google_locations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_google_locations: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantGoogleLocationsResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_google_locations_country

MerchantGoogleLocationsCountryResponseInfo merchant_google_locations_country(country)

for more info please visit 'https://docs.dataforseo.com/v3/merchant/google/locations/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_google_locations_country_response_info import MerchantGoogleLocationsCountryResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    country = 'us' # str | country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

    try:
        api_response = api_instance.merchant_google_locations_country(country)
        print("The response of MerchantApi->merchant_google_locations_country:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_google_locations_country: %s\n" % e)

Parameters

Name	Type	Description	Notes
country	str	country ISO code optional field specify the ISO code if you want to filter the list of locations by country example: us

Return type

MerchantGoogleLocationsCountryResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_id_list

MerchantIdListResponseInfo merchant_id_list(merchant_id_list_request_info=merchant_id_list_request_info)

This endpoint is designed to provide you with the list of IDs and metadata of the completed Merchant tasks during the specified period. You will get all task IDs that were made including successful, uncompleted, and tasks that responded as errors. for more info please visit 'https://docs.dataforseo.com/v3/merchant/id_list/?bash'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_id_list_request_info import MerchantIdListRequestInfo
from dataforseo_client.models.merchant_id_list_response_info import MerchantIdListResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)
    merchant_id_list_request_info = [dataforseo_client.MerchantIdListRequestInfo()] # List[MerchantIdListRequestInfo] |  (optional)

    try:
        api_response = api_instance.merchant_id_list(merchant_id_list_request_info=merchant_id_list_request_info)
        print("The response of MerchantApi->merchant_id_list:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_id_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
merchant_id_list_request_info	List[MerchantIdListRequestInfo]		[optional]

Return type

MerchantIdListResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

merchant_tasks_ready

MerchantTasksReadyResponseInfo merchant_tasks_ready()

‌ 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'

Example

• Basic Authentication (basicAuth):

import dataforseo_client
from dataforseo_client.models.merchant_tasks_ready_response_info import MerchantTasksReadyResponseInfo
from dataforseo_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.dataforseo.com
# See configuration.py for a list of all supported configuration parameters.
configuration = dataforseo_client.Configuration(
    host = "https://api.dataforseo.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basicAuth
configuration = dataforseo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

# Enter a context with an instance of the API client
with dataforseo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dataforseo_client.MerchantApi(api_client)

    try:
        api_response = api_instance.merchant_tasks_ready()
        print("The response of MerchantApi->merchant_tasks_ready:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling MerchantApi->merchant_tasks_ready: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

MerchantTasksReadyResponseInfo

Authorization

basicAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful operation	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]