Sign in

v1

latestOpenAPI 3.0.12026-07-22204678550.0 KB
Campaign

/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets

Create one or more new budgets to enable spending with the given limitations. All three types of budgets can be created this way.

The following constraints apply when creating a new budget.

• <b>sellerId</b>: the seller MUST be supplied<br /> • <b>campaignIds</b>: a non-empty array of campaign ids MUST be supplied<br /> • <b>budgetType</b>: a budget type MUST be supplied<br /> • <b>amount</b>: an amount MAY be supplied only if the type is not Uncapped and if supplied it MUST be non-negative<br /> • <b>startDate</b>: a future start date MUST be supplied<br /> • <b>endDate</b>: an end date MAY be supplied and if supplied MUST be greater than the start date<br />

Other attributes MUST NOT be supplied.

post/2026-01/marketing-solutions/marketplace-performance-outcomes/budgets

Request body

amountstring

Budget amount as a string (e.g. '100.50')

budgetTypestring

Type of budget: 'Daily' (daily cap), 'Capped' (lifetime with fixed amount), or 'Uncapped' (lifetime with no limit)

campaignIdsinteger[]

List of campaign IDs this budget applies to

endDatestring

Budget end date as a string (format: YYYY-MM-DD), or empty string for open-ended

sellerIdstring

Identifier of the seller this budget is for

startDatestring date-time

Budget start date. Time component is ignored.

Response

Success

amountnumber double nullable

Budget amount in the advertiser's currency

budgetTypestring

Type of budget: 'Daily' (daily cap), 'Capped' (lifetime with fixed amount), or 'Uncapped' (lifetime with no limit)

campaignIdsinteger[]

List of campaign IDs this budget applies to

endDatestring

End date of the budget period (format: YYYY-MM-DD), or empty string if open-ended

idstring

Unique budget identifier

isSuspendedboolean

Whether the budget has been manually suspended by the partner

sellerIdstring

Identifier of the seller this budget belongs to

spendnumber double nullable

Amount spent against this budget so far, or null if not available

startDatestring date

Start date of the budget period (format: YYYY-MM-DD)

status'Archived' | 'Current' | 'Scheduled'

Status of a seller budget

Example response

[
  {
    "id": "16501666",
    "sellerId": "10656107",
    "campaignIds": [
      436017
    ],
    "budgetType": "Capped",
    "amount": 462.47,
    "endDate": "2026-04-30",
    "spend": 117.59,
    "status": "Current",
    "isSuspended": false
  }
]