v1

latestOpenAPI 3.0.12026-07-22204678550.0 KB

Campaign

/2026-01/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}

Return details for a seller campaign. For example,

{
    "id": "543210.123456",
    "sellerId": "543210",
    "campaignId": 123456,
    "bid": 1.55,
    "suspendedSince": "2018-07-30T15:15:24.813",
    "suspensionReasons": [
        "NoMoreBudget"
    ]
}

An active seller campaign is one for which the value of suspendedSince is null and the bid is positive. The currency of the bid is the bidCurrency of the associated campaign.

Any active seller campaign must also have an active total (capped or uncapped) budget. It may optionally have an active daily budget as well to further limit spending.

Suspension reasons:

ManuallyStopped: The Seller-Campaign has been manually paused. This is not related to the other suspension reasons.
NoBudgetDefined: No valid budget has been linked to the Seller-Campaign.
NoCpcDefined: No CPC has been set for the Seller-Campaign.
NoMoreBudget: The current budget of the Seller-Campaign has been exhausted.
RemovedFromCatalog: All the products of the Seller-Campaign have been deleted from the catalog.
NotYetStarted: The Seller-Campaign has just been created and has not yet been processed.

get/2026-01/marketing-solutions/marketplace-performance-outcomes/seller-campaigns/{sellerCampaignId}

Path parameters

sellerCampaignIdstring required

Composite id of the seller campaign in the format {sellerId}.{campaignId}, e.g. 2578464.187625.

Response

Success

bidnumber double nullable

Cost-per-click bid in the advertiser's currency. Null means no CPC is defined (seller-campaign will be suspended with NoCpcDefined). Set to 0 to stop delivery.

campaignIdinteger

Identifier of the campaign this seller participates in

idstring

Composite identifier in format {sellerId}.{campaignId}

sellerIdstring

Unique identifier of the seller (merchant)

suspendedSincestring date-time nullable

Timestamp when the seller-campaign was suspended. Null means the seller-campaign is active.

suspensionReasonsSellerCampaignSuspensionReason[] nullable

List of reasons why the seller-campaign is suspended. Null means the seller-campaign is active.

Example response

{
  "id": "10656107.248287",
  "sellerId": "10656107",
  "campaignId": 248287,
  "bid": 0.15,
  "suspendedSince": "2021-03-03T15:14:25.7970000+00:00",
  "suspensionReasons": [
    "NoBudgetDefined"
  ]
}