Skip to main content
start_competitor_supplier_inventory Start approved supplier research with explicit consent and a retry identifier. Requires separate operator admission; unavailable until configured. Replays return the saved run. No source-page checks or recurring monitors.
This command name is absent from deployment evidence dated 2026-09-20. Hosted availability for this current definition is unverified; inspect your connected catalog before invoking it. Verify the command and its input schema in the selected environment.
Provider-backed admission requires enabled configuration and available allowance; registration alone does not make retrieval available. Inspect usage and the run’s coverage before interpreting results.

Example request

Connect through MCP, CLI, or HTTP. Replace example identifiers with records from your workspace.

Returned result

Illustrative data validated against the documented response schema. IDs and dates are examples, not a live account capture. MCP returns this data in structuredContent and in a text content block; generic HTTP and CLI return the JSON result directly.

Input fields

Omit optional fields when you do not want to supply them. Null is accepted only where listed. Unknown input properties are rejected.

Validation and omitted values

Requires the saved offer, explicit consent and the same retry identifier for repeated requests. A successful replay returns the original run; changed arguments cannot buy another sample under that identifier. Starting new supplier work requires the saved scope decision to match the configured competitor approval. Approved scope, workspace permissions and existing shared supplier caps are checked before dispatch. Start schedules the bounded supplier coordinator; its queue resumes unfinished admitted work. An uncertain charge is retained for reconciliation and a sent component is not repeated. No automatic source-page checks or recurring monitors are created.

Output fields

Fields inside optional or nullable parents apply only when that parent exists. Common schema conventions explain evidence states, empty lists and extensions.
  • schema_version (number / number, required).
  • id (string, required): Resource identifier returned by the operation. pattern: "^[a-zA-Z0-9_-]{1,128}$"
  • workspace_id (string, required): Workspace that owns this record. pattern: "^[a-zA-Z0-9_-]{1,128}$"
  • competitor_binding (object, optional): additional fields rejected
  • project_id (string, required): Project that owns this record. pattern: "^[a-zA-Z0-9_-]{1,128}$"
  • scope (object, required): additional fields rejected
  • source (string, required): must equal "dataforseo"
  • data_mode (string, required): values: "synthetic", "provider_index"
  • state (string, required): Saved lifecycle or evidence state, as enumerated for this record. values: "queued", "fetching", "checking", "ready", "partial", "empty", "failed", "cancelled", "reconciliation_required"
  • created_at (string, required): UTC timestamp when the record was created. format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}(?:Z))$"
  • updated_at (string, required): UTC timestamp of the last record update. format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}(?:Z))$"
  • execution_deadline (string, required): format: "date-time"; pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}(?:Z))$"
  • timing (object, required): additional fields rejected
  • components (object, required): additional fields rejected
  • summary (object / null, required): Grouped change counts included in this delivery, limited to accessible websites.
  • counts (object, required): additional fields rejected
  • coverage (object, required): Dataset scope and completeness, including limits on what these results establish. additional fields rejected
  • selection (object, required): additional fields rejected
  • recurring_monitoring_created (boolean, required): Whether this operation enrolled recurring monitoring. must equal false
  • recovery (string, required): values: "read_saved_run", "reconcile_receipt", "explicit_new_offer"
  • replayed (boolean, optional): True when the response reuses an earlier request with the same idempotency value.
Download input schema · Download output schema

Errors and retries

When retrying with idempotencyKey, reuse the original value and the same arguments; preserve originally omitted optional fields. Generic HTTP puts idempotencyKey in the JSON body, while resource routes use the header where listed below. A changed payload under a reused key can conflict. See error recovery for status, scope, cooldown, cursor and retry handling. Unknown observations are result data and do not establish loss.

HTTP resource routes

This operation has no separate resource alias. Use its generic command route in a matching environment.

Continue

get_competitor_supplier_inventory · capture_competitor_inventory Follow the related workflow, inspect capability status, or return to the command index.