walmart_keyword_suggestions

Walmart Connect Read

Suggested keywords (with suggested bids) for a Walmart ad group

Endpoint

POST https://api.adspirer.ai/api/v1/tools/walmart_keyword_suggestions/execute

Headers

Description

Suggested keywords (with suggested bids) for a Walmart ad group. Requires ad_group_id.

Request body

All tool arguments are wrapped in an arguments object.

FieldTypeDescription
advertiser_idstring optionalWalmart Advertiser ID. Optional when only one advertiser is connected.
ad_group_idstring optionalWalmart Ad Group ID.
querystring optionalFree-text search across names/ids/text (case-insensitive).
sort_bystring optionalField to sort by (e.g. name, dailyBudget, bid). Unknown/absent values sort last.
sort_orderstring optionalSort direction (default asc). one of: asc, desc
offsetinteger optionalRow offset for paging (default 0).
limitinteger optionalMax rows per page (default 50, capped at 200). The response reports total, filtered and has_more.

Example request

{
  "arguments": {
    "sort_order": "asc"
  }
}

Example responses

200 — Success

{
  "success": true,
  "data": {
    "text": "(tool-specific textual output for walmart_keyword_suggestions)",
    "quota": {
      "used": 42,
      "limit": 150,
      "tier": "plus",
      "period_end": "2026-05-01"
    }
  },
  "tool": "walmart_keyword_suggestions"
}

400 — Tool-level error (bad arguments / multi-account selection)

{
  "success": false,
  "error": "You have 25 meta_ads accounts connected. Please specify which account to use by passing the ad_account_id parameter:\n  - Acme Holdings (ad_account_id=\"act_123456789\")\n  - Acme EU (ad_account_id=\"act_987654321\")",
  "is_error": true,
  "tool": "walmart_keyword_suggestions"
}

402 — Quota exhausted

{
  "success": false,
  "error": "\ud83d\udea8 Monthly limit reached (150/150 tool calls on Plus tier).\nUpgrade to Pro at https://adspirer.ai to keep building.",
  "is_error": true,
  "tool": "walmart_keyword_suggestions",
  "quota": {
    "used": 150,
    "limit": 150,
    "tier": "plus",
    "period_end": "2026-05-01",
    "upgrade_url": "https://adspirer.ai"
  }
}

Try it live


Adspirer REST API — get an API key at adspirer.ai/keys · adspirer.ai