Ebay Sell Marketing
The eBay Sell Marketing API is an interface for managing eBay seller promotions, campaigns, and marketing offers.
- Base URL:
https://api.ebay.com/sell/marketing/v1 - Auth: OAuth 2.0 client-credentials — the tool fetches a token from
https://api.ebay.com/identity/v1/oauth2/tokenusing yourclientId/clientSecret, then calls the API.
Operations
getcampaigns— GET /ad_campaign — This method retrieves the details for all of the seller's defined campaigns. Reqfindcampaignbyadreference— GET /ad_campaign/find_campaign_by_ad_reference — This method retrieves the campaigns containing the listing that is specified usigetcampaignbyname— GET /ad_campaign/get_campaign_by_name — This method retrieves the details of a single campaign, as specified with the <bgetcampaign— GET /ad_campaign/{campaign_id} — This method retrieves the details of a single campaign, as specified with the <bgetads— GET /ad_campaign/{campaign_id}/ad — This method retrieves Promoted Listings ads that are associated with listings crgetad— GET /ad_campaign/{campaign_id}/ad/{ad_id} — This method retrieves the specified ad from the specified campaign.In the r
Inputs
clientId/clientSecret— your ebay-sell-marketing OAuth app credentialsscope— OAuth scopes (optional; defaults from the spec)operation— one of the operations above- path parameters when an operation's path contains
{...} query— optional JSON object of query paramsbody— JSON object for create/update ops
Example
operation: getcampaigns
clientId: <your client id>
clientSecret: <your client secret>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
erroroperationresultstatus
Input Properties
Every property this tool accepts, from its own tool.iml.
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
clientId |
string | yes | — | OAuth client ID for ebay-sell-marketing. |
clientSecret |
string | yes | — | OAuth client secret for ebay-sell-marketing. |
operation |
string | yes | — | One of: getcampaigns, findcampaignbyadreference, getcampaignbyname, getcampaign, getads, getad |
scope |
string | no | https://api.ebay.com/oauth/api_scope |
OAuth scopes (space-separated); default from the spec. |
ad_id |
string | no | — | Path parameter ad_id (required by some operations). |
campaign_id |
string | no | — | Path parameter campaign_id (required by some operations). |
query |
string | no | — | Optional query params as a JSON object string, e.g. {"limit": 10}. |