Campaign Definition

Campaigns returned by the Tophatter Merchant API have the following fields:

Field	Name
`name`	Name of the campaign
`type`	Type of the campaign. Lists of campaign type are listed here.
`daily_budget`	The daily budget of a campaign
`bid_amount`	The SFB fee of a campaign
`status`	Status of a campaign. List of campaign status are listed here.
`daily_budget_per_product`	Daily budget of a campaign per product
`lifetime_budget`	Lifetime budget of a campaign
`lifetime_budget_per_product`	Lifetime budget of a campaign per product

Examples

[
    {
        "name": "$0.1",
        "type": "AuctionCampaign",
        "daily_budget": 500.0,
        "bid_amount": 0.1,
        "status": "Active",
        "daily_budget_per_product": null,
        "lifetime_budget": null,
        "lifetime_budget_per_product": null
    },
    {
        "name": "$0.2",
        "type": "AuctionCampaign",
        "daily_budget": 100000000.0,
        "bid_amount": 0.2,
        "status": "Active",
        "daily_budget_per_product": null,
        "lifetime_budget": 100000000.0,
        "lifetime_budget_per_product": null
    },
    {
        "name": "New Product Extended Promotional Campaign",
        "type": "AuctionCampaign",
        "daily_budget": 5000.0,
        "bid_amount": 1.7,
        "status": "Expired",
        "daily_budget_per_product": null,
        "lifetime_budget": null,
        "lifetime_budget_per_product": null
    },
    {
        "name": "Pre-Buy",
        "type": "AuctionCampaign",
        "daily_budget": 100.0,
        "bid_amount": 0.01,
        "status": "Active",
        "daily_budget_per_product": null,
        "lifetime_budget": 100.0,
        "lifetime_budget_per_product": null
    },
    {
        "name": "test1.0",
        "type": "AuctionCampaign",
        "daily_budget": 2.0,
        "bid_amount": 0.01,
        "status": "Paused",
        "daily_budget_per_product": 1.0,
        "lifetime_budget": 12.0,
        "lifetime_budget_per_product": 12.0
    }
]

Campaign Status

List of campaign status

active: The campaign is currently enabled and available to be scheduled
paused: The campaign is paused
expired: The campaign is expired

Campaign Type

Campaigns will have one of the following types

AuctionCampaign: Sets the campaign in Auction lots
ReminderCampaign: Sets the campaign in Reminder
BuyNowCampaign: Sets the campaign in Buy Now
NameYourPriceCampaign: Sets the campaign in Name Your Price (NYP)