Get media buy packages

​

Request

curl https://api.interchange.io/api/v2/buyer/media-buys/mb_ETBn4gJ9Wu/packages \
  -H "Authorization: Bearer $SCOPE3_API_KEY"

​

Parameters

​

Response

{
  "mediaBuyId": "mb_ETBn4gJ9Wu",
  "isPaced": true,
  "packageCount": 2,
  "packages": [
    {
      "packageId": "sf_pkg_sf_mb_1783618937177_43ycbp7b_1",
      "productId": "prod_display_300x250",
      "productName": "Display Run of Site",
      "status": "active",
      "pacingPeriod": { "index": 1, "label": "Week 1" },
      "startTime": "2026-08-01T00:00:00Z",
      "endTime": "2026-08-07T23:59:59Z",
      "budget": 5000,
      "budgetCurrency": "USD",
      "pacing": "even",
      "delivery": { "impressions": 210000, "spend": 4980, "clicks": 84 }
    },
    {
      "packageId": "sf_pkg_sf_mb_1783618937177_43ycbp7b_2",
      "productId": "prod_display_300x250",
      "productName": "Display Run of Site",
      "status": "active",
      "pacingPeriod": { "index": 2, "label": "Week 2" },
      "startTime": "2026-08-08T00:00:00Z",
      "endTime": "2026-08-11T23:59:59Z",
      "budget": 5000,
      "budgetCurrency": "USD",
      "pacing": "even"
    }
  ]
}

{
  "mediaBuyId": "mb_ETBn4gJ9Wu",
  "isPaced": true,
  "packageCount": 2,
  "packages": [
    {
      "packageId": "sf_pkg_sf_mb_1781130562070_h0npv6ag_1",
      "productId": "contextual-generative-display-cpc",
      "productName": "Contextual Generative Display (CPC)",
      "status": "active",
      "budget": 634.5,
      "budgetCurrency": "USD",
      "pacing": "even"
    },
    {
      "packageId": "sf_pkg_sf_mb_1781130562070_h0npv6ag_2",
      "productId": "contextual-generative-display-cpc",
      "productName": "Contextual Generative Display (CPC)",
      "status": "active",
      "budget": 634.5,
      "budgetCurrency": "USD",
      "pacing": "even"
    }
  ]
}

• mediaBuyId: the media buy these packages belong to.
• isPaced: whether this buy was split across pacing periods. When true, expect one package per product per period, and use pacingPeriod to tell them apart where it is present. On buys executed before this read shipped, isPaced is true while every package lacks pacingPeriod, and the period cannot be recovered.
• packageCount: how many packages this media buy has.
• packages[]: grouped by product, then ordered by pacingPeriod.index where it is present. Packages with no recorded period sort by packageId as text, which is not dispatch order (..._10 sorts before ..._2). Never read a period out of a package’s position in this array. See the numbering scheme:
  • packageId: the identifier to quote when updating or pausing this package. Opaque, do not parse it.
  • productId: the seller product this package buys. null when the product is not locally resolvable.
  • productName: the product’s name as published by the seller, when known locally.
  • status: active, paused, or canceled. Independent of the media buy’s own status: a live buy can carry a paused package.
  • pacingPeriod: { index, label }. index is a one-based ordinal counting from the campaign’s first period; label is how the campaign named it (“Week 6”). Absent when the buy is not paced, and absent on every package created before period identity was recorded.
  • startTime / endTime: ISO 8601. Present on paced packages executed after this read shipped. Absent on an unpaced buy, where the package runs the media buy’s own window and has no separate one, and absent on packages created before the platform retained the window it requested. Match on pacingPeriod.label where you have it, since that is the buyer’s own wording (“Week 6”); endTime is the fallback when you already know a literal date. Where neither is present, productName plus budget sometimes narrows it to one, but a schedule that gave those periods equal budgets gives their packages identical budgets, and those cannot be told apart through this API.
  • budget: this package’s budget, gross of buyer fees, in budgetCurrency.
  • budgetCurrency: ISO-4217 currency of budget.
  • pacing: how the package spends its budget (even, asap, or front_loaded).
  • delivery: { impressions, spend, clicks }. Absent when the package has not delivered yet or the source has not reported.

​

Errors

​

Related