amazon-ads-open-cli
v1.0.3
Published
Amazon Ads CLI for AI agents
Downloads
45
Maintainers
Readme
amazon-ads-open-cli
Amazon Ads CLI for AI agents (and humans). Manage Sponsored Products, Brands, Display, and DSP campaigns across marketplaces, generate async reports, configure brand safety, and more.
Works with: OpenClaw, Claude Code, Cursor, Codex, and any agent that can run shell commands.
Installation
npm install -g amazon-ads-open-cliOr run directly: npx amazon-ads-open-cli --help
How it works
Built on the official Amazon Advertising API (v2/v3). Authenticates via OAuth2 using a Login with Amazon app -- you provide an access token and client ID, scoped to a specific marketplace profile.
Core endpoints covered:
- Profiles -- list and inspect marketplace profiles
- Sponsored Products -- campaigns, ad groups, ads, keywords, negative keywords, targets, and performance reports
- Sponsored Brands -- campaigns, ad groups, targets, and performance reports
- Sponsored Display -- campaigns, ad groups, ads, targets, and performance reports
- Amazon DSP -- orders, line items, creatives, audiences, and brand safety lists
- Reporting -- async report requests and status polling for all ad types
Setup
What you need
- A Login with Amazon app
- OAuth2 access token + client ID
- A profile ID (marketplace-specific, get it with
amazon-ads-open-cli profiles)
Option 1: Environment variables
export AMAZON_ADS_ACCESS_TOKEN="your_access_token"
export AMAZON_ADS_CLIENT_ID="your_client_id"
export AMAZON_ADS_PROFILE_ID="your_profile_id"Option 2: Credentials file
Create ~/.config/amazon-ads-open-cli/credentials.json:
{
"access_token": "your_access_token",
"client_id": "your_client_id",
"profile_id": "your_profile_id"
}Option 3: Per-command credentials
amazon-ads-open-cli profiles --credentials /path/to/creds.jsonEntity hierarchy
Profile (marketplace: US, UK, DE, JP, etc.)
├── Sponsored Products
│ └── Campaign → Ad Group → Product Ad / Keyword / Target
├── Sponsored Brands
│ └── Campaign → Ad Group → Keyword / Target
├── Sponsored Display
│ └── Campaign → Ad Group → Product Ad / Target
└── DSP (programmatic)
├── Advertiser → Order → Line Item → Creative
└── Audience (configured at Line Item level)Profiles and marketplace
Amazon Ads requires a profile ID to scope API calls to a specific marketplace (US, UK, DE, etc.). Use the profiles command first to discover your profile IDs, then set AMAZON_ADS_PROFILE_ID.
Usage
profiles
List advertising profiles (marketplaces) accessible by this account. No profile ID required.
amazon-ads-open-cli profilesprofile
Get a specific advertising profile.
amazon-ads-open-cli profile 1234567890sp-campaigns
List Sponsored Products campaigns.
amazon-ads-open-cli sp-campaigns
amazon-ads-open-cli sp-campaigns --state enabledOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100, max 5000)--state <state>-- filter: enabled, paused, archived
sp-campaign
Get a specific Sponsored Products campaign.
amazon-ads-open-cli sp-campaign 123456sb-campaigns
List Sponsored Brands campaigns.
amazon-ads-open-cli sb-campaignsOptions: same as sp-campaigns
sb-campaign
Get a specific Sponsored Brands campaign.
amazon-ads-open-cli sb-campaign 123456sd-campaigns
List Sponsored Display campaigns.
amazon-ads-open-cli sd-campaignsOptions: same as sp-campaigns
sd-campaign
Get a specific Sponsored Display campaign.
amazon-ads-open-cli sd-campaign 123456sp-adgroups
List Sponsored Products ad groups.
amazon-ads-open-cli sp-adgroups
amazon-ads-open-cli sp-adgroups --campaign-id 123456Options:
--start-index <n>-- start index--count <n>-- results per page--campaign-id <id>-- filter by campaign--state <state>-- filter: enabled, paused, archived
sp-adgroup
Get a specific Sponsored Products ad group.
amazon-ads-open-cli sp-adgroup 789012sb-adgroups
List Sponsored Brands ad groups.
amazon-ads-open-cli sb-adgroupsOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
sd-adgroups
List Sponsored Display ad groups.
amazon-ads-open-cli sd-adgroups --campaign-id 123456Options:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)--campaign-id <id>-- filter by campaign
sp-ads
List Sponsored Products ads (product ads).
amazon-ads-open-cli sp-ads
amazon-ads-open-cli sp-ads --adgroup-id 789012Options:
--start-index <n>-- start index--count <n>-- results per page--adgroup-id <id>-- filter by ad group--state <state>-- filter: enabled, paused, archived
sp-ad
Get a specific Sponsored Products ad.
amazon-ads-open-cli sp-ad 345678sd-ads
List Sponsored Display ads.
amazon-ads-open-cli sd-ads --adgroup-id 789012Options:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)--adgroup-id <id>-- filter by ad group
sp-keywords
List Sponsored Products keywords.
amazon-ads-open-cli sp-keywords
amazon-ads-open-cli sp-keywords --campaign-id 123456 --state enabledOptions:
--start-index <n>-- start index--count <n>-- results per page--adgroup-id <id>-- filter by ad group--campaign-id <id>-- filter by campaign--state <state>-- filter: enabled, paused, archived
sp-negative-keywords
List Sponsored Products negative keywords.
amazon-ads-open-cli sp-negative-keywords --campaign-id 123456Options:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)--adgroup-id <id>-- filter by ad group--campaign-id <id>-- filter by campaign
sp-targets
List Sponsored Products product targets (ASIN and category targeting).
amazon-ads-open-cli sp-targets --adgroup-id 789012Options:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)--adgroup-id <id>-- filter by ad group--state <state>-- filter: enabled, paused, archived
sb-targets
List Sponsored Brands targets.
amazon-ads-open-cli sb-targetsOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
sd-targets
List Sponsored Display targets.
amazon-ads-open-cli sd-targets --adgroup-id 789012Options:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)--adgroup-id <id>-- filter by ad group
sp-report
Request a Sponsored Products performance report (async).
amazon-ads-open-cli sp-report --record-type campaigns --start-date 20260101
amazon-ads-open-cli sp-report --record-type keywords --start-date 20260101 --metrics impressions,clicks,cost,sales14dOptions:
--record-type <type>-- campaigns, adGroups, productAds, keywords, targets required--start-date <date>-- YYYYMMDD required--metrics <metrics>-- comma-separated (default: impressions, clicks, cost, sales14d)
sb-report
Request a Sponsored Brands performance report.
amazon-ads-open-cli sb-report --record-type campaigns --start-date 20260101sd-report
Request a Sponsored Display performance report.
amazon-ads-open-cli sd-report --record-type campaigns --start-date 20260101report-status
Check report generation status and get download URL.
amazon-ads-open-cli report-status amzn1.report.abc123dsp-orders
List DSP orders (programmatic display/video).
amazon-ads-open-cli dsp-ordersOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
dsp-order
Get a specific DSP order.
amazon-ads-open-cli dsp-order 123456dsp-line-items
List DSP line items.
amazon-ads-open-cli dsp-line-items --order-id 123456Options:
--order-id <id>-- filter by order ID--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
dsp-creatives
List DSP creatives.
amazon-ads-open-cli dsp-creativesOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
audiences
List DSP audiences.
amazon-ads-open-cli audiencesOptions:
--start-index <n>-- start index (default 0)--count <n>-- results per page (default 100)
audience
Get a specific audience.
amazon-ads-open-cli audience 123456brand-safety-lists
List brand safety deny lists.
amazon-ads-open-cli brand-safety-listsError output
All errors are JSON to stderr:
{"error": "No credentials found. Set AMAZON_ADS_ACCESS_TOKEN + AMAZON_ADS_CLIENT_ID env vars..."}API Reference
Related
- google-ads-open-cli -- Google Ads
- meta-ads-open-cli -- Meta Ads
- pinterest-ads-cli -- Pinterest Ads
- apple-ads-cli -- Apple Ads
- spotify-ads-cli -- Spotify Ads
License
Apache-2.0
