Your agent needs marketplace data — what a product costs on Amazon and Google Shopping, who the sellers are, what reviewers actually complain about.
What you can ask for • "What is this ASIN's price history, rating and seller list?" • "Who else sells this product, and at what price?" • "Pull the reviews for this product and group the complaints." • "What comes up on Google Shopping for this query in the UK?" • "Compare these products across both marketplaces."
How to use it Point any MCP client at https://mcp.aisa.one/seo-merchant/mcp and sign in with OAuth — there is no key to create or paste. 22 tools: Amazon products, ASIN detail and sellers; Google Shopping products, product info, sellers and reviews; live and queued forms, with raw HTML where you need it.
It is also a door to the rest The same login reaches 26 sources and 580+ operations. Price the product here, then ask the same agent what the brand's site traffic or ad spend looks like — without adding a second server.
What it costs Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident.
Where else it reaches https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Scored across 29 tools
The submit/fetch pairs are reasonably distinguished by their descriptions, and batch_quote vs batch_use is well documented. However, several fetch vs fetch_html pairs are near-identical (e.g. get_dataforseo_merchant_amazon_asin_fetch vs ..._fetch_html) with placeholder descriptions ('Description of the fields for sending a request:'), and a deprecated 'use' tool sits alongside 'batch_use', making selection risky for an agent.
All names are snake_case, and the DataForSEO block follows a strict get_/post_ verb_..._fetch/submit pattern. But the meta tools mix bare nouns/verbs (account, search, use) with prefixed and verb_noun names (batch_get_schema, batch_quote, list_categories), so the overall convention is inconsistent.
29 tools exceeds the 25 threshold and feels heavy for the surface. Much of the bulk comes from systematic submit/fetch and fetch/fetch_html pairs across Amazon and Google, which pads the count beyond what is clearly earned.
The DataForSEO merchant surface is broadly covered: submit/fetch for Amazon products, ASINs, sellers, and Google products, product info, reviews, sellers, plus languages and locations. Minor gaps remain around explicit task-status/task-management operations, but core workflows are supported.
Who am I, what can I use, how much can I spend: the key, the account balance, the Go-to-Market wallet when one is active, and usage for today, 7 days and 30 days. Free; needs the Authorization header. Call it to verify a new connection or to explain a 402. ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Adds substantial context beyond the readOnlyHint/openWorldHint/destructiveHint annotations: the call is free, it requires the Authorization header, and it discloses result semantics ('ok is true only when the balance was read; otherwise each entry of errors says what to do in next_step'). That tells an agent how to interpret partial failure, which annotations cannot convey.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences, front-loaded with what the agent gets, followed by cost/auth, then call triggers, then result interpretation. No sentence is redundant and none could be dropped without losing information.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter read tool with an output schema already present, the description covers the remaining gaps: cost, auth requirement, invocation triggers, and the ok/errors/next_step contract. Nothing an agent needs to call or interpret it correctly is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the description has nothing parameter-level to compensate for, and the schema is fully covered. A 4 rather than 5 reflects that it adds no input-syntax detail, though none is possible here.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a concrete resource set (identity/key, account balance, Go-to-Market wallet, usage over 1/7/30 days) rather than restating the name. It is clearly distinguishable from every sibling, which are all Reddit, batch, or search tools. An agent knows exactly what it will learn by calling it.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicit triggering conditions are given: 'Call it to verify a new connection or to explain a 402.' That is a strong when-to-use statement. It stops short of 5 because it names no alternative tool or a when-not condition, though the sibling list offers no obvious competing diagnostic.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Retrieve schemas for 1 to 20 exact tool names from search. Build arguments from successful schemas, then call batch_quote. Do not call batch_use yet. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| tools | Yes | Exact tool names returned by search whose complete contracts are needed. Never invent tool names. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| include_documentation | No | Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support. | |
| include_response_schema | No | Return the complete response_schema. Defaults to false. | |
| include_arguments_schema | No | Return the complete arguments_schema. Defaults to true. |
| Name | Required | Description |
|---|---|---|
| tools | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, non-destructive, closed-world), so the description is not required to restate it. It adds genuine operational context: the batch_use prohibition, exact-name/prefix requirements, and session reuse semantics. It does not cover failure handling when names are invalid, keeping it below a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the core action and size limit, and every sentence carries workflow value. The session_id sentence duplicates the schema's own parameter description, which is minor redundancy rather than bloat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a read-only batch retrieval tool with an output schema, the description supplies the orchestration context an agent needs (source of names, next steps, session handling) without needing to explain return values. Nothing essential to correct invocation is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the baseline is 3. The description adds real meaning beyond the schema by constraining names to those returned by search and warning against a client prefix such as mcp__aisa__, which is not encoded in the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Retrieve schemas for 1 to 20 exact tool names') and pins the source of those names to search. This clearly separates it from siblings like search (finds tools), batch_quote, and batch_use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly sequences the workflow: build arguments from successful schemas, then call batch_quote, and 'Do not call batch_use yet.' This is an explicit when-to-use and when-not-to-use instruction naming the alternative siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Obtain AIsaServices cost quotes for 1 to 20 published tools without executing them. Same input as batch_use: exact tool names and schema-valid arguments. Never falls back to execution. The response reports auto_execute_eligible and auto_execute_threshold_micros_usd. auto_execute_eligible waives only the extra cost-confirmation step and does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Quotes are price observations, not authorization grants. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
| auto_execute_eligible | No | True when the worst-known total of successful USD quotes is at or below auto_execute_threshold_micros_usd. A non-USD successful quote makes the batch ineligible. Present on quote responses. |
| auto_execute_threshold_micros_usd | No | Configured auto-execute threshold in micro-USD. 0 disables automatic execution. Present on quote responses. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Goes well past the readOnly/idempotent annotations by explaining that quotes are price observations rather than authorization grants, and precisely delimiting what auto_execute_eligible does and does not waive (user prohibition, narrower scope, tighter budget). It also guarantees no execution fallback, which is the key behavioral risk for this tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Purpose is front-loaded and most sentences carry distinct rules (no fallback, eligibility limits, naming, session reuse). It is on the long side and the argument-shape constraint is stated twice in spirit, but little is truly wasted.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return-value documentation isn't required, yet the description still flags the two response fields that matter for a downstream decision. Combined with session and naming guidance, an agent has everything needed to call it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
At 67% schema coverage the schema already documents each parameter, so the description earns credit only for added meaning: exact-name rules for 'tool', session_id reuse semantics, and the 1-to-20 argument-shape parallel with batch_use. It doesn't clarify search_id beyond what the schema states.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource ('Obtain AIsaServices cost quotes for 1 to 20 published tools') plus the crucial scope qualifier 'without executing them.' It is immediately distinguishable from the sibling batch_use, which executes rather than quotes.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly names the parallel sibling ('Same input as batch_use') and draws the boundary ('Never falls back to execution'). It also gives operational conditions: use names exactly as search returns them, strip any mcp__aisa__ prefix, and reuse session_id from Search for the task.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Billable API calls can incur substantial charges. Never call before a successful batch_quote for the same tools and arguments. Execute only when that quote response reports auto_execute_eligible=true for these calls, or when explicit user authorization covers that cost and risk. auto_execute_eligible waives only the extra cost-confirmation step; it does not override a user prohibition on execution, a narrower scope, or a tighter budget limit. Re-quote if tools, arguments, or scope change. Execute 1 to 20 independent published-tool calls; never silently retry. A missing or failed quote is not free. Use tool names exactly as search returns them, without a client prefix such as mcp__aisa__. Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.
| Name | Required | Description | Default |
|---|---|---|---|
| calls | Yes | ||
| search_id | No | Optional search correlation identifier returned by search. | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| Name | Required | Description |
|---|---|---|
| results | Yes | |
| batch_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| error_count | Yes | |
| total_count | Yes | |
| success_count | Yes | |
| next_steps_guidance | Yes | Deterministic next-step instructions derived from this result. Not an authorization grant. |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover mutability, destructiveness, and open-world behavior. The description adds critical business logic: billable calls, quote dependency, the meaning of auto_execute_eligible (waives only cost confirmation, not user prohibitions), and no silent retry. It doesn't detail rate limits or return format, but with an output schema present, that's acceptable.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is dense and front-loads the cost warning, but it packs many separate instructions into one block, making it less scannable. Some sentences like 'A missing or failed quote is not free' add value, but the overall flow could be better structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the destructive, open-world annotations and the presence of an output schema, the description covers the essential preconditions and behavioral constraints. It could mention error handling or partial failure behavior, but the core guidance is sufficient for correct invocation.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 67%, and the description adds important semantics: tool names must be exact without client prefix, session_id reuse guidance, and 1-20 call limit. It doesn't explain search_id, but the schema description for search_id is already clear enough.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the verb and resource: 'Execute 1 to 20 independent published-tool calls', and the title matches. It distinguishes itself from batch_quote by requiring a quote first, but doesn't explicitly contrast with the singular 'use' sibling, though that's implied by 'batch'.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description gives explicit when-to-use and when-not-to-use conditions: only after a successful batch_quote with auto_execute_eligible=true or explicit user authorization. It also states re-quote conditions and prohibits silent retries, leaving little ambiguity.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint will provide you with information about the product and ASINs of all its modifications listed on Amazon.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is fully covered. The description adds no behavioral context beyond that - no mention of the 30-day result-retention window, latency, or that it reads results of an existing task; the only extra text is injected pricing boilerplate.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The prose is brief and front-loaded, which is good, but the second half is an injected pricing block that conveys no task-relevant information. The one meaningful sentence is loosely worded, so brevity here reflects under-specification as much as economy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and annotations cover safety. However, for a task-result retrieval tool the description omits the submit-then-fetch workflow and the role of the id, leaving the agent to infer the operational context.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema itself richly documents the UUID task identifier and its 30-day validity, so the baseline is 3. The description adds no parameter meaning at all, but the schema carries the full burden adequately.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource ('information about the product and ASINs of all its modifications listed on Amazon') but the verb is weak and generic ('will provide you with information'). It does not distinguish this tool from its obvious siblings like get_dataforseo_merchant_amazon_asin_fetch_html or the post_..._asin_submit counterpart, so an agent cannot tell why to pick this one without reading the schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this tool versus alternatives. Critically, nothing states that the required 'id' is a task identifier produced by a prior submit call (post_dataforseo_merchant_amazon_asin_submit), which is the key routing decision for this family of tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered elsewhere. The description's only added behavioral content is a pricing line, which is generic boilerplate rather than useful operational context (no latency, quota, or result-availability notes).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but not concise in the useful sense: the leading sentence is a dangling placeholder about field descriptions that are never delivered, and the remaining content is an embedded pricing comment block. Nothing is front-loaded and no sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema and rich annotations exist, so return values and safety need not be explained. Still, the description fails to say that this retrieves previously submitted ASIN task HTML results by task id, leaving an agent to infer the tool's role entirely from the name and title.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and there is a single parameter, whose UUID format and the 7-day result-retention window are fully documented in the schema. The description adds nothing beyond that, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; it opens with a generic boilerplate header ('Description of the fields for sending a request:') and the only substantive text is a pricing remark. Nothing distinguishes it from siblings like get_dataforseo_merchant_amazon_asin_fetch or ..._products_fetch_html.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no mention of the submit/fetch workflow, and no reference to any sibling tool. An agent gets zero routing signal from the description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
You will receive the list of supported Amazon languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description's one extra piece of real information is the usage-based billing estimate ($0.012 default), which is genuinely useful cost context, but nothing is said about rate limits, response caching, or how the list is scoped.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The purpose sentence is front-loaded and short, and the pricing block is easily skippable. Slightly wasted wording ('You will receive ... by calling this API') keeps it off a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter lookup with full annotation coverage and an output schema describing the returned list, the description gives an agent everything it needs. Only the lack of any hint about downstream use of the language codes keeps it short of complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so per the rubric the baseline is 4. The description adds nothing here, but there is nothing to add.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource: it returns the list of supported Amazon languages. That is clear enough for an agent to know what comes back, though it never distinguishes itself from the near-identical sibling get_dataforseo_merchant_google_languages.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance, no prerequisites, and no mention of alternatives. The phrase 'by calling this API' is circular and adds nothing; the agent must infer that this is a static reference lookup to be used when a language code is needed for another merchant call.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already declare readOnlyHint=true, idempotentHint=true and destructiveHint=false, so the safety profile is covered by structured data. The description adds only the usage-based billing note ($0.012 estimate), which is a genuine behavioral detail not present in annotations, but it says nothing about rate limits, caching, or whether the list is static reference data.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core purpose is stated in the first sentence, with the usage hint second, so the content is front-loaded and brief. The embedded pricing-block boilerplate is third-party padding rather than description content, which slightly dilutes an otherwise tight definition.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a no-parameter, idempotent reference-list call with an output schema present, the description covers what is returned without needing to enumerate fields. What is missing is only a pointer to the related location/language lookup tools the agent may need alongside it.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there is nothing for the description to clarify at the parameter level, and the 0-param baseline of 4 applies. The mention of filtering by country is about downstream task configuration rather than an argument to this call, which is slightly ambiguous but not harmful.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb+resource: it returns the list of supported Amazon locations. This is clearly distinct from sibling tools like get_dataforseo_merchant_amazon_languages or the various submit/fetch endpoints. It does not, however, explicitly contrast itself with get_dataforseo_merchant_google_locations, which is the closest sibling.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The sentence 'You can filter the list of locations by country when setting a task' hints at how the returned locations are consumed downstream, but it never says when to call this tool versus the Google-locations counterpart, nor does it clarify that this is a prerequisite lookup for setting location-based tasks. Usage is only implied.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnly/idempotent/non-destructive, so safety is covered. The description adds only a pricing note, which is somewhat useful but says pricing may differ and adds no behavioral context about the 30-day retrieval window that actually matters for calling it.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short but entirely off-purpose: a meta line about request fields plus a pricing comment. It is not front-loaded with what the tool does, so brevity here reflects under-specification rather than conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is an output schema, so return values need not be explained, but the description still fails to say this retrieves a previously submitted task's results. For a fetch-by-id tool with siblings, that contextual link is essential and missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single id parameter is fully documented in the schema, including the 30-day window. The description adds no parameter meaning beyond the schema, so baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; it only says 'Description of the fields for sending a request'. The tool's actual purpose (fetching Amazon product results by task id) is inferable only from the name/title, not from the description text.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this versus siblings like get_dataforseo_merchant_amazon_products_fetch_html or the submit counterpart post_dataforseo_merchant_amazon_products_submit. Nothing tells the agent the fetch-after-submit relationship.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The only added context is cost ('$0 USD per successful request'), which is genuinely useful, but nothing is said about result expiry (the 7-day window lives only in the schema), HTML payload size, or failure behavior for expired ids.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the opening sentence promises a field description that never follows, and the bulk of the text is an HTML-commented pricing boilerplate block. Information is neither front-loaded nor complete, so brevity here reflects under-specification rather than discipline.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be explained, but with a single required id and a crowded sibling set, the agent still needs to know this is a post-submit HTML result fetch and what happens after 7 days. None of that is present, leaving the definition functionally incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the single 'id' parameter is fully documented in the schema (UUID format, 7-day validity), so the description is not required to carry parameter meaning. It adds nothing beyond the schema, which places it at the baseline.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; it opens with 'Description of the fields for sending a request:' and then only a pricing block. Nothing in the text distinguishes retrieving stored HTML results by task id from the many sibling *_fetch and *_submit tools — that distinction exists only in the title/name.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to call this versus get_dataforseo_merchant_amazon_products_fetch, the asin variants, or the corresponding submit tool. The agent must infer the id-based result-retrieval workflow entirely on its own.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is fully covered. The description adds that the payload contains seller condition/pricing/shipment/rating details, but discloses nothing about task-id lifecycle, retrieval window, or async behavior beyond what the schema states. Adequate but not value-adding.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The functional content is a single, front-loaded sentence with no waste. The appended pricing boilerplate is inert but adds noise, keeping it short of a 5.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present and annotations covering safety, the return side and risk profile are handled elsewhere. The remaining gap is the workflow context: the description omits that this reads results of a previously submitted task and how it relates to its submit/html siblings, leaving an agent without the routing information this tool set requires.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the schema already fully documents the single 'id' parameter, including UUID format and the 30-day retrieval window. The description adds no additional meaning about the parameter, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb and resource: retrieves a list of sellers for a specified Amazon product, and enumerates the data fields returned (condition, pricing, shipment, rating). It is clear, but it does not distinguish itself from close siblings such as get_dataforseo_merchant_amazon_sellers_fetch_html or the post_..._sellers_submit counterpart, and the 'by id' nature of the call is only in the title.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance and no mention of alternatives. Critically, it never explains that 'id' is a task identifier produced by post_dataforseo_merchant_amazon_sellers_submit, nor when to prefer this over the _html variant. The agent must infer the submit-then-fetch workflow entirely.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint, and destructiveHint=false, so the safety profile is fully covered elsewhere. The description adds only a pricing disclaimer, which is marginally useful but discloses nothing about the retrieval behavior, the id's 7-day window, or error cases.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the brevity comes from omission rather than efficiency. The lead sentence is filler and the pricing comment block is the only substantive content, so no sentence actually explains the tool's use.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The tool has an output schema, so return values need not be explained, but the description still omits purpose, usage, and any distinction from the non-HTML sibling. For a fetch-by-id tool in a large family, this is inadequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
With one parameter and 100% schema description coverage, the schema already explains that the id is a UUID and is usable for 7 days. The description contributes no additional parameter semantics, so the baseline of 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description body never states what the tool does; it only says 'Description of the fields for sending a request' plus a pricing note. The actual purpose (retrieving stored Amazon Sellers HTML task results by id) is inferable only from the name and title, not from the description.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no mention of the retrieval step after submit, and no differentiation from the sibling get_dataforseo_merchant_amazon_sellers_fetch (non-HTML variant). The agent gets nothing to route on.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
You will receive the list of supported Google Shopping languages by calling this API.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, idempotentHint=true, openWorldHint=true, and destructiveHint=false, covering the safety profile. The description adds a useful billing estimate ('$0.012 USD') and notes that pricing is usage-based and may vary, which is behavioral context beyond the annotations. However, it does not describe rate limits, authentication needs, or return format details, so it remains a modest addition.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The core purpose is front-loaded in a single sentence, and the pricing note is clearly demarcated as supplementary information. The text is short and every sentence serves a purpose, though the phrase 'by calling this API' is slightly redundant.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter, read-only list endpoint with an output schema already defining the return shape, the description is nearly complete. It states what is returned and includes cost context, but it could mention when to use this tool relative to its siblings, which is a minor gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so there are no parameter semantics to clarify. Per the rubric, a zero-parameter tool earns a baseline of 4, and the description appropriately does not invent parameter details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool returns the list of supported Google Shopping languages, which is a specific resource and verb. It implicitly distinguishes from siblings like get_dataforseo_merchant_amazon_languages and get_dataforseo_merchant_google_locations by naming 'Google Shopping languages', but it does not explicitly contrast with those alternatives.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description offers no guidance on when to use this tool versus alternatives, nor does it mention prerequisites or exclusions. It simply states the outcome of calling the API, leaving usage decisions entirely to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered by structured data. The description does add useful non-annotation context - a default request cost estimate of $0.012 USD with a caveat that pricing is account-specific - which is genuine behavioral information an agent cannot get elsewhere. It says nothing about result size or refresh cadence, so it earns only a partial score.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short and front-loads the billing figure, but as a tool description it is almost entirely a pricing disclaimer rather than a statement of capability, so its brevity reflects under-specification rather than efficient communication.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With no parameters and an output schema present, the remaining job is to state what the tool returns and when to call it - a list of supported Google Shopping locations for Merchant API lookups. The description omits this entirely, so an agent must reverse-engineer the tool's role from its name alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool takes zero parameters, so the schema baseline of 4 applies. No parameter-level detail is needed or missing.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description body contains only a billing notice and never states what the tool does. The purpose is inferable solely from the name/title ('List of Google Shopping Locations'), which the description itself does not restate or clarify, and no differentiation from siblings like get_dataforseo_merchant_google_languages is offered.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use, when-not-to-use, prerequisite, or alternative-tool guidance appears anywhere in the description. The only content is pricing boilerplate, so an agent gets zero routing help among the many sibling tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so safety is covered externally. The pricing block ('$0 USD per successful request') is genuine added behavioral context not present in structured fields, but nothing is said about error behavior, retries, or the id's 30-day validity window.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short, but its opening sentence is pure filler that does not earn its place, and the only real content is a pricing boilerplate comment. Front-loading a meaningless sentence wastes the most valuable position in the description.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Although an output schema exists and annotations cover the safety profile, the description still leaves core gaps: it does not say this is the retrieval half of a submit/fetch pair, nor how long results remain retrievable. For a task that an agent must sequence correctly, this is inadequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single id parameter is richly documented in the schema (UUID format, 30-day reuse window), so the schema carries the full burden. The description adds no syntax or format detail beyond it, which matches the baseline 3 for a high-coverage one-parameter tool.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; its only substantive line is a meta-placeholder ('Description of the fields for sending a request:'). The actual purpose is only recoverable from the title/name, which indicates a tautological restatement rather than a stated verb+resource.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no when-to-use guidance at all, and no routing to the obvious sibling post_dataforseo_merchant_google_product_info_submit, which is the tool that produces the id this one consumes. An agent gets zero help distinguishing this fetch-by-id from the related submit/product tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is fully covered by structured data. The description's only substantive content is a cost banner ('$0 USD per successful request'), which is mildly useful billing context, but it says nothing about the async submit/fetch workflow, result availability windows, or error behavior when an id is unknown or expired.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short but effectively empty: a header fragment plus an auto-generated pricing block. No sentence tells the agent anything actionable about this tool, so brevity is achieved by omission rather than by economy.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the id semantics live in the schema. However, for a fetch-by-task-id tool sitting in a submit/fetch pair among many similarly named merchant tools, the description omits the essential 'retrieve results of a previously submitted task' framing and any counterpart tool references.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Only one parameter, and the schema describes it at 100% coverage (UUID task identifier, usable within 30 days). Per the high-coverage baseline, 3 is the ceiling here, and the description adds nothing beyond the schema — it merely claims to describe request fields without doing so.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does; its only content is the generic filler 'Description of the fields for sending a request' plus a pricing banner. Whatever purpose an agent can infer (fetch Google Shopping task results by id) comes from the name and title, not the description. This is close to a tautology/placeholder rather than a real purpose statement.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to use this versus siblings such as get_dataforseo_merchant_google_products_fetch_html, get_dataforseo_merchant_google_product_info_fetch, or the corresponding post_..._submit tool that produces the task id this tool consumes. No preconditions, no exclusions, no alternatives are named.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description adds only a published reference price of $0 per request with a caveat that pricing may differ, which is minor cost context but nothing about retrieval windows, result availability, or failure behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is short, but the content is inert boilerplate: a dangling colon after 'Description of the fields for sending a request:' that is never fulfilled, plus an injected pricing comment. Brevity here reflects missing content rather than efficient conciseness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and annotations cover safety. But with roughly two dozen sibling merchant tools, the description provides zero routing information and never states that this is a read-back-by-id operation, leaving the definition critically incomplete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% and the single 'id' parameter is fully documented in the schema, including the UUID format and 7-day retrieval window, so the schema carries the burden. Per the rubric, high coverage yields a baseline of 3 even when the description adds no parameter detail.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does. It opens with the placeholder 'Description of the fields for sending a request:' and then contains only a pricing boilerplate comment. An agent must rely entirely on the title and name to infer that this fetches stored Google Shopping HTML results by task id.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance whatsoever. It does not distinguish this fetch tool from its many siblings (merchant_google_products_fetch, _fetch_html variants, or the corresponding post_*_submit tools), nor does it mention that an id from a prior submit task is required.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Buyer reviews for one Google Shopping product, from a task queued by post_dataforseo_merchant_google_reviews_submit: rating, text, author and date per review. Free - the charge was on the submit. Wrapped in DataForSEO's envelope: data in tasks[0].result, outcome in tasks[0].status_code - a rejected request still returns HTTP 200. For the product's own specification and sellers use get_dataforseo_merchant_google_product_info_fetch.
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | DataForSEO task ID. |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already cover the safety profile (readOnly, idempotent, openWorld, non-destructive). The description goes further by disclosing the result envelope (data in tasks[0].result, outcome in tasks[0].status_code) and the non-obvious HTTP-200-on-rejection quirk, which is genuinely useful error-handling context beyond annotations. It stops short of pagination or result-count behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Front-loaded with the resource and scope, then pricing, then the envelope contract, then the alternative tool. Every sentence carries distinct information; the injected pricing block is boilerplate rather than author bloat.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a single-ID fetch with an output schema, an agent has everything it needs: how to obtain the ID, that the call is free, how to read the response envelope, how to detect a rejected request, and where to go for adjacent data.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% and the single parameter's meaning ('DataForSEO task ID') is already documented. The description adds provenance for that ID (it comes from the submit call), which is mildly useful but not more than what the schema and sibling references imply. Baseline 3 applies when the schema carries the load.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States a specific verb+resource ('Buyer reviews for one Google Shopping product') and enumerates the returned fields (rating, text, author, date). It distinguishes itself from siblings by naming the queueing tool it depends on and routing product-spec lookups to get_dataforseo_merchant_google_product_info_fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Gives the precondition explicitly ('from a task queued by post_dataforseo_merchant_google_reviews_submit') and names the alternative tool plus the condition that selects it (product specification and sellers). An agent knows when to call this and when to route elsewhere.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Description of the fields for sending a request:
Published reference price: $0 USD per successful request. Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | <em>task identifier</em><br><strong>unique task identifier in our system in the <a href="https://en.wikipedia.org/wiki/Universally_unique_identifier">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint, idempotentHint, openWorldHint and destructiveHint=false, so the safety profile is covered. The description's only extra content is a generic pricing note ($0 per request), which is tangential; it does not disclose that the id is only valid for 30 days (that fact lives in the schema) or anything else behavioral about retrieval.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The text is short but not concise in the useful sense: a meaningless placeholder sentence and a boilerplate pricing comment consume the entire description with no front-loaded statement of what the tool does.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained, and the single parameter is fully documented in the schema. However, for a fetch-by-id tool that is one half of a submit/fetch pair, the complete absence of purpose or workflow context makes the definition inadequate.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100% for the single 'id' parameter, which the schema itself documents thoroughly (UUID format, 30-day validity). Per the rubric, high schema coverage sets the baseline at 3, and the description adds nothing further.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description contains only a placeholder phrase ('Description of the fields for sending a request:') and an injected pricing block; it never states that the tool retrieves Google Shopping seller results by task id. Any understanding of purpose must come from the title/name, not the description itself.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No when-to-use guidance, no mention of the sibling submit tool (post_dataforseo_merchant_google_sellers_submit) that produces the id, and no exclusions. The agent gets zero routing help from the text.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
The AIsa catalogue at a glance: categories, the servers in each, tool counts, and the dedicated endpoint to connect if you only need one category. Free. (AIsa-only: tool-router has no equivalent.) Use mcp.aisa.one/mcp?modules=<category> (or mcp.aisa.one/<category>/mcp) to have that category's tools listed directly instead of via search.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already establish that this is a safe, read-only, closed-world operation. The description adds useful context beyond annotations by saying it returns categories, servers, tool counts, and the dedicated endpoint, and that it is free. It omits auth/rate-limit details, but those are less critical given the read-only annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is front-loaded with what the tool returns and is generally efficient. The parenthetical about tool-router and the endpoint URL add some density, but each part contributes usage or content context.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With zero parameters, read-only annotations, and an output schema available, the description supplies enough context for correct invocation. It explains the catalogue contents and gives the category-specific endpoint alternative, leaving no critical gap for an agent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so parameter semantics are not a meaningful differentiator. The schema has no properties to explain, and the description does not need to document any inputs.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states that this tool gives a catalogue overview: categories, servers per category, tool counts, and a dedicated endpoint. The resource is specific and recognizable, though sibling differentiation is only partial because it references 'tool-router' rather than the listed siblings like search/use.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives a clear alternative: use the category-specific endpoint if you only need one category, rather than going via search. It also notes the tool is free and AIsa-only, but it does not explicitly state when to call list_categories instead of search or use.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint will provide you with a full list of ASINs assigned to different modifications of a product.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructiveHint=true, readOnlyHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is covered. The description usefully adds usage-based billing ($0.012 default estimate) that annotations cannot express, but it omits the critical async behavior: that this returns a task and results must be fetched via the _fetch sibling.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is short and undeniably concise, but it front-loads the least useful content (a restatement of what the response contains) and the pricing block reads as injected boilerplate. Little is padded, yet the lead sentence does not orient the agent toward the action.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists so return values need not be described, but for a destructive, non-idempotent task-submission tool the definition is missing the workflow context that matters most: this enqueues work and requires a separate fetch call. The claim that it directly 'provides' the ASIN list is misleading for an async submit endpoint.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage for the single top-level 'body' parameter is 0%, and the description supplies no information about it at all. While the nested item schema documents fields richly, the description neither references required field combinations (asin, language/location) nor compensates for the uncovered top-level parameter.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific resource (Amazon ASINs) but frames the tool by its output ('will provide you with a full list of ASINs') rather than the action it performs, which is submitting an asynchronous task. The name says 'submit' while the prose reads like a synchronous read, and it never distinguishes itself from the sibling post_..._products_submit or the get_..._asin_fetch tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus the many sibling submits (products, sellers, google_*) or the paired fetch endpoints. An agent must infer from the tool name alone that this enqueues a task whose results are retrieved elsewhere.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides results from Amazon product listings according to the specified keyword (product name), location, and language parameters.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false and destructiveHint=true, i.e. a mutating task-creation call, while the description says the endpoint 'provides results' — a read-flavored statement that contradicts the declared behavior and hides the submit-then-fetch workflow. The only genuinely useful added detail is the usage-based billing estimate, which does not offset the contradiction. Flagged as an annotation contradiction.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The prose is brief and front-loaded, but it is generic boilerplate that also appears on sibling endpoints, and the description carries template artifacts (zero-width characters, an HTML-comment pricing block) that add noise rather than signal. It is short without being informative.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an asynchronous task-submission endpoint in a family that pairs submit/fetch siblings, the description omits the essential fact that it enqueues a task whose results are retrieved later (or via postback/pingback). Output schema exists so return values need not be described, but the submit-vs-fetch contract is the one thing an agent must know and it is absent.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description mentions keyword, location, and language, which are the three semantic axes of the request, but says nothing about the many behavioral parameters documented in the schema (depth, priority, sort_by, postback_url/postback_data, max_crawl_pages, department, price_min/price_max). The nested schema itself is extremely detailed, so the description only needs to add marginal value here, which it barely does.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource (Amazon product listings) and the driving parameters (keyword, location, language), so an agent can tell what domain it operates on. However, the verb is wrong for this tool: it says the endpoint 'provides results,' which describes the sibling get_dataforseo_merchant_amazon_products_fetch, not a 'submit' endpoint that queues a task. No sibling is named, so the distinction from the fetch variant is left to the tool name alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus the many fetch/search siblings, no mention that it submits an asynchronous task rather than returning data, and no prerequisites or exclusions. The only context sentence is a restatement of scope, leaving routing to be inferred entirely from the name.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=false, destructiveHint=true, and non-idempotent, but the description implies a passive read ('provides a list of sellers') without disclosing that it creates a billable, asynchronous task. It does add genuinely useful context beyond the annotations in the form of the usage-based pricing estimate (~$0.012). However, task lifecycle, credentials, and the fact that results must be fetched separately are all omitted.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three sentences plus a pricing block is appropriately sized, and the results-specificity note is front-loaded after the opening claim. However, the opening sentence is the least accurate part (it describes output rather than the action), and stray zero-width characters pad the beginning.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a task-submission endpoint with a rich body schema and a fetch sibling, the description omits the essential async contract: that this enqueues work, that results arrive via the corresponding fetch tool or pingback/postback URL, and that asin is effectively required despite the empty top-level required list. An agent cannot call this correctly on the description alone.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description contributes nothing about parameters; the top-level body array has no description and coverage is reported at 0%. Nested item properties in the schema are richly documented (asin, priority, location/language alternatives, pingback/postback), which saves the description from being the sole source, but the description does not compensate for the top-level gap or explain the array-of-tasks structure.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific resource (Amazon sellers for a product) and enumerates the returned data (condition, pricing, shipment, rating), but it frames the tool as a data provider ('This endpoint provides a list of sellers') when the tool actually submits a task for later retrieval. The verb/submit action is only conveyed by the name and title, and nothing distinguishes it from get_dataforseo_merchant_amazon_sellers_fetch. Purpose is inferable but muddied.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no guidance on when to submit a task versus calling the fetch sibling, nor any mention of the async submit-then-retrieve workflow. The only usage hint is that results depend on location and language settings, which is context rather than alternative-selection guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
This endpoint provides data on a product listed on Google Shopping, including product description, images, rating, variations, specifications and sellers. In order to set a task, you have to specify one of the following fields: product_id, data_docid, or gid.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare destructive=true, non-idempotent and open-world, so the bar is lower. The description adds the useful billing context ('usage-based billing; default estimate $0.012 USD'), which is genuine added value. It omits, however, that this queues an asynchronous task whose results must be retrieved separately, which matters for a write-style submission.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences are front-loaded before a clearly delimited pricing block, and nothing is padded. The only weakness is the slightly misleading opening clause, not verbosity.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be described. Still missing is the key operational context that submission is asynchronous and that results require a follow-up retrieval call, plus any note on task queuing/idempotency behavior the annotations imply.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Reported schema coverage is 0%, though the nested schema is in fact richly documented. The description adds little beyond the schema, only naming product_id, data_docid, and gid as the mutually-exclusive identifiers required to set a task. For the sole body parameter, this is adequate but not compensating for the coverage gap.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens by describing the returned payload ('provides data on a product listed on Google Shopping') rather than the action, which can be confused with the sibling fetch tools (get_dataforseo_merchant_google_product_info_fetch). The second sentence does clarify that a task is set, but the verb+resource framing is muddled and does not cleanly differentiate submit from fetch.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It states an invocation prerequisite ('you have to specify one of the following fields: product_id, data_docid, or gid'), which implies how the tool is used. However, there is no guidance on when to choose this submit tool over the fetch/sibling tools, nor any mention of the async task workflow or polling.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
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.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description contradicts the annotations: it states the endpoint 'will provide you with the list of products,' implying a read operation, while annotations declare destructiveHint=true and readOnlyHint=false. This is a serious inconsistency that could lead an agent to misuse the tool.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is brief and includes a relevant billing note, but it is not front-loaded with the tool's action. The first sentence focuses on output rather than the submission operation, which is a structural weakness.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the complexity of the nested request body and the existence of sibling fetch tools, the description is incomplete. It does not explain the asynchronous task-submission nature, how to retrieve results, or the relationship to other tools.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description adds no information about the input parameters. With schema description coverage reported as 0%, the description must compensate, but it only describes output fields instead of explaining how to populate the request body.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description restates the API endpoint's output (list of products) rather than stating the tool's action. It implies direct retrieval, but the tool name and annotations indicate a task submission operation, making the description misleading about the tool's core purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
No guidance on when to use this tool versus alternatives. It does not mention that this submits an asynchronous task, nor does it name sibling tools like get_dataforseo_merchant_google_products_fetch for immediate results.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Queues the reviews of one Google Shopping product, returning a task id. Identify the product with product_id plus gid or data_docid from a products result. This family is asynchronous throughout: submit returns a task id in tasks[0].id, and the fetch tool returns the result once it is ready. fetching is free, and re-fetching costs nothing. Retrieve with get_dataforseo_merchant_google_reviews_fetch.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true and non-idempotency, so the mutation profile is covered. The description adds real context beyond that: the async model, the exact task id location (tasks[0].id), and that fetching/re-fetching is free. It does not explain why the operation is flagged destructive, which is the one unexplained gap.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Three tightly written sentences with the core action front-loaded and the retrieval path at the end. The 'fetching is free, and re-fetching costs nothing' sentence is slightly redundant with the pricing block but still earns its place as cost guidance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For an async submit tool with annotations and an output schema, the description covers purpose, identity requirements, async lifecycle, and cost. Return-value details are rightly delegated to the output schema, leaving only minor omissions around task limits or uniqueness checks.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The description clarifies the product-identity combination (product_id plus gid or data_docid), which is meaningful routing information. However, the reported schema description coverage is 0% at the top level, and the description covers none of the other inputs (depth, priority, location/language variants, pingback/postback), so it only partially compensates.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names a specific verb and resource ('Queues the reviews of one Google Shopping product') and states the immediate return artifact (a task `id`). It is clearly distinguishable from the fetch sibling, which it names explicitly, so an agent can route between submit and retrieve without opening either schema.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives the follow-up step ('Retrieve with get_dataforseo_merchant_google_reviews_fetch') and explains the asynchronous submit/fetch contract, which tells the agent when this tool is the right entry point. It lacks explicit when-not conditions (e.g. don't reuse a task id, don't call fetch before completion) but the workflow guidance is clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Google Shopping Sellers endpoint will provide you with the list of top 10 sellers that listed the specified product on Google Shopping. The provided data for each seller includes related product base and total price, shipment and purchase details and special offers. The results are specific to the selected location (see the List of Locations) and language (see the List of Languages) settings.
Usage-based billing; Default request estimate: $0.012 USD (not a fixed price). Account-specific pricing and final settlement may differ.
| Name | Required | Description | Default |
|---|---|---|---|
| body | No |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, openWorldHint=true, and idempotentHint=false, so the safety profile is covered. The description adds genuine non-obvious context: results depend on location/language settings and a usage-based billing estimate (~$0.012) that the annotations do not convey. However it never explains the async task lifecycle or that billing scales with depth and granularity.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is front-loaded with the endpoint blurb followed by a pricing block, which is reasonable ordering. But much of the text is generic DataForSEO endpoint marketing copy and an HTML billing placeholder rather than content specific to the task-submission action, so several sentences do not earn their place for this tool.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
An output schema exists, so return values need not be explained. Yet for an async task-creation tool with a rich parameter set, the description omits the task model (results are fetched via the sibling fetch endpoint) and says nothing about the required product identifiers, leaving an agent underspecified about how to invoke it successfully.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Top-level schema description coverage is reported at 0% (the single 'body' parameter is undocumented), so the description is expected to compensate but largely does not. The only parameter-level signal is the passing mention of location and language settings; the required-identifier logic (product_id/gid/data_docid) and cost-bearing options like depth and get_shops_on_google are not addressed in the description at all.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description names the resource ('Google Shopping Sellers endpoint') and its output (top 10 sellers for a product), but never states the actual action this tool performs — submitting an asynchronous task. The verb is only implied by the 'submit' in the name and the 'Tasks' in the title. It also fails to distinguish itself from its sibling get_dataforseo_merchant_google_sellers_fetch, which retrieves the same data.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
There is no statement of when to use this tool versus alternatives. The sibling set contains both a 'submit' and a 'fetch' variant for the same sellers data, and the description gives no guidance on which to pick or that this creates a task whose results must be retrieved later. No prerequisites or exclusion conditions are provided.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Discover AIsa tools and Plans for external data or actions. Skip tasks that only need supplied content or general knowledge. For multi-step tasks, search the full goal before decomposing it. Use English; put identifiers in known_fields. If has_full_schema=false, call batch_get_schema. Next call batch_quote, not batch_use. Do not search for standalone rewriting, translation, summarization, formatting, or calculations on supplied content. For one capability, use an atomic query. Select a matching capability, date window, and metric. A Plan may cover only part of the task; assess its purpose and follow next_steps_guidance.
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of additional direct tool candidates. | |
| query | Yes | Natural-language capability or task to discover. | |
| category | No | Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.) | |
| session_id | No | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. | |
| known_fields | No | Known values such as ticker, URL, provider, or identifier that improve retrieval. | |
| provider_filters | No | Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown. |
| Name | Required | Description |
|---|---|---|
| plan | No | |
| tools | Yes | |
| search_id | Yes | |
| session_id | Yes | Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created. |
| retrieval_mode | No | |
| next_steps_guidance | Yes |
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds workflow behavior the annotations cannot: the has_full_schema flag gates a required batch_get_schema call, and the next step after search is batch_quote, not batch_use. It stops short of disclosing retrieval limits or catalog breadth that would push it to a 5.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
It is a dense run of imperatives rather than flowing prose, but each sentence carries a distinct rule (scope, language, workflow branch, negative cases, result interpretation) and the most important scoping guidance is front-loaded. Slightly more compression would help.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
With an output schema present, the description need not explain return values, and it correctly avoids doing so while still referencing the output fields that drive the workflow (has_full_schema, next_steps_guidance). A mutation-free, well-annotated search tool is adequately covered, though catalog scope ('AIsa-only', no external providers) could be stated more explicitly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so the structured baseline is 3. The description adds genuine meaning beyond the schema by telling the agent to write the query in English and to place tickers, URLs, providers, or identifiers in known_fields, which is non-obvious routing guidance for a nested free-form object.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description opens with a specific verb+resource: 'Discover AIsa tools and Plans for external data or actions.' It also separates this discovery step from the sibling execution tools by naming batch_get_schema, batch_quote, and batch_use and stating when each follows, so an agent can place it in the workflow without opening schemas.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It gives explicit when-to-use ('tasks needing external data or actions'), when-not ('tasks that only need supplied content or general knowledge'; no standalone rewriting, translation, summarization, formatting, or calculations), and named alternatives (batch_get_schema when has_full_schema=false, batch_quote rather than batch_use). It also specifies query language and atomic-query style, leaving little to inference.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
deprecated, use batch_use instead
| Name | Required | Description | Default |
|---|---|---|---|
| arguments | No | Arguments matching input_schema / arguments_schema | |
| search_id | No | search_id from the search that found this operation | |
| operation_id | Yes | operation_id as returned by search | |
| max_price_usd | No | Refuse the call before any spend if its quoted price is above this many USD |
| Name | Required | Description |
|---|---|---|
No output parameters | ||
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=false, destructiveHint=true, and openWorldHint=true, so the agent knows this is a state-changing, open-world operation. The description adds only the deprecation status and says nothing about what gets mutated, spend behavior (despite a max_price_usd param), or authorization needs.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single clause with zero waste; the deprecation notice and the replacement are front-loaded. It is terse by design for a deprecated endpoint, though it is under-specified rather than optimally efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Has an output schema and annotations, which reduces the burden, but a 4-parameter operation tool with a deprecation notice gives no information about what it executes or whether it remains functional. For an agent deciding between this and batch_use, the description is thin.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so all four parameters (operation_id, arguments, search_id, max_price_usd) are already documented in the schema. The description adds no parameter meaning on top, so the baseline 3 applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description never states what the tool does — no verb or resource. It only labels the tool as deprecated and points to a replacement, leaving the actual capability ('Run an AIsa operation' from the title) unexplained. An agent must infer the purpose from the title and schema alone.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
It explicitly routes the agent to the alternative ('use batch_use instead'), which is exactly the guidance needed for a deprecated tool. It doesn't explain when, if ever, this tool should still be called (e.g., during a migration window), so it stops short of a 5.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
accountget_detailspost_dataforseo_merchant_amazon_asin_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "asin": "B0756FCPPN",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "asin": {
+ "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_amazon_products_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "keyword": "shoes",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "department": {
- "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "department": {
+ "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_amazon_sellers_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "asin": "B085RFFC9Q",
- "language_code": "en",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "asin": {
+ "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_product_info_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_products_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "keyword": "iphone",
- "language_code": "en",
- "location_code": 2840,
- "price_min": 5
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&tbs=ppr_max:50,p_ord:rv</code> – sort by <em>review score</em> with the <em>maximum price of 50 USD.</em>;<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_sellers_submit1 field changedInput schema / properties / body / items / oneOfPrevious value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "additional_specifications": {
- "additionalProperties": {
- "type": [
- "string",
- "null"
- ]
- },
- "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
- "type": [
- "object",
- "null"
- ]
- },
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
- "type": [
- "integer",
- "null"
- ]
- },
- "get_shops_on_google": {
- "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
- "type": [
- "boolean",
- "null"
- ]
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "pvf": {
- "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]New value: +[
+ {
+ "properties": {
+ "additional_specifications": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "get_shops_on_google": {
+ "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "pvf": {
+ "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_amazon_asin_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "asin": "B0756FCPPN",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B0756FCPPN",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_amazon_products_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "shoes",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "department": {
- "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "shoes",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "department": {
+ "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_amazon_sellers_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "asin": "B085RFFC9Q",
- "language_code": "en",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B085RFFC9Q",
+ "language_code": "en",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_product_info_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_products_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "iphone",
- "language_code": "en",
- "location_code": 2840,
- "price_min": 5
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "iphone",
+ "language_code": "en",
+ "location_code": 2840,
+ "price_min": 5
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]post_dataforseo_merchant_google_sellers_submit2 fields changedInput schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "additional_specifications": {
- "additionalProperties": {
- "type": [
- "string",
- "null"
- ]
- },
- "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
- "type": [
- "object",
- "null"
- ]
- },
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
- "type": [
- "integer",
- "null"
- ]
- },
- "get_shops_on_google": {
- "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
- "type": [
- "boolean",
- "null"
- ]
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "pvf": {
- "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / oneOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "additional_specifications": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "get_shops_on_google": {
+ "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "pvf": {
+ "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionRemoved value: -"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +falseInput schema / properties / calls / items / propertiesAdded value: +{
+ "arguments": {
+ "additionalProperties": true,
+ "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
+ "type": "object"
+ },
+ "call_id": {
+ "description": "Caller-chosen identifier unique within this batch.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "tool": {
+ "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
+ "minLength": 1,
+ "type": "string"
+ }
+}Input schema / properties / calls / items / requiredAdded value: +[
+ "call_id",
+ "tool",
+ "arguments"
+]Input schema / properties / calls / maxItemsAdded value: +20Input schema / properties / calls / minItemsAdded value: +1Input schema / properties / max_price_usdRemoved value: -{
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Per-call price cap applied to every item"
-}Input schema / properties / search_id / anyOfRemoved value: -[
- {
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / search_id / defaultRemoved value: -nullInput schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search."Input schema / properties / search_id / typeAdded value: +"string"Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / $defsAdded value: +{
+ "jsonValue": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "object"
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON value returned by the upstream tool."
+ }
+}Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesAdded value: +{
+ "batch_id": {
+ "type": "string"
+ },
+ "error_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "results": {
+ "items": {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "call_id": {
+ "type": "string"
+ },
+ "customer_cost_micros_usd": {
+ "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "data": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "retryable": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "validation",
+ "authentication",
+ "payment",
+ "permission",
+ "rate_limit",
+ "upstream",
+ "timeout",
+ "internal"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "status",
+ "retryable"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "request_id": {
+ "type": "string"
+ },
+ "successful": {
+ "type": "boolean"
+ },
+ "tool": {
+ "type": "string"
+ },
+ "upstream_status": {
+ "description": "HTTP status returned by AIsaServices when a request was dispatched.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "call_id",
+ "tool",
+ "successful",
+ "request_id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+ },
+ "success_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "total_count": {
+ "minimum": 1,
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "session_id",
+ "batch_id",
+ "total_count",
+ "success_count",
+ "error_count",
+ "results",
+ "next_steps_guidance"
+]get_dataforseo_merchant_amazon_asin_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_asin_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_languages1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_locations1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_sellers_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_languages1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_locations1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_product_info_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_details13 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsRemoved value: -{
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
-}Input schema / properties / include_arguments_schemaAdded value: +{
+ "default": true,
+ "description": "Return the complete arguments_schema. Defaults to true.",
+ "type": "boolean"
+}Input schema / properties / include_documentation / descriptionPrevious value: -"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."New value: +"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."Input schema / properties / include_response_schemaAdded value: +{
+ "default": false,
+ "description": "Return the complete response_schema. Defaults to false.",
+ "type": "boolean"
+}Input schema / properties / operation_idRemoved value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "One operation_id from search"
-}Input schema / properties / operation_idsRemoved value: -{
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Up to 20 operation_ids, for a batch"
-}Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Input schema / properties / toolsAdded value: +{
+ "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
+ "items": {
+ "minLength": 1,
+ "pattern": "^\\S(?:.*\\S)?$",
+ "type": "string"
+ },
+ "maxItems": 20,
+ "minItems": 1,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / with_quoteRemoved value: -{
- "default": true,
- "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
- "type": "boolean"
-}Input schema / requiredAdded value: +[
+ "tools"
+]Output schema / propertiesAdded value: +{
+ "error_count": {
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer"
+ },
+ "tools": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "canonical_operation_id": {
+ "type": "string"
+ },
+ "documentation": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "error": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "idempotent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "read_only": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "response_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "side_effects": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "successful": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "successful"
+ ],
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "total_count": {
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "error_count",
+ "next_steps_guidance",
+ "session_id",
+ "success_count",
+ "tools",
+ "total_count"
+]post_dataforseo_merchant_amazon_asin_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "asin": "B0756FCPPN",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B0756FCPPN",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "asin": {
- "description": "product ID required field unique product identifier (ASIN) in Amazon you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
- "type": "string"
- },
- "language_code": {
- "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
- "type": "string"
- },
- "language_name": {
- "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
- "type": "string"
- },
- "location_code": {
- "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "asin"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_amazon_products_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "shoes",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "shoes",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "department": {
+ "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "department": {
- "description": "amazon product department optional field specify one of the following amazon departments for extracting product listings: \"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
- "type": "string"
- },
- "language_code": {
- "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
- "type": "string"
- },
- "language_name": {
- "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
- "type": "string"
- },
- "location_code": {
- "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
- "type": "integer"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "price_max": {
- "description": "maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
- "type": "integer"
- },
- "price_min": {
- "description": "minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
- "type": "integer"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
- "type": "string"
- },
- "search_param": {
- "description": "additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example: &low-price=52 – search for products that cost more than 52 USD; &high-price=45 – search for products that cost less than 45 USD; &sort=relevancerank – sort results by relevance; &sort=featured-rank – sort results by featured products; &sort=price-asc-rank – sort by ascending price; &sort=price-desc-rank – sort by descending price; &sort=review-rank – sort by the average customer reviews value; &sort=date-desc-rank – sort by the newest arrival Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
- "type": "string"
- },
- "sort_by": {
- "description": "results sorting rules optional field the following sorting rules are supported: relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival example: sort_by:\"relevance\" Note: if you specify sort_by, the search_param parameter will be ignored",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- },
- "url": {
- "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_amazon_sellers_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "asin": "B085RFFC9Q",
+ "language_code": "en",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B085RFFC9Q",
+ "language_code": "en",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "asin": {
- "description": "unique product identifier on Amazon required field you can get this value making a separate request to the Amazon Products endpoint note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon example: B085RFFC9Q learn more about the identifier in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_US",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United States)",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.co.uk, amazon.com.au, amazon.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "asin"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_product_info_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "product_id"
- ]
- },
- {
- "required": [
- "data_docid"
- ]
- },
- {
- "required": [
- "gid"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "data_docid": {
- "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
- "type": "string"
- },
- "gid": {
- "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype optional field corresponds to the datatype that will be sent to your server possible values: advanced",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "product_id": {
- "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_products_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "iphone",
+ "language_code": "en",
+ "location_code": 2840,
+ "price_min": 5
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "iphone",
+ "language_code": "en",
+ "location_code": 2840,
+ "price_min": 5
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>\n\nFor current API pricing, see the published x-aisa-pricing metadata. Where supported, obtain a quote for your exact request.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
- "type": "integer"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "price_max": {
- "description": "maximum product price optional field maximum price of the returned products listed on Google Shopping for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
- "type": "integer"
- },
- "price_min": {
- "description": "minimum product price optional field minimum price of the returned products listed on Google Shopping for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
- "type": "integer"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "search_param": {
- "description": "additional parameters of the search query optional field you can use the following search URL parameters for customizing the search; example: &tbs=ppr_min:45 – search for products that cost more than 45 USD; &tbs=ppr_max:50 – search for products that cost less than 50 USD; &tbs=p_ord:p – sort by ascending price; &tbs=p_ord:pd – sort by descending price; &tbs=p_ord:rv – sort by review score; &tbs=ppr_max:50,p_ord:rv – sort by review score with the maximum price of 50 USD.; &udm=28 – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum depth is 200; this parameter must be specified without tbm=shop in the url; &shoprs=$value – specify advanced filtering and sorting in the new Shopping markup; replace $value with a string in protobuf Base64 format; learn more on our help center. Note that search_param values will be ignored if any of the following parameters are used: price_min, price_max, sort_by",
- "type": "string"
- },
- "sort_by": {
- "description": "results sorting rules optional field the following sorting rules are supported: review_score, price_low_to_high, price_high_to_low example: sort_by:\"review_score\" Note: if you specify sort_by, the search_param parameter will be ignored",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- },
- "url": {
- "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."New value: +"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. the cost can be calculated on the Pricing page."post_dataforseo_merchant_google_sellers_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "product_id"
- ]
- },
- {
- "required": [
- "data_docid"
- ]
- },
- {
- "required": [
- "gid"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "additional_specifications": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "get_shops_on_google": {
+ "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "pvf": {
+ "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "additional_specifications": {
- "description": "object containing additional url parameters you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint example: \"additional_specifications\": { \"eto\": \"16157121050167572763_0\" }",
- "type": "object"
- },
- "data_docid": {
- "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional charges if the search engine returns more than 10 results",
- "type": "integer"
- },
- "get_shops_on_google": {
- "description": "include “buy on Google” shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be doubled",
- "type": "boolean"
- },
- "gid": {
- "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "product_id": {
- "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "pvf": {
- "description": "product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs",
- "type": "string"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truesearch17 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfRemoved value: -[
- {
- "enum": [
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / category / defaultRemoved value: -nullInput schema / properties / category / descriptionPrevious value: -"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."New value: +"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"Input schema / properties / category / enumAdded value: +[
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+]Input schema / properties / category / typeAdded value: +"string"Input schema / properties / known_fieldsAdded value: +{
+ "additionalProperties": true,
+ "default": {},
+ "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
+ "type": "object"
+}Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates."Input schema / properties / limit / maximumAdded value: +20Input schema / properties / limit / minimumAdded value: +1Input schema / properties / provider_filtersAdded value: +{
+ "default": [],
+ "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / query / descriptionPrevious value: -"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."New value: +"Natural-language capability or task to discover."Input schema / properties / query / maxLengthAdded value: +2000Input schema / properties / query / minLengthAdded value: +1Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / propertiesAdded value: +{
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "canonical_use_case": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan_ref": {
+ "type": "string"
+ },
+ "primary_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "recommended_steps": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "related_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "canonical_use_case",
+ "description",
+ "known_pitfalls",
+ "plan_ref",
+ "primary_tools",
+ "recommended_steps",
+ "related_tools"
+ ]
+ },
+ "retrieval_mode": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "search_id": {
+ "type": "string"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "has_full_schema": {
+ "type": "boolean"
+ },
+ "match_reasons": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "price": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "retrieval_debug": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "fused_rank": {
+ "type": "integer"
+ },
+ "fused_score": {
+ "type": "number"
+ },
+ "lexical_rank": {
+ "type": "integer"
+ },
+ "lexical_score": {
+ "type": "number"
+ },
+ "rerank_admission_rank": {
+ "type": "integer"
+ },
+ "rerank_rank": {
+ "type": "integer"
+ },
+ "rerank_score": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "runtime_availability": {
+ "type": "string"
+ },
+ "vector_view_ranks": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "vector_view_scores": {
+ "additionalProperties": {
+ "type": "number"
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "fused_rank",
+ "fused_score",
+ "lexical_rank",
+ "lexical_score",
+ "rerank_admission_rank",
+ "rerank_rank",
+ "runtime_availability",
+ "vector_view_ranks",
+ "vector_view_scores"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tool": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description",
+ "has_full_schema",
+ "price",
+ "summary",
+ "tool"
+ ],
+ "type": "object"
+ }
+ }
+}Output schema / requiredAdded value: +[
+ "next_steps_guidance",
+ "search_id",
+ "session_id",
+ "tools"
+]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if it would cost more than this many USD"New value: +"Refuse the call before any spend if its quoted price is above this many USD"batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionAdded value: +"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -falseNew value: +trueInput schema / properties / calls / items / propertiesRemoved value: -{
- "arguments": {
- "additionalProperties": true,
- "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
- "type": "object"
- },
- "call_id": {
- "description": "Caller-chosen identifier unique within this batch.",
- "maxLength": 128,
- "minLength": 1,
- "type": "string"
- },
- "tool": {
- "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
- "minLength": 1,
- "type": "string"
- }
-}Input schema / properties / calls / items / requiredRemoved value: -[
- "call_id",
- "tool",
- "arguments"
-]Input schema / properties / calls / maxItemsRemoved value: -20Input schema / properties / calls / minItemsRemoved value: -1Input schema / properties / max_price_usdAdded value: +{
+ "anyOf": [
+ {
+ "type": "number"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Per-call price cap applied to every item"
+}Input schema / properties / search_id / anyOfAdded value: +[
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+]Input schema / properties / search_id / defaultAdded value: +nullInput schema / properties / search_id / descriptionPrevious value: -"Optional search correlation identifier returned by search."New value: +"search_id from the search that found these operations"Input schema / properties / search_id / typeRemoved value: -"string"Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Output schema / $defsRemoved value: -{
- "jsonValue": {
- "anyOf": [
- {
- "additionalProperties": {
- "$ref": "#/$defs/jsonValue"
- },
- "type": "object"
- },
- {
- "items": {
- "$ref": "#/$defs/jsonValue"
- },
- "type": "array"
- },
- {
- "type": "string"
- },
- {
- "type": "number"
- },
- {
- "type": "boolean"
- },
- {
- "type": "null"
- }
- ],
- "description": "JSON value returned by the upstream tool."
- }
-}Output schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesRemoved value: -{
- "batch_id": {
- "type": "string"
- },
- "error_count": {
- "minimum": 0,
- "type": "integer"
- },
- "next_steps_guidance": {
- "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "results": {
- "items": {
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "additionalProperties": false,
- "properties": {
- "call_id": {
- "type": "string"
- },
- "customer_cost_micros_usd": {
- "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
- "minimum": 0,
- "type": "integer"
- },
- "data": {
- "$ref": "#/$defs/jsonValue"
- },
- "error": {
- "anyOf": [
- {
- "$schema": "https://json-schema.org/draft/2020-12/schema",
- "additionalProperties": false,
- "properties": {
- "message": {
- "type": "string"
- },
- "retryable": {
- "type": "boolean"
- },
- "status": {
- "type": "integer"
- },
- "type": {
- "enum": [
- "validation",
- "authentication",
- "payment",
- "permission",
- "rate_limit",
- "upstream",
- "timeout",
- "internal"
- ],
- "type": "string"
- }
- },
- "required": [
- "type",
- "status",
- "retryable"
- ],
- "type": "object"
- },
- {
- "type": "null"
- }
- ]
- },
- "request_id": {
- "type": "string"
- },
- "successful": {
- "type": "boolean"
- },
- "tool": {
- "type": "string"
- },
- "upstream_status": {
- "description": "HTTP status returned by AIsaServices when a request was dispatched.",
- "type": "integer"
- }
- },
- "required": [
- "call_id",
- "tool",
- "successful",
- "request_id"
- ],
- "type": "object"
- },
- "type": "array"
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
- },
- "success_count": {
- "minimum": 0,
- "type": "integer"
- },
- "total_count": {
- "minimum": 1,
- "type": "integer"
- }
-}Output schema / requiredRemoved value: -[
- "session_id",
- "batch_id",
- "total_count",
- "success_count",
- "error_count",
- "results",
- "next_steps_guidance"
-]get_dataforseo_merchant_amazon_asin_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_asin_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_languages1 field changedOutput schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_locations1 field changedOutput schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_amazon_sellers_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_languages1 field changedOutput schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_locations1 field changedOutput schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_product_info_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_dataforseo_merchant_google_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"New value: +"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"Input schema / properties / id / exampleRemoved value: -"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultRemoved value: -trueget_details13 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsAdded value: +{
+ "anyOf": [
+ {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
+}Input schema / properties / include_arguments_schemaRemoved value: -{
- "default": true,
- "description": "Return the complete arguments_schema. Defaults to true.",
- "type": "boolean"
-}Input schema / properties / include_documentation / descriptionPrevious value: -"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."New value: +"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."Input schema / properties / include_response_schemaRemoved value: -{
- "default": false,
- "description": "Return the complete response_schema. Defaults to false.",
- "type": "boolean"
-}Input schema / properties / operation_idAdded value: +{
+ "anyOf": [
+ {
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "One operation_id from search"
+}Input schema / properties / operation_idsAdded value: +{
+ "anyOf": [
+ {
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "default": null,
+ "description": "Up to 20 operation_ids, for a batch"
+}Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Input schema / properties / toolsRemoved value: -{
- "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
- "items": {
- "minLength": 1,
- "pattern": "^\\S(?:.*\\S)?$",
- "type": "string"
- },
- "maxItems": 20,
- "minItems": 1,
- "type": "array",
- "uniqueItems": true
-}Input schema / properties / with_quoteAdded value: +{
+ "default": true,
+ "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
+ "type": "boolean"
+}Input schema / requiredRemoved value: -[
- "tools"
-]Output schema / propertiesRemoved value: -{
- "error_count": {
- "type": "integer"
- },
- "next_steps_guidance": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]{1,128}$",
- "type": "string"
- },
- "success_count": {
- "type": "integer"
- },
- "tools": {
- "additionalProperties": {
- "additionalProperties": false,
- "properties": {
- "arguments_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "canonical_operation_id": {
- "type": "string"
- },
- "documentation": {
- "additionalProperties": true,
- "type": "object"
- },
- "error": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "code": {
- "type": "string"
- },
- "message": {
- "type": "string"
- }
- },
- "required": [
- "code",
- "message"
- ]
- },
- "execution_supported": {
- "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
- "type": "boolean"
- },
- "execution_unsupported_reason": {
- "description": "Why execution and quoting remain unavailable through this router.",
- "type": "string"
- },
- "idempotent": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "known_pitfalls": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "read_only": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "boolean"
- }
- ]
- },
- "response_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "side_effects": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "successful": {
- "type": "boolean"
- }
- },
- "required": [
- "successful"
- ],
- "type": "object"
- },
- "type": "object"
- },
- "total_count": {
- "type": "integer"
- }
-}Output schema / requiredRemoved value: -[
- "error_count",
- "next_steps_guidance",
- "session_id",
- "success_count",
- "tools",
- "total_count"
-]post_dataforseo_merchant_amazon_asin_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "asin": "B0756FCPPN",
- "language_code": "en_US",
- "location_code": 2840
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "not": {
+ "required": [
+ "postback_url"
+ ]
+ }
+ },
+ {
+ "required": [
+ "postback_data"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "asin": "B0756FCPPN",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "asin": {
+ "description": "product ID required field unique product identifier (ASIN) in Amazon you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_data": {
+ "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "asin"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_merchant_amazon_products_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "keyword": "shoes",
- "language_code": "en_US",
- "location_code": 2840
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "not": {
+ "required": [
+ "postback_url"
+ ]
+ }
+ },
+ {
+ "required": [
+ "postback_data"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "shoes",
- "language_code": "en_US",
- "location_code": 2840
- }
- ],
- "properties": {
- "department": {
- "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "department": {
+ "description": "amazon product department optional field specify one of the following amazon departments for extracting product listings: \"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
+ "type": "string"
+ },
+ "depth": {
+ "description": "parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
+ "type": "integer"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_data": {
+ "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "price_max": {
+ "description": "maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
+ "type": "integer"
+ },
+ "price_min": {
+ "description": "minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
+ "type": "integer"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
+ "type": "string"
+ },
+ "search_param": {
+ "description": "additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example: &low-price=52 – search for products that cost more than 52 USD; &high-price=45 – search for products that cost less than 45 USD; &sort=relevancerank – sort results by relevance; &sort=featured-rank – sort results by featured products; &sort=price-asc-rank – sort by ascending price; &sort=price-desc-rank – sort by descending price; &sort=review-rank – sort by the average customer reviews value; &sort=date-desc-rank – sort by the newest arrival Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
+ "type": "string"
+ },
+ "sort_by": {
+ "description": "results sorting rules optional field the following sorting rules are supported: relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival example: sort_by:\"relevance\" Note: if you specify sort_by, the search_param parameter will be ignored",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ },
+ "url": {
+ "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_merchant_amazon_sellers_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "asin": "B085RFFC9Q",
- "language_code": "en",
- "location_code": 2840
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "not": {
+ "required": [
+ "postback_url"
+ ]
+ }
+ },
+ {
+ "required": [
+ "postback_data"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "asin": "B085RFFC9Q",
- "language_code": "en",
- "location_code": 2840
- }
- ],
- "properties": {
- "asin": {
- "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "asin": {
+ "description": "unique product identifier on Amazon required field you can get this value making a separate request to the Amazon Products endpoint note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon example: B085RFFC9Q learn more about the identifier in this help center guide",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_US",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United States)",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 2840",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: London,England,United Kingdom",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_data": {
+ "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.co.uk, amazon.com.au, amazon.de, etc.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "asin"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_merchant_google_product_info_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "product_id"
+ ]
+ },
+ {
+ "required": [
+ "data_docid"
+ ]
+ },
+ {
+ "required": [
+ "gid"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "data_docid": {
+ "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
+ "type": "string"
+ },
+ "gid": {
+ "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_data": {
+ "description": "postback_url datatype optional field corresponds to the datatype that will be sent to your server possible values: advanced",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "product_id": {
+ "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_merchant_google_products_submit8 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "keyword": "iphone",
- "language_code": "en",
- "location_code": 2840,
- "price_min": 5
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "not": {
+ "required": [
+ "postback_url"
+ ]
+ }
+ },
+ {
+ "required": [
+ "postback_data"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "keyword": "iphone",
- "language_code": "en",
- "location_code": 2840,
- "price_min": 5
- }
- ],
- "properties": {
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "keyword": {
- "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
- "type": [
- "integer",
- "null"
- ]
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
- "type": "string"
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "price_max": {
- "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "price_min": {
- "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "integer",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "search_param": {
- "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&tbs=ppr_max:50,p_ord:rv</code> – sort by <em>review score</em> with the <em>maximum price of 50 USD.</em>;<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "sort_by": {
- "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- },
- "url": {
- "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "depth": {
+ "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results.",
+ "type": "integer"
+ },
+ "keyword": {
+ "description": "keyword required field you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
+ "type": "integer"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_data": {
+ "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "price_max": {
+ "description": "maximum product price optional field maximum price of the returned products listed on Google Shopping for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
+ "type": "integer"
+ },
+ "price_min": {
+ "description": "minimum product price optional field minimum price of the returned products listed on Google Shopping for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
+ "type": "integer"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
+ "type": "string"
+ },
+ "search_param": {
+ "description": "additional parameters of the search query optional field you can use the following search URL parameters for customizing the search; example: &tbs=ppr_min:45 – search for products that cost more than 45 USD; &tbs=ppr_max:50 – search for products that cost less than 50 USD; &tbs=p_ord:p – sort by ascending price; &tbs=p_ord:pd – sort by descending price; &tbs=p_ord:rv – sort by review score; &tbs=ppr_max:50,p_ord:rv – sort by review score with the maximum price of 50 USD.; &udm=28 – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum depth is 200; this parameter must be specified without tbm=shop in the url; &shoprs=$value – specify advanced filtering and sorting in the new Shopping markup; replace $value with a string in protobuf Base64 format; learn more on our help center. Note that search_param values will be ignored if any of the following parameters are used: price_min, price_max, sort_by",
+ "type": "string"
+ },
+ "sort_by": {
+ "description": "results sorting rules optional field the following sorting rules are supported: review_score, price_low_to_high, price_high_to_low example: sort_by:\"review_score\" Note: if you specify sort_by, the search_param parameter will be ignored",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ },
+ "url": {
+ "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc",
+ "type": "string"
+ }
+}Input schema / properties / body / items / requiredAdded value: +[
+ "keyword"
+]Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truepost_dataforseo_merchant_google_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. the cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_google_sellers_submit7 fields changedInput schema / properties / body / exampleRemoved value: -[
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
-]Input schema / properties / body / items / allOfAdded value: +[
+ {
+ "anyOf": [
+ {
+ "required": [
+ "location_name"
+ ]
+ },
+ {
+ "required": [
+ "location_code"
+ ]
+ },
+ {
+ "required": [
+ "location_coordinate"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "language_name"
+ ]
+ },
+ {
+ "required": [
+ "language_code"
+ ]
+ }
+ ]
+ },
+ {
+ "anyOf": [
+ {
+ "required": [
+ "product_id"
+ ]
+ },
+ {
+ "required": [
+ "data_docid"
+ ]
+ },
+ {
+ "required": [
+ "gid"
+ ]
+ }
+ ]
+ }
+]Input schema / properties / body / items / anyOfRemoved value: -[
- {
- "example": [
- {
- "language_code": "en",
- "location_code": 2840,
- "product_id": "1113158713975221117"
- }
- ],
- "properties": {
- "additional_specifications": {
- "additionalProperties": {
- "type": [
- "string",
- "null"
- ]
- },
- "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
- "type": [
- "object",
- "null"
- ]
- },
- "data_docid": {
- "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
- "type": "string"
- },
- "depth": {
- "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
- "type": [
- "integer",
- "null"
- ]
- },
- "get_shops_on_google": {
- "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
- "type": [
- "boolean",
- "null"
- ]
- },
- "gid": {
- "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "language_code": {
- "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
- "type": "string"
- },
- "language_name": {
- "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
- "type": "string"
- },
- "location_code": {
- "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
- "type": "string"
- },
- "location_name": {
- "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
- "type": "string"
- },
- "pingback_url": {
- "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "postback_data": {
- "type": [
- "string",
- "null"
- ]
- },
- "postback_url": {
- "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
- "type": [
- "string",
- "null"
- ]
- },
- "priority": {
- "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
- "type": [
- "integer",
- "null"
- ]
- },
- "product_id": {
- "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
- "type": "string"
- },
- "pvf": {
- "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
- "type": [
- "string",
- "null"
- ]
- },
- "se_domain": {
- "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
- "type": [
- "string",
- "null"
- ]
- },
- "tag": {
- "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
- "type": [
- "string",
- "null"
- ]
- }
- },
- "type": "object"
- }
-]Input schema / properties / body / items / propertiesAdded value: +{
+ "additional_specifications": {
+ "description": "object containing additional url parameters you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint example: \"additional_specifications\": { \"eto\": \"16157121050167572763_0\" }",
+ "type": "object"
+ },
+ "data_docid": {
+ "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
+ "type": "string"
+ },
+ "depth": {
+ "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional charges if the search engine returns more than 10 results",
+ "type": "integer"
+ },
+ "get_shops_on_google": {
+ "description": "include “buy on Google” shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be doubled",
+ "type": "boolean"
+ },
+ "gid": {
+ "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
+ "type": "string"
+ },
+ "priority": {
+ "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
+ "type": "integer"
+ },
+ "product_id": {
+ "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
+ "type": "string"
+ },
+ "pvf": {
+ "description": "product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
+ "type": "string"
+ }
+}Input schema / properties / body / items / typePrevious value: -[
- "object",
- "null"
-]New value: +"object"Input schema / requiredPrevious value: -[]New value: +[
+ "body"
+]Output schema / x-fastmcp-wrap-resultRemoved value: -truesearch17 fields changedInput schema / $schemaRemoved value: -"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfAdded value: +[
+ {
+ "enum": [
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+ ],
+ "type": "string"
+ },
+ {
+ "type": "null"
+ }
+]Input schema / properties / category / defaultAdded value: +nullInput schema / properties / category / descriptionPrevious value: -"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"New value: +"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."Input schema / properties / category / enumRemoved value: -[
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
-]Input schema / properties / category / typeRemoved value: -"string"Input schema / properties / known_fieldsRemoved value: -{
- "additionalProperties": true,
- "default": {},
- "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
- "type": "object"
-}Input schema / properties / limit / descriptionPrevious value: -"Maximum number of additional direct tool candidates."New value: +"Maximum candidates, 1-10"Input schema / properties / limit / maximumRemoved value: -20Input schema / properties / limit / minimumRemoved value: -1Input schema / properties / provider_filtersRemoved value: -{
- "default": [],
- "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
- "items": {
- "type": "string"
- },
- "maxItems": 50,
- "type": "array",
- "uniqueItems": true
-}Input schema / properties / query / descriptionPrevious value: -"Natural-language capability or task to discover."New value: +"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."Input schema / properties / query / maxLengthRemoved value: -2000Input schema / properties / query / minLengthRemoved value: -1Input schema / properties / session_idRemoved value: -{
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "pattern": "^[A-Za-z0-9_-]*$",
- "type": "string"
-}Output schema / propertiesRemoved value: -{
- "next_steps_guidance": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "plan": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "canonical_use_case": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "known_pitfalls": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "plan_ref": {
- "type": "string"
- },
- "primary_tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "recommended_steps": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "related_tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- }
- },
- "required": [
- "canonical_use_case",
- "description",
- "known_pitfalls",
- "plan_ref",
- "primary_tools",
- "recommended_steps",
- "related_tools"
- ]
- },
- "retrieval_mode": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "string"
- }
- ]
- },
- "search_id": {
- "type": "string"
- },
- "session_id": {
- "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
- "maxLength": 128,
- "minLength": 1,
- "pattern": "^[A-Za-z0-9_-]{1,128}$",
- "type": "string"
- },
- "tools": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "additionalProperties": false,
- "properties": {
- "arguments_schema": {
- "additionalProperties": true,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ]
- },
- "description": {
- "type": "string"
- },
- "execution_supported": {
- "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
- "type": "boolean"
- },
- "execution_unsupported_reason": {
- "description": "Why execution and quoting remain unavailable through this router.",
- "type": "string"
- },
- "has_full_schema": {
- "type": "boolean"
- },
- "match_reasons": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "array"
- }
- ],
- "items": {
- "type": "string"
- }
- },
- "price": {
- "additionalProperties": true,
- "type": "object"
- },
- "retrieval_debug": {
- "additionalProperties": false,
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "object"
- }
- ],
- "properties": {
- "fused_rank": {
- "type": "integer"
- },
- "fused_score": {
- "type": "number"
- },
- "lexical_rank": {
- "type": "integer"
- },
- "lexical_score": {
- "type": "number"
- },
- "rerank_admission_rank": {
- "type": "integer"
- },
- "rerank_rank": {
- "type": "integer"
- },
- "rerank_score": {
- "anyOf": [
- {
- "type": "null"
- },
- {
- "type": "number"
- }
- ]
- },
- "runtime_availability": {
- "type": "string"
- },
- "vector_view_ranks": {
- "additionalProperties": {
- "type": "integer"
- },
- "type": "object"
- },
- "vector_view_scores": {
- "additionalProperties": {
- "type": "number"
- },
- "type": "object"
- }
- },
- "required": [
- "fused_rank",
- "fused_score",
- "lexical_rank",
- "lexical_score",
- "rerank_admission_rank",
- "rerank_rank",
- "runtime_availability",
- "vector_view_ranks",
- "vector_view_scores"
- ]
- },
- "summary": {
- "type": "string"
- },
- "tool": {
- "type": "string"
- }
- },
- "required": [
- "description",
- "has_full_schema",
- "price",
- "summary",
- "tool"
- ],
- "type": "object"
- }
- }
-}Output schema / requiredRemoved value: -[
- "next_steps_guidance",
- "search_id",
- "session_id",
- "tools"
-]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if its quoted price is above this many USD"New value: +"Refuse the call before any spend if it would cost more than this many USD"batch_get_schemabatch_quotebatch_use18 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / descriptionRemoved value: -"Up to 20 items of {call_id, operation_id, arguments}; steps at the same execution_level of a plan go in one batch"Input schema / properties / calls / items / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / calls / items / additionalPropertiesPrevious value: -trueNew value: +falseInput schema / properties / calls / items / propertiesAdded value: +{
+ "arguments": {
+ "additionalProperties": true,
+ "description": "Strictly schema-compliant arguments using the exact field names and types from this tool's arguments_schema.",
+ "type": "object"
+ },
+ "call_id": {
+ "description": "Caller-chosen identifier unique within this batch.",
+ "maxLength": 128,
+ "minLength": 1,
+ "type": "string"
+ },
+ "tool": {
+ "description": "Exact tool name returned by search or batch_get_schema. Never invent a name.",
+ "minLength": 1,
+ "type": "string"
+ }
+}Input schema / properties / calls / items / requiredAdded value: +[
+ "call_id",
+ "tool",
+ "arguments"
+]Input schema / properties / calls / maxItemsAdded value: +20Input schema / properties / calls / minItemsAdded value: +1Input schema / properties / max_price_usdRemoved value: -{
- "anyOf": [
- {
- "type": "number"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Per-call price cap applied to every item"
-}Input schema / properties / search_id / anyOfRemoved value: -[
- {
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / search_id / defaultRemoved value: -nullInput schema / properties / search_id / descriptionPrevious value: -"search_id from the search that found these operations"New value: +"Optional search correlation identifier returned by search."Input schema / properties / search_id / typeAdded value: +"string"Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / $defsAdded value: +{
+ "jsonValue": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "object"
+ },
+ {
+ "items": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ },
+ {
+ "type": "number"
+ },
+ {
+ "type": "boolean"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "JSON value returned by the upstream tool."
+ }
+}Output schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Output schema / propertiesAdded value: +{
+ "batch_id": {
+ "type": "string"
+ },
+ "error_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "description": "Deterministic next-step instructions derived from this result. Not an authorization grant.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "results": {
+ "items": {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "call_id": {
+ "type": "string"
+ },
+ "customer_cost_micros_usd": {
+ "description": "Actual customer charge settled by AIsaServices, in micro-USD. Omitted when the upstream response does not report it.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "data": {
+ "$ref": "#/$defs/jsonValue"
+ },
+ "error": {
+ "anyOf": [
+ {
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
+ "additionalProperties": false,
+ "properties": {
+ "message": {
+ "type": "string"
+ },
+ "retryable": {
+ "type": "boolean"
+ },
+ "status": {
+ "type": "integer"
+ },
+ "type": {
+ "enum": [
+ "validation",
+ "authentication",
+ "payment",
+ "permission",
+ "rate_limit",
+ "upstream",
+ "timeout",
+ "internal"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type",
+ "status",
+ "retryable"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "request_id": {
+ "type": "string"
+ },
+ "successful": {
+ "type": "boolean"
+ },
+ "tool": {
+ "type": "string"
+ },
+ "upstream_status": {
+ "description": "HTTP status returned by AIsaServices when a request was dispatched.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "call_id",
+ "tool",
+ "successful",
+ "request_id"
+ ],
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+ },
+ "success_count": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "total_count": {
+ "minimum": 1,
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "session_id",
+ "batch_id",
+ "total_count",
+ "success_count",
+ "error_count",
+ "results",
+ "next_steps_guidance"
+]get_dataforseo_merchant_amazon_asin_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_asin_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_languages1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_locations1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_amazon_sellers_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_languages1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_locations1 field changedOutput schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_product_info_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_products_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_products_fetch_html3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>7 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_dataforseo_merchant_google_sellers_fetch3 fields changedInput schema / properties / id / descriptionPrevious value: -"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"New value: +"<em>task identifier</em><br><strong>unique task identifier in our system in the <a href=\"https://en.wikipedia.org/wiki/Universally_unique_identifier\">UUID</a> format</strong><br>you will be able to use it within <strong>30 days</strong> to request the results of the task at any time"Input schema / properties / id / exampleAdded value: +"00000000-0000-0000-0000-000000000000"Output schema / x-fastmcp-wrap-resultAdded value: +trueget_details13 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / argumentsRemoved value: -{
- "anyOf": [
- {
- "additionalProperties": true,
- "type": "object"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "The arguments the operation would be called with, for a price that reflects them. Keyed by operation_id for a batch, or passed flat for a single operation_id. Routes whose required parameters are validated before pricing have no price without them."
-}Input schema / properties / include_arguments_schemaAdded value: +{
+ "default": true,
+ "description": "Return the complete arguments_schema. Defaults to true.",
+ "type": "boolean"
+}Input schema / properties / include_documentation / descriptionPrevious value: -"Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged."New value: +"Return the complete immutable public OpenAPI operation, referenced declarations, provenance and scoped completeness. Documentation does not change execution support."Input schema / properties / include_response_schemaAdded value: +{
+ "default": false,
+ "description": "Return the complete response_schema. Defaults to false.",
+ "type": "boolean"
+}Input schema / properties / operation_idRemoved value: -{
- "anyOf": [
- {
- "type": "string"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "One operation_id from search"
-}Input schema / properties / operation_idsRemoved value: -{
- "anyOf": [
- {
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- {
- "type": "null"
- }
- ],
- "default": null,
- "description": "Up to 20 operation_ids, for a batch"
-}Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Input schema / properties / toolsAdded value: +{
+ "description": "Exact tool names returned by search whose complete contracts are needed. Never invent tool names.",
+ "items": {
+ "minLength": 1,
+ "pattern": "^\\S(?:.*\\S)?$",
+ "type": "string"
+ },
+ "maxItems": 20,
+ "minItems": 1,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / with_quoteRemoved value: -{
- "default": true,
- "description": "Whether each operation is priced for this account before the answer. One round trip per operation; spends nothing.",
- "type": "boolean"
-}Input schema / requiredAdded value: +[
+ "tools"
+]Output schema / propertiesAdded value: +{
+ "error_count": {
+ "type": "integer"
+ },
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "success_count": {
+ "type": "integer"
+ },
+ "tools": {
+ "additionalProperties": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "canonical_operation_id": {
+ "type": "string"
+ },
+ "documentation": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "error": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "code": {
+ "type": "string"
+ },
+ "message": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "code",
+ "message"
+ ]
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "idempotent": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "read_only": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "boolean"
+ }
+ ]
+ },
+ "response_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "side_effects": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "successful": {
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "successful"
+ ],
+ "type": "object"
+ },
+ "type": "object"
+ },
+ "total_count": {
+ "type": "integer"
+ }
+}Output schema / requiredAdded value: +[
+ "error_count",
+ "next_steps_guidance",
+ "session_id",
+ "success_count",
+ "tools",
+ "total_count"
+]post_dataforseo_merchant_amazon_asin_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "asin": "B0756FCPPN",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B0756FCPPN",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>product ID</em><br><strong>required field</strong><br><a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">unique product identifier (ASIN)</a> in Amazon<br>you can receive the <code>asin</code> parameter by making a separate request to the <a href=\"/v3/merchant/amazon/products/task_post/\" target=\"_blank\" rel=\"noopener noreferrer\">Amazon Products endpoint</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>n",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.com</code></em>, <em><code>amazon.co.uk</code></em>, <em><code>amazon.fr</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "asin": {
- "description": "product ID required field unique product identifier (ASIN) in Amazon you can receive the asin parameter by making a separate request to the Amazon Products endpoint",
- "type": "string"
- },
- "language_code": {
- "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
- "type": "string"
- },
- "language_name": {
- "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
- "type": "string"
- },
- "location_code": {
- "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969n",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "asin"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_amazon_products_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "shoes",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "shoes",
+ "language_code": "en_US",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "department": {
+ "description": "<em>amazon product department</em><br>optional field<br>specify one of the following amazon departments for extracting product listings:<br><code>\"Arts & Crafts\"</code>, <code>\"Automotive\"</code>, <code>\"Baby\"</code>, <code>\"Beauty & Personal Care\"</code>, <code>\"Books\"</code>, <code>\"Computers\"</code>, <code>\"Digital Music\"</code>, <code>\"Electronics\"</code>, <code>\"Kindle Store\"</code>, <code>\"Prime Video\"</code>, <code>\"Women's Fashion\"</code>, <code>\"Men's Fashion\"</code>, <code>\"Girls' Fashion\"</code>, <code>\"Boys' Fashion\"</code>, <code>\"Deals\"</code>, <code>\"Health & Household\"</code>, <code>\"Home & Kitchen\"</code>, <code>\"Industrial & Scientific\"</code>, <code>\"Luggage\"</code>, <code>\"Movies & TV\"</code>, <code>\"Music, CDs & Vinyl\"</code>, <code>\"Pet Supplies\"</code>, <code>\"Software\"</code>, <code>\"Sports & Outdoors\"</code>, <code>\"Tools & Home Improvement\"</code>, <code>\"Toys & Games\"</code>, <code>\"Video Games\"</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from the Amazon results page<br>default value: <code>100</code><br>max value: <code>700</code><br><strong>Your account will be billed per each SERP containing up to 100 results;</strong> <br>Setting depth above 100 may result in additional charges if the search engine returns more than 100 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in this field<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>search engine language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available languages with their <code>language_code</code>_parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_GB</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of search engine language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available languages with their <code>language_name</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United Kingdom)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>search engine location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_code</code> parameters by making a separate request to the<br><code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">9045969</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of search engine location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available locations with their <code>location_name</code> parameters by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">HA1,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Amazon for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Amazon for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>amazon.com</em></code>, <code><em>amazon.co.uk</em></code>, <code><em>amazon.fr</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following Amazon search URL parameters for customizing the search<br>example:<br><code>&low-price=52</code> - search for products that cost <em>more than 52 USD</em>;<br><code>&high-price=45</code> - search for products that cost <em>less than 45 USD</em>;<br><code>&sort=relevancerank</code> - sort results by <em>relevance</em>;<br><code>&sort=featured-rank</code> - sort results by <em>featured</em> products;<br><code>&sort=price-asc-rank</code> - sort by <em>ascending price</em>;<br><code>&sort=price-desc-rank</code> - sort by <em>descending price</em>;<br><code>&sort=review-rank</code> - sort by the average <em>customer reviews</em> value;<br><code>&sort=date-desc-rank</code> - sort by the <em>newest arrival</em><br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters is used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>relevance</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code>, <code>featured</code>, <code>avg_customer_review</code>, <code>newest_arrival</code><br>example:<br><code>sort_by:\"relevance\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.amazon.com/s/?field-keywords=shoes&language=en_US</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "department": {
- "description": "amazon product department optional field specify one of the following amazon departments for extracting product listings: \"Arts & Crafts\", \"Automotive\", \"Baby\", \"Beauty & Personal Care\", \"Books\", \"Computers\", \"Digital Music\", \"Electronics\", \"Kindle Store\", \"Prime Video\", \"Women's Fashion\", \"Men's Fashion\", \"Girls' Fashion\", \"Boys' Fashion\", \"Deals\", \"Health & Household\", \"Home & Kitchen\", \"Industrial & Scientific\", \"Luggage\", \"Movies & TV\", \"Music, CDs & Vinyl\", \"Pet Supplies\", \"Software\", \"Sports & Outdoors\", \"Tools & Home Improvement\", \"Toys & Games\", \"Video Games\"",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field you can specify up to 700 characters in this field all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
- "type": "string"
- },
- "language_code": {
- "description": "search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB",
- "type": "string"
- },
- "language_name": {
- "description": "full name of search engine language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available languages with their language_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United Kingdom)",
- "type": "string"
- },
- "location_code": {
- "description": "search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of search engine location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available locations with their location_name parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: HA1,England,United Kingdom",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
- "type": "integer"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "price_max": {
- "description": "maximum product price optional field maximum price of the returned products listed on Amazon for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
- "type": "integer"
- },
- "price_min": {
- "description": "minimum product price optional field minimum price of the returned products listed on Amazon for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
- "type": "integer"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.com, amazon.co.uk, amazon.fr, etc.",
- "type": "string"
- },
- "search_param": {
- "description": "additional parameters of the search query optional field you can use the following Amazon search URL parameters for customizing the search example: &low-price=52 – search for products that cost more than 52 USD; &high-price=45 – search for products that cost less than 45 USD; &sort=relevancerank – sort results by relevance; &sort=featured-rank – sort results by featured products; &sort=price-asc-rank – sort by ascending price; &sort=price-desc-rank – sort by descending price; &sort=review-rank – sort by the average customer reviews value; &sort=date-desc-rank – sort by the newest arrival Note that search_param values will be ignored if any of the following parameters is used: price_min, price_max, sort_by",
- "type": "string"
- },
- "sort_by": {
- "description": "results sorting rules optional field the following sorting rules are supported: relevance, price_low_to_high, price_high_to_low, featured, avg_customer_review, newest_arrival example: sort_by:\"relevance\" Note: if you specify sort_by, the search_param parameter will be ignored",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- },
- "url": {
- "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.amazon.com/s/?field-keywords=shoes&language=en_US",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_amazon_sellers_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "asin": "B085RFFC9Q",
+ "language_code": "en",
+ "location_code": 2840
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "asin": "B085RFFC9Q",
+ "language_code": "en",
+ "location_code": 2840
+ }
+ ],
+ "properties": {
+ "asin": {
+ "description": "<em>unique product identifier on Amazon</em><br><strong>required field</strong><br>you can get this value making a separate request to <a href=\"/v3/merchant/amazon/products/task_post\">the Amazon Products endpoint</a><br>note that there is no full list of possible values as the <code>asin</code> values is a dynamic value assigned by Amazon<br>example:<br><code>B085RFFC9Q</code><br>learn more about the identifier in <a href=\"https://dataforseo.com/help-center/asin-in-amazon-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Amazon languages with their <code>language_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en_US</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Amazon languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/languages</code><br>example:<br><code class=\"long-string\">English (United States)</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Amazon locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/amazon/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/amazon-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>amazon.co.uk</code></em>, <em><code>amazon.com.au</code></em>, <em><code>amazon.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "asin": {
- "description": "unique product identifier on Amazon required field you can get this value making a separate request to the Amazon Products endpoint note that there is no full list of possible values as the asin values is a dynamic value assigned by Amazon example: B085RFFC9Q learn more about the identifier in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Amazon languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_US",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Amazon languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: English (United States)",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Amazon locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: amazon.co.uk, amazon.com.au, amazon.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "asin"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_product_info_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "product_id"
- ]
- },
- {
- "required": [
- "data_docid"
- ]
- },
- {
- "required": [
- "gid"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br>optional field<br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</code>, <code>google.com.au</code>, <code>google.de</code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "data_docid": {
- "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
- "type": "string"
- },
- "gid": {
- "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype optional field corresponds to the datatype that will be sent to your server possible values: advanced",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "product_id": {
- "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_products_submit8 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "keyword": "iphone",
+ "language_code": "en",
+ "location_code": 2840,
+ "price_min": 5
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "not": {
- "required": [
- "postback_url"
- ]
- }
- },
- {
- "required": [
- "postback_data"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "keyword": "iphone",
+ "language_code": "en",
+ "location_code": 2840,
+ "price_min": 5
+ }
+ ],
+ "properties": {
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>40</code><br>max value: <code>120</code><br><strong>Your account will be billed per each SERP containing up to 40 results;</strong> <br>Setting depth above 40 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 40 results</a>;<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "keyword": {
+ "description": "<em>keyword</em><br><strong>required field</strong><br>you can specify <strong>up to 700 characters</strong> in the <code>keyword</code> filed<br><strong>all %## will be decoded (plus character ‘+’ will be decoded to a space character)</strong><br>if you need to use the “%” character for your <code>keyword</code>, please specify it as “%25”;<p>learn more about rules and limitations of <code>keyword</code> and <code>keywords</code> fields in DataForSEO APIs in this <a href=\"https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis\" rel=\"noopener noreferrer\" target=\"_blank\">Help Center article</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "max_crawl_pages": {
+ "description": "<em>page crawl limit</em><br>optional field<br>number of search results pages to crawl<br>max value: <code>7</code><br><strong>Note:</strong> the <code>max_crawl_pages</code> and <code>depth</code> parameters complement each other;<br>learn more at <a href=\"https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work\" rel=\"noopener noreferrer\" target=\"_blank\">our help center</a>",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "description": "<em>postback_url datatype</em><br><strong>required field if you specify <code>postback_url</code></strong><br>corresponds to the datatype that will be sent to your server<br>possible values:<br><code>advanced</code>, <code>html</code>",
+ "type": "string"
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "price_max": {
+ "description": "<em>maximum product price</em><br>optional field<br>maximum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>100</code><br><strong>Note:</strong> if you specify <code>price_max</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "price_min": {
+ "description": "<em>minimum product price</em><br>optional field<br>minimum price of the returned products listed on Google Shopping for the specified query<br>example:<br><code>5</code><br><strong>Note:</strong> if you specify <code>price_min</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><code><em>google.co.uk</em></code>, <code><em>google.com.au</em></code>, <code><em>google.de</em></code>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "search_param": {
+ "description": "<em>additional parameters of the search query</em><br>optional field<br>you can use the following search URL parameters for customizing the search;<br>example:<br><code>&tbs=ppr_min:45</code> – search for products that cost <em>more than 45 USD</em>;<br><code>&tbs=ppr_max:50</code> – search for products that cost <em>less than 50 USD</em>;<br><code>&tbs=p_ord:p</code> – sort by <em>ascending price</em>;<br><code>&tbs=p_ord:pd</code> – sort by <em>descending price</em>;<br><code>&tbs=p_ord:rv</code> – sort by <em>review score</em>;<br><code>&tbs=ppr_max:50,p_ord:rv</code> – sort by <em>review score</em> with the <em>maximum price of 50 USD.</em>;<br><code>&udm=28</code> – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum <code>depth</code> is 200; this parameter must be specified without <code>tbm=shop</code> in the <code>url</code>;<br><code>&shoprs=$value</code> – specify advanced filtering and sorting in the new Shopping markup; replace <code>$value</code> with a string in protobuf Base64 format; <a href=\"https://dataforseo.com/help-center/using-the-shoprs-parameter-in-google-shopping-merchant-api\" target=\"_blank\">learn more on our help center.</a><br> <br><strong>Note</strong> that <code>search_param</code> values will be ignored if any of the following parameters are used: <code>price_min</code>, <code>price_max</code>, <code>sort_by</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "sort_by": {
+ "description": "<em>results sorting rules</em><br>optional field<br>the following sorting rules are supported:<br><code>review_score</code>, <code>price_low_to_high</code>, <code>price_high_to_low</code><br>example:<br><code>sort_by:\"review_score\"</code><br><strong>Note:</strong> if you specify <code>sort_by</code>, the <code>search_param</code> parameter will be ignored",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "url": {
+ "description": "<em>direct URL of the search query</em><br>optional field<br>you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method.<br>example:<br><code class=\"long-string\">https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results.",
- "type": "integer"
- },
- "keyword": {
- "description": "keyword required field you can specify up to 700 characters in the keyword filed all %## will be decoded (plus character ‘+’ will be decoded to a space character) if you need to use the “%” character for your keyword, please specify it as “%25”; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "max_crawl_pages": {
- "description": "page crawl limit optional field number of search results pages to crawl max value: 7 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center",
- "type": "integer"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_data": {
- "description": "postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: advanced, html",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "price_max": {
- "description": "maximum product price optional field maximum price of the returned products listed on Google Shopping for the specified query example: 100 Note: if you specify price_max, the search_param parameter will be ignored",
- "type": "integer"
- },
- "price_min": {
- "description": "minimum product price optional field minimum price of the returned products listed on Google Shopping for the specified query example: 5 Note: if you specify price_min, the search_param parameter will be ignored",
- "type": "integer"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "search_param": {
- "description": "additional parameters of the search query optional field you can use the following search URL parameters for customizing the search; example: &tbs=ppr_min:45 – search for products that cost more than 45 USD; &tbs=ppr_max:50 – search for products that cost less than 50 USD; &tbs=p_ord:p – sort by ascending price; &tbs=p_ord:pd – sort by descending price; &tbs=p_ord:rv – sort by review score; &tbs=ppr_max:50,p_ord:rv – sort by review score with the maximum price of 50 USD.; &udm=28 – use new Google Shopping markup with 40 SERP results returned by default (the cost for one SERP is deducted accordingly); the maximum depth is 200; this parameter must be specified without tbm=shop in the url; &shoprs=$value – specify advanced filtering and sorting in the new Shopping markup; replace $value with a string in protobuf Base64 format; learn more on our help center. Note that search_param values will be ignored if any of the following parameters are used: price_min, price_max, sort_by",
- "type": "string"
- },
- "sort_by": {
- "description": "results sorting rules optional field the following sorting rules are supported: review_score, price_low_to_high, price_high_to_low example: sort_by:\"review_score\" Note: if you specify sort_by, the search_param parameter will be ignored",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- },
- "url": {
- "description": "direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.google.com/search?q=fish&hl=en&gl=US&gws_rd=cr&uule=w+CAIQIFISCQs2MuSEtepUEUK33kOSuTsc",
- "type": "string"
- }
-}Input schema / properties / body / items / requiredRemoved value: -[
- "keyword"
-]Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truepost_dataforseo_merchant_google_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."New value: +"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. the cost can be calculated on the Pricing page."post_dataforseo_merchant_google_sellers_submit7 fields changedInput schema / properties / body / exampleAdded value: +[
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+]Input schema / properties / body / items / allOfRemoved value: -[
- {
- "anyOf": [
- {
- "required": [
- "location_name"
- ]
- },
- {
- "required": [
- "location_code"
- ]
- },
- {
- "required": [
- "location_coordinate"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "language_name"
- ]
- },
- {
- "required": [
- "language_code"
- ]
- }
- ]
- },
- {
- "anyOf": [
- {
- "required": [
- "product_id"
- ]
- },
- {
- "required": [
- "data_docid"
- ]
- },
- {
- "required": [
- "gid"
- ]
- }
- ]
- }
-]Input schema / properties / body / items / anyOfAdded value: +[
+ {
+ "example": [
+ {
+ "language_code": "en",
+ "location_code": 2840,
+ "product_id": "1113158713975221117"
+ }
+ ],
+ "properties": {
+ "additional_specifications": {
+ "additionalProperties": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "description": "<em>object containing additional url parameters</em><br>you can get additional information about the product by using the <code>\"additional_specifications</code> object, which you can get by making a separate request to the <a href=\"/v3/merchant/google/products/task_post\">Google Shopping Products endpoint</a><br>example:<br><code>\"additional_specifications\": {<br>\"eto\": \"16157121050167572763_0\"<br>}</code>",
+ "type": [
+ "object",
+ "null"
+ ]
+ },
+ "data_docid": {
+ "description": "<em>unique identifier of the SERP data element</em><br><strong>required field if <code>product_id</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>data_docid</code> together with <code>product_id</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain element by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>13071766526042404278</code>",
+ "type": "string"
+ },
+ "depth": {
+ "description": "<em>parsing depth</em><br>optional field<br>number of results to be retrieved from Google Shopping SERP<br>default value: <code>10</code><br>max value: <code>200</code><br><strong>your account will be billed per each SERP containing up to 10 results;</strong> <br>setting depth above 10 may result in additional charges <a href=\"https://dataforseo.com/help-center/how-many-results-scraped\" rel=\"noopener noreferrer\" target=\"_blank\">if the search engine returns more than 10 results</a>;<br>the cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "get_shops_on_google": {
+ "description": "<em>include \"buy on Google\" shops</em><br>optional field<br>if set to <code>true</code>, the response will contain the list of sellers that allow to purchase a given product directly on Google<br>Note: if set to <code>true</code>, the cost of a task will be doubled",
+ "type": [
+ "boolean",
+ "null"
+ ]
+ },
+ "gid": {
+ "description": "<em>global product identifier on Google Shopping</em><br><strong>required field if <code>product_id</code> or <code>data_docid</code> is not specified</strong><br>we recommend specifying <code>gid</code> together with <code>product_id</code> and <code>data_docid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4702526954592161872</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/whats-a-gid-in-google-shopping-api\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "language_code": {
+ "description": "<em>language code</em><br><strong>required field if you don't specify</strong> <code>language_name</code><br><strong>if you use this field, you don't need to specify <code>language_name</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_code</code>_by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><em><br></em>example:<em><br></em><code class=\"long-string\">en</code>",
+ "type": "string"
+ },
+ "language_name": {
+ "description": "<em>full name of the language</em><br><strong>required field if you don't specify</strong> <code>language_code</code><br><strong>if you use this field, you don't need to specify <code>language_code</code></strong><br>you can receive the list of available Google Shopping languages with their <code>language_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/languages</code><br>example:<br><code class=\"long-string\">English</code>",
+ "type": "string"
+ },
+ "location_code": {
+ "description": "<em>location code</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_code</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">2840</code>",
+ "type": "integer"
+ },
+ "location_coordinate": {
+ "description": "<em>GPS coordinates of a location</em><br><strong>required field if you don't specify</strong> <code>location_name</code>_or <code>location_code</code><br><strong>if you use this field, you don't need to specify <code>location_name</code> or <code>location_code</code></strong><br><code>location_coordinate</code> parameter should be specified in the <em>\"latitude,longitude,radius\"</em> format<br>the maximum number of decimal digits for <em>\"latitude\"</em> and <em>\"longitude\"</em>: 7<br>the minimum value for <em>\"radius\"</em>: 199.9<br>example:<br><code class=\"long-string\">53.476225,-2.243572,200</code>",
+ "type": "string"
+ },
+ "location_name": {
+ "description": "<em>full name of the location</em><br><strong>required field if you don't specify</strong> <code>location_code</code> or <code>location_coordinate</code><br><strong>if you use this field, you don't need to specify <code>location_code</code> or <code>location_coordinate</code></strong><br>you can receive the list of available Google Shopping locations with their <code>location_name</code> by making a separate request to the <code>https://api.dataforseo.com/v3/merchant/google/locations</code><br>example:<br><code class=\"long-string\">London,England,United Kingdom</code>",
+ "type": "string"
+ },
+ "pingback_url": {
+ "description": "<em>notification URL of a completed task</em><br>optional field<br>when a task is completed we will notify you by GET request sent to the URL you have specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/pingscript?id=$id</code><br><code>http://your-server.com/pingscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>pingback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_data": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "postback_url": {
+ "description": "<em>URL for sending task results</em><br>optional field<br>once the task is completed, we will send a POST request with its results compressed in the <code>gzip</code> format to the <code>postback_url</code> you specified<br>you can use the ‘$id’ string as a <code>$id</code> variable and ‘$tag’ as urlencoded <code>$tag</code> variable. We will set the necessary values before sending the request.<br>example:<br><code>http://your-server.com/postbackscript?id=$id</code><br><code>http://your-server.com/postbackscript?id=$id&tag=$tag</code><br><strong>Note:</strong> special characters in <code>postback_url</code> will be urlencoded; <br>i.a., the <code>#</code> character will be encoded into <code>%23</code><p>learn more on our <a href=\"https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api\" target=\"_blank\" rel=\"noopener noreferrer\">Help Center</a>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "priority": {
+ "description": "<em>task priority</em><br>optional field<br>can take the following values:<br>1 – normal execution priority (set by default)<br>2 – high execution priorityYou will be additionally charged for the tasks with high execution priority.<br>The cost can be calculated on the <a title=\"Pricing\" href=\"https://dataforseo.com/pricing/merchant/google-shopping-api\" target=\"_blank\" rel=\"noopener noreferrer\">Pricing</a> page.",
+ "type": [
+ "integer",
+ "null"
+ ]
+ },
+ "product_id": {
+ "description": "<em>unique product identifier on Google Shopping</em><br><strong>required field if <code>data_docid</code> or <code>gid</code> is not specified</strong><br>we recommend specifying <code>product_id</code> together with <code>data_docid</code> and <code>gid</code> for optimal results;<br>you can get this value for a certain product by making a separate request to <a href=\"/v3/merchant/google/products/task_post\">the Google Shopping Products endpoint</a><br>example:<br><code>4485466949985702538</code><br>learn more about the parameter in <a href=\"https://dataforseo.com/help-center/product-id-google-shopping\" rel=\"noopener noreferrer\" target=\"_blank\">this help center guide</a>",
+ "type": "string"
+ },
+ "pvf": {
+ "description": "<em>product variant filter on Google Shopping</em><br>optional field<br>parameter in Google Shopping URL, setting optional product variant filtration;<br>example:<br><code>Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs</code>",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "se_domain": {
+ "description": "<em>search engine domain</em><br>optional field<br>we choose the relevant search engine domain automatically according to the location and language you specify<br>however, you can set a custom search engine domain in this field<br>example:<br><em><code>google.co.uk</code></em>, <em><code>google.com.au</code></em>, <em><code>google.de</code></em>, etc.",
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "tag": {
+ "description": "<em>user-defined task identifier</em><br>optional field<br><em>the character limit is 255</em><br>you can use this parameter to identify the task and match it with the result<br>you will find the specified <code>tag</code> value in the <code>data</code> object of the response",
+ "type": [
+ "string",
+ "null"
+ ]
+ }
+ },
+ "type": "object"
+ }
+]Input schema / properties / body / items / propertiesRemoved value: -{
- "additional_specifications": {
- "description": "object containing additional url parameters you can get additional information about the product by using the \"additional_specifications object, which you can get by making a separate request to the Google Shopping Products endpoint example: \"additional_specifications\": { \"eto\": \"16157121050167572763_0\" }",
- "type": "object"
- },
- "data_docid": {
- "description": "unique identifier of the SERP data element required field if product_id or gid is not specified we recommend specifying data_docid together with product_id and gid for optimal results; you can get this value for a certain element by making a separate request to the Google Shopping Products endpoint example: 13071766526042404278",
- "type": "string"
- },
- "depth": {
- "description": "parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional charges if the search engine returns more than 10 results",
- "type": "integer"
- },
- "get_shops_on_google": {
- "description": "include “buy on Google” shops optional field if set to true, the response will contain the list of sellers that allow to purchase a given product directly on Google Note: if set to true, the cost of a task will be doubled",
- "type": "boolean"
- },
- "gid": {
- "description": "global product identifier on Google Shopping required field if product_id or data_docid is not specified we recommend specifying gid together with product_id and data_docid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4702526954592161872 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "language_code": {
- "description": "language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en",
- "type": "string"
- },
- "language_name": {
- "description": "full name of the language required field if you don’t specify language_code if you use this field, you don’t need to specify language_code you can receive the list of available Google Shopping languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: English",
- "type": "string"
- },
- "location_code": {
- "description": "location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840",
- "type": "integer"
- },
- "location_coordinate": {
- "description": "GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200",
- "type": "string"
- },
- "location_name": {
- "description": "full name of the location required field if you don’t specify location_code or location_coordinate if you use this field, you don’t need to specify location_code or location_coordinate you can receive the list of available Google Shopping locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: London,England,United Kingdom",
- "type": "string"
- },
- "pingback_url": {
- "description": "notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "postback_url": {
- "description": "URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center",
- "type": "string"
- },
- "priority": {
- "description": "task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority.",
- "type": "integer"
- },
- "product_id": {
- "description": "unique product identifier on Google Shopping required field if data_docid or gid is not specified we recommend specifying product_id together with data_docid and gid for optimal results; you can get this value for a certain product by making a separate request to the Google Shopping Products endpoint example: 4485466949985702538 learn more about the parameter in this help center guide",
- "type": "string"
- },
- "pvf": {
- "description": "product variant filter on Google Shopping optional field parameter in Google Shopping URL, setting optional product variant filtration; example: Eg4iBWNvbG9yKgV3aGl0ZRISIgxwYWNrYWdlIHNpemUqAjE0EgoiBHNpemUqAnhs",
- "type": "string"
- },
- "se_domain": {
- "description": "search engine domain optional field we choose the relevant search engine domain automatically according to the location and language you specify however, you can set a custom search engine domain in this field example: google.co.uk, google.com.au, google.de, etc.",
- "type": "string"
- },
- "tag": {
- "description": "user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response",
- "type": "string"
- }
-}Input schema / properties / body / items / typePrevious value: -"object"New value: +[
+ "object",
+ "null"
+]Input schema / requiredPrevious value: -[
- "body"
-]New value: +[]Output schema / x-fastmcp-wrap-resultAdded value: +truesearch17 fields changedInput schema / $schemaAdded value: +"https://json-schema.org/draft/2020-12/schema"Input schema / properties / category / anyOfRemoved value: -[
- {
- "enum": [
- "seo",
- "finance",
- "social",
- "search",
- "sales",
- "mail"
- ],
- "type": "string"
- },
- {
- "type": "null"
- }
-]Input schema / properties / category / defaultRemoved value: -nullInput schema / properties / category / descriptionPrevious value: -"Restrict to one category (seo, finance, social, search, sales, mail). Omit to search everything."New value: +"Restrict retrieval to one category. Omit to search everything. (AIsa-only: tool-router has no equivalent.)"Input schema / properties / category / enumAdded value: +[
+ "seo",
+ "finance",
+ "social",
+ "search",
+ "sales",
+ "mail"
+]Input schema / properties / category / typeAdded value: +"string"Input schema / properties / known_fieldsAdded value: +{
+ "additionalProperties": true,
+ "default": {},
+ "description": "Known values such as ticker, URL, provider, or identifier that improve retrieval.",
+ "type": "object"
+}Input schema / properties / limit / descriptionPrevious value: -"Maximum candidates, 1-10"New value: +"Maximum number of additional direct tool candidates."Input schema / properties / limit / maximumAdded value: +20Input schema / properties / limit / minimumAdded value: +1Input schema / properties / provider_filtersAdded value: +{
+ "default": [],
+ "description": "Optional exact catalog provider keys used to narrow retrieval (for example similarweb). Do not use display brands. Omit this field if the exact key is unknown.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 50,
+ "type": "array",
+ "uniqueItems": true
+}Input schema / properties / query / descriptionPrevious value: -"What you need, in plain language, e.g. 'backlinks of a domain', 'recent tweets by a user', 'insider trades for AAPL'. English works best."New value: +"Natural-language capability or task to discover."Input schema / properties / query / maxLengthAdded value: +2000Input schema / properties / query / minLengthAdded value: +1Input schema / properties / session_idAdded value: +{
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "pattern": "^[A-Za-z0-9_-]*$",
+ "type": "string"
+}Output schema / propertiesAdded value: +{
+ "next_steps_guidance": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "canonical_use_case": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ },
+ "known_pitfalls": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "plan_ref": {
+ "type": "string"
+ },
+ "primary_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "recommended_steps": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "related_tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "required": [
+ "canonical_use_case",
+ "description",
+ "known_pitfalls",
+ "plan_ref",
+ "primary_tools",
+ "recommended_steps",
+ "related_tools"
+ ]
+ },
+ "retrieval_mode": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "search_id": {
+ "type": "string"
+ },
+ "session_id": {
+ "description": "Reuse the session_id returned by Search in all subsequent tool calls for this task. If omitted, a new session is created.",
+ "maxLength": 128,
+ "minLength": 1,
+ "pattern": "^[A-Za-z0-9_-]{1,128}$",
+ "type": "string"
+ },
+ "tools": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "additionalProperties": false,
+ "properties": {
+ "arguments_schema": {
+ "additionalProperties": true,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ]
+ },
+ "description": {
+ "type": "string"
+ },
+ "execution_supported": {
+ "description": "Whether this router can execute and quote the operation; false retains documentation and discovery only.",
+ "type": "boolean"
+ },
+ "execution_unsupported_reason": {
+ "description": "Why execution and quoting remain unavailable through this router.",
+ "type": "string"
+ },
+ "has_full_schema": {
+ "type": "boolean"
+ },
+ "match_reasons": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "array"
+ }
+ ],
+ "items": {
+ "type": "string"
+ }
+ },
+ "price": {
+ "additionalProperties": true,
+ "type": "object"
+ },
+ "retrieval_debug": {
+ "additionalProperties": false,
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "object"
+ }
+ ],
+ "properties": {
+ "fused_rank": {
+ "type": "integer"
+ },
+ "fused_score": {
+ "type": "number"
+ },
+ "lexical_rank": {
+ "type": "integer"
+ },
+ "lexical_score": {
+ "type": "number"
+ },
+ "rerank_admission_rank": {
+ "type": "integer"
+ },
+ "rerank_rank": {
+ "type": "integer"
+ },
+ "rerank_score": {
+ "anyOf": [
+ {
+ "type": "null"
+ },
+ {
+ "type": "number"
+ }
+ ]
+ },
+ "runtime_availability": {
+ "type": "string"
+ },
+ "vector_view_ranks": {
+ "additionalProperties": {
+ "type": "integer"
+ },
+ "type": "object"
+ },
+ "vector_view_scores": {
+ "additionalProperties": {
+ "type": "number"
+ },
+ "type": "object"
+ }
+ },
+ "required": [
+ "fused_rank",
+ "fused_score",
+ "lexical_rank",
+ "lexical_score",
+ "rerank_admission_rank",
+ "rerank_rank",
+ "runtime_availability",
+ "vector_view_ranks",
+ "vector_view_scores"
+ ]
+ },
+ "summary": {
+ "type": "string"
+ },
+ "tool": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "description",
+ "has_full_schema",
+ "price",
+ "summary",
+ "tool"
+ ],
+ "type": "object"
+ }
+ }
+}Output schema / requiredAdded value: +[
+ "next_steps_guidance",
+ "search_id",
+ "session_id",
+ "tools"
+]use1 field changedInput schema / properties / max_price_usd / descriptionPrevious value: -"Refuse the call before any spend if it would cost more than this many USD"New value: +"Refuse the call before any spend if its quoted price is above this many USD"get_details1 field changedInput schema / properties / include_documentationAdded value: +{
+ "default": false,
+ "description": "Include the complete native public OpenAPI document, reference closure and scoped completeness. Existing execution schemas remain unchanged.",
+ "type": "boolean"
+}post_dataforseo_merchant_amazon_asin_submit1 field changedInput schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_amazon_products_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results to be retrieved from the Amazon results page default value: 100 max value: 700 Your account will be billed per each SERP containing up to 100 results; Setting depth above 100 may result in additional charges if the search engine returns more than 100 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_amazon_sellers_submit1 field changedInput schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_google_product_info_submit1 field changedInput schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_google_products_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 40 max value: 120 Your account will be billed per each SERP containing up to 40 results; Setting depth above 40 may result in additional charges if the search engine returns more than 40 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_google_reviews_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page."New value: +"parsing depth optional field number of reviews in SERP; we strongly recommend setting the parsing depth in the multiples of ten, because our system processes ten reviews in a row; maximum value: 8000 default value: 10 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results."Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. the cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."post_dataforseo_merchant_google_sellers_submit2 fields changedInput schema / properties / body / items / properties / depth / descriptionPrevious value: -"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional charges if the search engine returns more than 10 results; the cost can be calculated on the Pricing page"New value: +"parsing depth optional field number of results to be retrieved from Google Shopping SERP default value: 10 max value: 200 your account will be billed per each SERP containing up to 10 results; setting depth above 10 may result in additional charges if the search engine returns more than 10 results"Input schema / properties / body / items / properties / priority / descriptionPrevious value: -"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page."New value: +"task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority."get_dataforseo_merchant_amazon_asin_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_amazon_asin_fetch_html1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_amazon_products_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_amazon_products_fetch_html1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_amazon_sellers_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_amazon_sellers_fetch_html1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_google_product_info_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_google_products_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_google_products_fetch_html1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"get_dataforseo_merchant_google_sellers_fetch1 field changedInput schema / properties / id / descriptionPrevious value: -"DataForSEO task ID."New value: +"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"post_dataforseo_merchant_amazon_asin_submit3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB"New value: +"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969"New value: +"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969n"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"post_dataforseo_merchant_amazon_products_submit3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"search engine language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available languages with their language_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB"New value: +"search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages with their language_code_parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/languages example: en_GB"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"search engine location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969"New value: +"search engine location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations with their location_code parameters by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 9045969"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"post_dataforseo_merchant_amazon_sellers_submit2 fields changedInput schema / properties / body / items / properties / location_code / descriptionPrevious value: -"location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 2840"New value: +"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Amazon locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/amazon/locations example: 2840"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"post_dataforseo_merchant_google_product_info_submit3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Google Shopping languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"New value: +"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"New value: +"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"post_dataforseo_merchant_google_products_submit3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Google Shopping languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"New value: +"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"New value: +"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"post_dataforseo_merchant_google_sellers_submit3 fields changedInput schema / properties / body / items / properties / language_code / descriptionPrevious value: -"language code required field if you don’t specify language_name if you use this field, you don’t need to specify language_name you can receive the list of available Google Shopping languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"New value: +"language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available Google Shopping languages with their language_code_by making a separate request to the https://api.dataforseo.com/v3/merchant/google/languages example: en"Input schema / properties / body / items / properties / location_code / descriptionPrevious value: -"location code required field if you don’t specify location_name or location_coordinate if you use this field, you don’t need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"New value: +"location code required field if you don't specify location_name_or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available Google Shopping locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/merchant/google/locations example: 2840"Input schema / properties / body / items / properties / location_coordinate / descriptionPrevious value: -"GPS coordinates of a location required field if you don’t specify location_name or location_code if you use this field, you don’t need to specify location_name or location_code location_coordinate parameter should be specified in the “latitude,longitude,radius” format the maximum number of decimal digits for “latitude” and “longitude”: 7 the minimum value for “radius”: 199.9 example: 53.476225,-2.243572,200"New value: +"GPS coordinates of a location required field if you don't specify location_name_or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the \"latitude,longitude,radius\" format the maximum number of decimal digits for \"latitude\" and \"longitude\": 7 the minimum value for \"radius\": 199.9 example: 53.476225,-2.243572,200"batch_useget_dataforseo_merchant_amazon_asin_fetchget_dataforseo_merchant_amazon_asin_fetch_htmlget_dataforseo_merchant_amazon_languagesget_dataforseo_merchant_amazon_locationsget_dataforseo_merchant_amazon_products_fetchget_dataforseo_merchant_amazon_products_fetch_htmlget_dataforseo_merchant_amazon_sellers_fetchget_dataforseo_merchant_amazon_sellers_fetch_htmlget_dataforseo_merchant_google_languagesget_dataforseo_merchant_google_locationsget_dataforseo_merchant_google_product_info_fetchget_dataforseo_merchant_google_products_fetchget_dataforseo_merchant_google_products_fetch_htmlget_dataforseo_merchant_google_reviews_fetchget_dataforseo_merchant_google_sellers_fetchget_detailslist_categoriespost_dataforseo_merchant_amazon_asin_submitpost_dataforseo_merchant_amazon_products_submitpost_dataforseo_merchant_amazon_sellers_submitpost_dataforseo_merchant_google_product_info_submitpost_dataforseo_merchant_google_products_submitpost_dataforseo_merchant_google_reviews_submitpost_dataforseo_merchant_google_sellers_submitsearchuseYour agent needs the derived numbers — domain authority, what a site ranks for, related and relevant keywords, search intent, and who the real competitors are — for Google, Amazon and the app stores. **What you can ask for** • "What is this domain's authority, and how has its rank history moved?" • "Which keywords does this site rank for, and with what intent?" • "Who are this domain's organic competitors, and where do we overlap?" • "Which keywords does this Amazon product rank for?" • "Compare these two domains keyword by keyword." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-labs/mcp and sign in with OAuth — there is no key to create or paste. 46 tools: ranked, related and relevant keywords, keyword ideas and intent, domain authority and rank history, competitor and intersection analysis, bulk metrics, plus the same shapes for Amazon products and Apple and Google Play apps. **Why this rather than the source** Ahrefs domain rating, Semrush rank history and DataForSEO Labs answering the same questions side by side. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Size the competitor here, then ask the same agent for their traffic mix or their contacts — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs the Google results page as it actually renders — organic and paid, the AI overview, maps, images, news, jobs and the finance panel — not a scraped guess. **What you can ask for** • "What does the SERP for this keyword look like in Germany, on mobile?" • "Does this query trigger an AI overview, and what does it say?" • "Who is advertising against our brand name?" • "Find local results and the map pack for this phrase." • "Search Google by this image and tell me where else it appears." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-serp/mcp and sign in with OAuth — there is no key to create or paste. 38 tools across Google's surfaces: organic, ads and advertisers, AI mode, autocomplete, images, news, maps and local, events, jobs, datasets, scholar, finance quotes and markets, plus Semrush's organic and paid result sets. **Why this rather than the source** Location and language are parameters, so you can read the page a customer in another country sees. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Read the SERP here, then ask the same agent who links to the winner or how much traffic they get — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo-serp-other-engines/mcp for Bing, Yahoo, Baidu, Naver, Seznam and YouTube. https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs what customers say in public — Google Business profiles and reviews, Trustpilot, Tripadvisor, hotel listings and the Q&A under a listing. **What you can ask for** • "Pull this business's Google reviews and group the complaints." • "What do Trustpilot reviewers say about this competitor?" • "Find hotels matching this search and their live prices." • "What questions are people asking on this Google listing, and are they answered?" • "Search listings for this category in this city." **How to use it** Point any MCP client at https://mcp.aisa.one/seo-business/mcp and sign in with OAuth — there is no key to create or paste. 22 tools: Google Business info, reviews, extended reviews, updates and Q&A; Trustpilot and Tripadvisor search and reviews; Google hotel info and searches; business listing search; plus Reddit and Pinterest signals for a business. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Read the reviews here, then ask the same agent what that business ranks for or who links to it — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** https://mcp.aisa.one/seo/mcp for all of it at once — rankings, keywords, backlinks, site health and AI-answer visibility across DataForSEO, Semrush and Ahrefs.
Your agent needs the whole search picture — what you rank for, who outranks you, who links to them, what is broken on the site, and whether ChatGPT names you at all. Normally that is three SEO vendors and three subscriptions. **What you can ask for** • "What does this domain rank for, and which competitors take the same keywords?" • "Who links to my competitor and not to me?" • "Crawl this site and list the pages with broken tags or duplicate content." • "Does Perplexity cite us when asked about this category?" • "How hard is this keyword, and what does the SERP look like today?" **How to use it** Point any MCP client at https://mcp.aisa.one/seo/mcp and sign in with OAuth — there is no key to create or paste. 60 tools spanning DataForSEO, Semrush and Ahrefs: SERPs, keywords and difficulty, backlinks and referring domains, on-page crawling, domain authority, and answers from ChatGPT, Claude, Gemini and Perplexity. **Why this rather than the source** Three indexes behind one account, so you can cross-check a number instead of trusting one vendor's version of it. **It is also a door to the rest** The same login reaches 26 sources and 580+ operations. Check the ranking here, then ask the same agent for that competitor's traffic mix, its ad spend, or the person to email — without adding a second server. **What it costs** Finding and inspecting an operation is free. Running one is billed per call at API prices, with no seat and no monthly minimum, and every call takes max_price_usd so an agent cannot overspend by accident. **Where else it reaches** Narrower endpoints: https://mcp.aisa.one/seo-serp/mcp · /seo-keywords/mcp · /seo-backlinks/mcp · /seo-onpage/mcp · /seo-labs/mcp · /seo-ai-visibility/mcp · /seo-content/mcp · /seo-domains/mcp · /seo-business/mcp · /seo-merchant/mcp · /seo-apps/mcp · /seo-serp-other-engines/mcp
Add one secure layer between your agents and this server.
