DataForSEO · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DataForSEO Merchant API

33 actions 33 updates phrasing extends openapi/dataforseo-merchant-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for DataForSEO's API. It is a proposal applied on top of the contract, not a document DataForSEO publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 33 · first 16 shown; the file carries all of them

$.info
$.paths['/v3/merchant/id_list'].post
$.paths['/v3/merchant/errors'].post
$.paths['/v3/merchant/google/languages'].get
$.paths['/v3/merchant/google/locations'].get
$.paths['/v3/merchant/google/locations/{country}'].get
$.paths['/v3/merchant/google/products/task_post'].post
$.paths['/v3/merchant/google/products/tasks_ready'].get
$.paths['/v3/merchant/tasks_ready'].get
$.paths['/v3/merchant/google/products/task_get/advanced/{id}'].get
$.paths['/v3/merchant/google/products/task_get/html/{id}'].get
$.paths['/v3/merchant/google/sellers/task_post'].post
$.paths['/v3/merchant/google/sellers/tasks_ready'].get
$.paths['/v3/merchant/google/sellers/task_get/advanced/{id}'].get
$.paths['/v3/merchant/google/product_info/task_post'].post
$.paths['/v3/merchant/google/product_info/tasks_ready'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DataForSEO Merchant API
  version: 1.0.0
extends: openapi/dataforseo-merchant-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 32
- target: $.paths['/v3/merchant/id_list'].post
  update:
    x-apievangelist-phrasing:
      intent: List my Merchant task IDs for a period
      effect: read
      questions:
      - Can I see the IDs of all the shopping data tasks I created in a date range?
      - Which Merchant API tasks did I submit recently, including unfinished ones?
      instructions:
      - text: List the IDs and metadata of my Merchant tasks from a chosen period.
      - text: Show every Google Shopping and Amazon task I created this week.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/errors'].post
  update:
    x-apievangelist-phrasing:
      intent: List Merchant tasks that failed
      effect: read
      questions:
      - Which of my Merchant API tasks returned errors in the last 7 days?
      - Where can I see why my Amazon or Google Shopping scrapes failed?
      instructions:
      - text: Show Merchant tasks that errored during the past week.
      - text: Pull the error details for my failed shopping data tasks.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List Google Shopping languages
      effect: read
      questions:
      - What languages are supported for Google Shopping results?
      - Which language codes can I use for Google Shopping product searches?
      instructions:
      - text: List supported Google Shopping languages.
      - text: Get the Google Shopping language codes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Google Shopping locations
      effect: read
      questions:
      - Which locations can I pull Google Shopping data for?
      - What location codes does the Google Shopping endpoint accept?
      instructions:
      - text: List all supported Google Shopping locations.
      - text: Get the full Google Shopping location list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/locations/{country}'].get
  update:
    x-apievangelist-phrasing:
      intent: List Google Shopping locations in a country
      effect: read
      questions:
      - Which Google Shopping cities and regions are available within one country?
      - Can I filter Google Shopping locations to a single country?
      instructions:
      - text: List Google Shopping locations within country {country}.
        slots:
          country: path.country
      - text: Show Google Shopping regions available for {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/products/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a Google Shopping product search
      effect: write
      questions:
      - Can I queue a search that lists the products Google Shopping shows for a query?
      - How do I collect Google Shopping product listings for a keyword in the background?
      instructions:
      - text: Queue a Google Shopping products task for the query wireless earbuds.
      - text: Post a background job listing Google Shopping products for my keyword.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/products/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Google Shopping product tasks
      effect: read
      questions:
      - Which Google Shopping product search tasks have completed but not been collected?
      - Are my queued Google Shopping product searches ready?
      instructions:
      - text: List completed, uncollected Google Shopping products tasks.
      - text: Check which Google Shopping product searches are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Merchant tasks across all types
      effect: read
      questions:
      - Which Merchant tasks of any kind, Google or Amazon, are completed and waiting to be collected?
      - Is there one place to see every finished shopping task I haven't fetched yet?
      instructions:
      - text: List all completed, uncollected Merchant tasks across every endpoint.
      - text: Show every ready shopping data task regardless of marketplace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/products/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get parsed Google Shopping product results
      effect: read
      questions:
      - Where do I get structured product listings from a Google Shopping task I queued?
      - Can I fetch parsed prices and titles from a Google Shopping products task?
      instructions:
      - text: Fetch the parsed Google Shopping product results for task {id}.
        slots:
          id: path.id
      - text: Get structured product listings with prices from task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/products/task_get/html/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw HTML of Google Shopping product results
      effect: read
      questions:
      - Can I get the raw HTML page behind a Google Shopping products task?
      - Is the unparsed Google Shopping results page available for my task?
      instructions:
      - text: Fetch the raw HTML of Google Shopping products task {id}.
        slots:
          id: path.id
      - text: Download the unparsed Google Shopping page for task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/sellers/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a Google Shopping sellers lookup
      effect: write
      questions:
      - Can I find the top 10 sellers offering a product on Google Shopping?
      - Which stores list a given product on Google Shopping, and at what price?
      instructions:
      - text: Queue a Google Shopping sellers task for this product.
      - text: Post a job listing the top sellers of a product on Google Shopping.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/sellers/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Google Shopping sellers tasks
      effect: read
      questions:
      - Which Google Shopping sellers tasks are completed and uncollected?
      - Are my Google Shopping seller lookups ready?
      instructions:
      - text: List completed, uncollected Google Shopping sellers tasks.
      - text: Check which Google Shopping seller lookups are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/sellers/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google Shopping sellers results
      effect: read
      questions:
      - Where do I collect the seller list from a Google Shopping sellers task?
      - Can I fetch sellers and their offers for a product by task ID?
      instructions:
      - text: Fetch the Google Shopping sellers results for task {id}.
        slots:
          id: path.id
      - text: Get the list of stores selling the product in task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/product_info/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue a Google Shopping product details lookup
      effect: write
      questions:
      - Can I get a Google Shopping product's description, images, rating, variations and specs?
      - What identifiers do I need to look up a single product on Google Shopping?
      instructions:
      - text: Queue a Google Shopping product info task using its Google product ID.
      - text: Post a job fetching full details for one Google Shopping product.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/product_info/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Google Shopping product info tasks
      effect: read
      questions:
      - Which Google Shopping product info tasks are done and uncollected?
      - Are my product details lookups on Google Shopping ready?
      instructions:
      - text: List completed, uncollected Google Shopping product info tasks.
      - text: Check which Google Shopping product detail jobs are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/product_info/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Google Shopping product details results
      effect: read
      questions:
      - Where can I retrieve the specs and reviews from a Google Shopping product info task?
      - Can I fetch one product's full Google Shopping details by task ID?
      instructions:
      - text: Fetch the Google Shopping product info results for task {id}.
        slots:
          id: path.id
      - text: Get description, images and specifications from product task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/google/sellers/ad_url/{shop_ad_aclk}'].get
  update:
    x-apievangelist-phrasing:
      intent: Resolve a Google Shopping seller ad URL
      effect: read
      questions:
      - Can I get the full destination URL, with all seller parameters, of a Google Shopping ad?
      - Where does a Google Shopping seller's ad click actually lead?
      instructions:
      - text: Resolve the full ad URL for Google Shopping ad click {shop_ad_aclk}.
        slots:
          shop_ad_aclk: path.shop_ad_aclk
      - text: Get the seller's landing URL behind ad {shop_ad_aclk}.
        slots:
          shop_ad_aclk: path.shop_ad_aclk
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List Amazon locations
      effect: read
      questions:
      - Which locations can I pull Amazon product data for?
      - What Amazon location codes are supported?
      instructions:
      - text: List all supported Amazon locations.
      - text: Get the Amazon marketplace location list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/locations/{country}'].get
  update:
    x-apievangelist-phrasing:
      intent: List Amazon locations in a country
      effect: read
      questions:
      - Which Amazon locations are available within a specific country?
      - Can I filter Amazon locations by country?
      instructions:
      - text: List Amazon locations within country {country}.
        slots:
          country: path.country
      - text: Show Amazon delivery locations available for {country}.
        slots:
          country: path.country
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/languages'].get
  update:
    x-apievangelist-phrasing:
      intent: List Amazon languages
      effect: read
      questions:
      - What languages are supported for Amazon product results?
      - Which language codes can I use for Amazon searches?
      instructions:
      - text: List supported Amazon languages.
      - text: Get the Amazon language codes.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/products/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an Amazon product search
      effect: write
      questions:
      - Can I collect the Amazon search results for a product keyword?
      - How do I get Amazon product listings for a query in a given location?
      instructions:
      - text: Queue an Amazon products task for the keyword standing desk.
      - text: Post a job pulling Amazon search listings for my product name.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/products/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Amazon product search tasks
      effect: read
      questions:
      - Which Amazon product search tasks are finished and uncollected?
      - Are my Amazon keyword searches ready?
      instructions:
      - text: List completed, uncollected Amazon products tasks.
      - text: Check which Amazon product searches are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/products/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get parsed Amazon product search results
      effect: read
      questions:
      - Where do I get structured Amazon listings from a product search task?
      - Can I fetch parsed Amazon products, prices and ratings by task ID?
      instructions:
      - text: Fetch the parsed Amazon products results for task {id}.
        slots:
          id: path.id
      - text: Get structured Amazon search listings from task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/products/task_get/html/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw HTML of Amazon product search results
      effect: read
      questions:
      - Can I get the raw HTML of the Amazon search page for my task?
      - Is the unparsed Amazon results page available for a product search?
      instructions:
      - text: Fetch the raw HTML of Amazon products task {id}.
        slots:
          id: path.id
      - text: Download the unparsed Amazon search page for task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/asin/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an Amazon ASIN variations lookup
      effect: write
      questions:
      - Can I find all the ASINs assigned to different variations of one Amazon product?
      - Which sizes and colors of an Amazon product have their own ASIN?
      instructions:
      - text: Queue an Amazon ASIN task for a product ASIN.
      - text: Post a job listing every variation ASIN of an Amazon product.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/asin/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Amazon ASIN tasks
      effect: read
      questions:
      - Which Amazon ASIN lookup tasks are complete and uncollected?
      - Are my Amazon ASIN variation jobs ready?
      instructions:
      - text: List completed, uncollected Amazon ASIN tasks.
      - text: Check which Amazon ASIN lookups are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/asin/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get parsed Amazon ASIN product results
      effect: read
      questions:
      - Where do I get the product info and variation ASINs from an ASIN task?
      - Can I fetch parsed Amazon product details for an ASIN task?
      instructions:
      - text: Fetch the parsed Amazon ASIN results for task {id}.
        slots:
          id: path.id
      - text: Get product details and variation ASINs from task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/asin/task_get/html/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw HTML of an Amazon ASIN page
      effect: read
      questions:
      - Can I get the raw Amazon product page HTML for an ASIN task?
      - Is the unparsed product page available for my ASIN lookup?
      instructions:
      - text: Fetch the raw HTML of Amazon ASIN task {id}.
        slots:
          id: path.id
      - text: Download the unparsed Amazon product page for ASIN task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/sellers/task_post'].post
  update:
    x-apievangelist-phrasing:
      intent: Queue an Amazon sellers lookup
      effect: write
      questions:
      - Who sells a given product on Amazon, and at what price and condition?
      - Can I get each Amazon seller's shipping and rating details for a product?
      instructions:
      - text: Queue an Amazon sellers task for this ASIN.
      - text: Post a job listing all Amazon sellers of a product in the US.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/sellers/tasks_ready'].get
  update:
    x-apievangelist-phrasing:
      intent: List finished Amazon sellers tasks
      effect: read
      questions:
      - Which Amazon sellers tasks are done and uncollected?
      - Are my Amazon seller lookups ready?
      instructions:
      - text: List completed, uncollected Amazon sellers tasks.
      - text: Check which Amazon seller lookups are ready.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/sellers/task_get/advanced/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get parsed Amazon sellers results
      effect: read
      questions:
      - Where can I retrieve the parsed seller offers from an Amazon sellers task?
      - Can I fetch Amazon seller pricing and ratings by task ID?
      instructions:
      - text: Fetch the parsed Amazon sellers results for task {id}.
        slots:
          id: path.id
      - text: Get seller offers, conditions and shipping from task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v3/merchant/amazon/sellers/task_get/html/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get raw HTML of Amazon sellers page
      effect: read
      questions:
      - Can I get the raw HTML of the Amazon offers page for a sellers task?
      - Is the unparsed Amazon seller listing page available?
      instructions:
      - text: Fetch the raw HTML of Amazon sellers task {id}.
        slots:
          id: path.id
      - text: Download the unparsed Amazon offers page for task {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'