> ## Documentation Index
> Fetch the complete documentation index at: https://docs.interchange.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List media buy packages

> List a media buy's packages with the attributes that identify each one: productId, productName, the package's own startTime/endTime, and its pacingPeriod (index plus the campaign's label, e.g. "Week 6"). Use this to turn a description of a package ("the display package ending 2026-08-11") into the packageId to send to an update. Prefer it over GET /campaigns/{campaignId} whenever the goal is to pick a package: it carries no targeting, creative, or format detail, so it stays small enough for an agent to read in full. A paced buy has one package per product per period, and the trailing number on a package id is dispatch order, NOT the period — read pacingPeriod instead of parsing the id.



## OpenAPI

````yaml /v2/buyer-api-v2.yaml get /media-buys/{mediaBuyId}/packages
openapi: 3.0.0
info:
  title: Scope3 Buyer API
  version: 2.0.0
  description: |-
    REST API for advertisers to manage advertisers, campaigns, and reporting.

    ## Authentication

    All endpoints require a Bearer token in the Authorization header:
    ```
    Authorization: Bearer your-api-key
    ```

    ## Base URL

    `https://api.interchange.io/api/v2/buyer`

    ## For AI Agents

    AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools:
    - `initialize`: Start an MCP session
    - `api_call`: Make REST API calls
    - `ask_about_capability`: Learn about API features
servers:
  - url: https://api.interchange.io/api/v2/buyer
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Advertisers
    description: Manage advertisers
  - name: Product Discovery
    description: Discover and select products
  - name: Campaigns
    description: Manage advertising campaigns
  - name: Creatives
    description: Build, manage, and sync campaign creatives via AdCP Creative Protocol
  - name: Reporting
    description: Access performance metrics
  - name: Event Sources
    description: >-
      Manage event source configurations and log conversion/marketing events for
      attribution
  - name: Property Lists
    description: Validate property lists against AAO registry
  - name: Sales Agents
    description: View and connect sales agents
  - name: Measurement
    description: Measurement sources, records, context, and freshness
  - name: Syndication
    description: Syndicate resources to ADCP agents
  - name: Tasks
    description: Track async operation status
  - name: Planning Briefs
    description: >-
      Share prospective briefs with publishers and collect their
      fit/quote/clarify/decline/book responses (gated by the
      demand-supply-signals flag).
  - name: Buyer Billing
    description: >-
      Consolidated invoicing for buyers — invoices and pending invoice items
      issued by Scope3 across the buyer customer.
  - name: MCP
    description: Model Context Protocol endpoints for AI agents
paths:
  /media-buys/{mediaBuyId}/packages:
    get:
      tags:
        - Campaigns
      summary: List media buy packages
      description: >-
        List a media buy's packages with the attributes that identify each one:
        productId, productName, the package's own startTime/endTime, and its
        pacingPeriod (index plus the campaign's label, e.g. "Week 6"). Use this
        to turn a description of a package ("the display package ending
        2026-08-11") into the packageId to send to an update. Prefer it over GET
        /campaigns/{campaignId} whenever the goal is to pick a package: it
        carries no targeting, creative, or format detail, so it stays small
        enough for an agent to read in full. A paced buy has one package per
        product per period, and the trailing number on a package id is dispatch
        order, NOT the period — read pacingPeriod instead of parsing the id.
      operationId: getMediaBuyPackages
      parameters:
        - in: path
          name: mediaBuyId
          schema:
            description: Buyer media buy ID
            example: mb_ETBn4gJ9Wu
            type: string
            minLength: 1
          required: true
          description: Buyer media buy ID
      responses:
        '200':
          description: List media buy packages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyerMediaBuyPackagesResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Caller is not a buyer — the route is mounted behind the buyer role
            guard.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: No media buy with this id owned by the caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    BuyerMediaBuyPackagesResponse:
      description: >-
        A media buy's packages with the attributes needed to pick one, sized to
        be read in full by an agent.
      type: object
      properties:
        mediaBuyId:
          description: The media buy these packages belong to.
          example: mb_ETBn4gJ9Wu
          type: string
        isPaced:
          description: >-
            Whether this buy was split across pacing periods. When true, expect
            one package per product per period and use pacingPeriod to tell them
            apart.
          type: boolean
        packageCount:
          description: How many packages this media buy has.
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        packages:
          description: >-
            The packages on this media buy, ordered by product then pacing
            period so the order matches how the ids were assigned.
          type: array
          items:
            $ref: '#/components/schemas/BuyerPackage'
      required:
        - mediaBuyId
        - isPaced
        - packageCount
        - packages
      additionalProperties: false
    ErrorResponse:
      description: Standard error response
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
    BuyerPackage:
      description: >-
        One package on a media buy, carrying the attributes that identify it.
        Targeting, creatives, and format detail are deliberately omitted; use
        get_campaign for those.
      type: object
      properties:
        packageId:
          description: >-
            The package identifier to quote when updating or pausing this
            package. Treat it as an opaque string: the trailing number is a
            dispatch-order position, not a period number. Use pacingPeriod to
            identify the period.
          example: sf_pkg_sf_mb_1783618937177_43ycbp7b_3
          type: string
        productId:
          description: >-
            The seller product this package buys. Together with pacingPeriod
            this uniquely identifies a package within its media buy. Note the
            nested package inside GET /campaigns/:id spells this `productIds` as
            a single-element array; this endpoint uses the singular form, which
            matches the AdCP Package field.
          nullable: true
          type: string
        productName:
          description: >-
            The product's name as published by the seller, when it is known
            locally.
          type: string
        status:
          description: >-
            Whether this package is currently buying. Independent of the media
            buy status: a live buy can carry a paused package.
          type: string
          enum:
            - active
            - paused
            - canceled
        pacingPeriod:
          allOf:
            - $ref: '#/components/schemas/PackagePacingPeriod'
        startTime:
          description: >-
            When this package starts buying (ISO 8601). Absent on packages
            created before the platform retained its own requested window, in
            which case fall back to the media buy's window.
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        endTime:
          description: >-
            When this package stops buying (ISO 8601). This is the field to
            match when a buyer names a package by the date it ends.
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
        budget:
          description: This package's budget, gross of buyer fees, in budgetCurrency.
          nullable: true
          type: number
        budgetCurrency:
          description: ISO-4217 currency of budget.
          example: USD
          type: string
        pacing:
          description: How the package spends its budget (even, asap, front_loaded).
          type: string
        delivery:
          allOf:
            - $ref: '#/components/schemas/BuyerPackageDelivery'
      required:
        - packageId
        - productId
        - status
        - budget
      additionalProperties: false
    ApiError:
      description: Structured error object
      type: object
      properties:
        code:
          description: Machine-readable error code
          type: string
        message:
          description: Human-readable error message
          type: string
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
    PackagePacingPeriod:
      description: >-
        Which pacing period a package was cut for. This is what the numeric
        suffix on a storefront-minted package id refers to: package ids are
        assigned in product-then-period order at dispatch, so the suffix is a
        position, not a meaning. Read this field rather than parsing the id.
        Absent when the media buy is not paced, and on packages created before
        period identity was recorded.
      type: object
      properties:
        index:
          description: >-
            One-based ordinal of the pacing period this package was cut for,
            counting from the first period on the campaign.
          example: 6
          type: integer
          maximum: 9007199254740991
          minimum: 1
        label:
          description: >-
            The period label as named on the campaign, when the campaign named
            it.
          example: Week 6
          type: string
      required:
        - index
      additionalProperties: false
    BuyerPackageDelivery:
      description: >-
        Delivery recorded against this package. Absent when the package has not
        delivered or the source has not reported yet.
      type: object
      properties:
        impressions:
          description: Impressions delivered against this package so far.
          type: number
        spend:
          description: >-
            Spend against this package so far, in the buy's currency, in GROSS
            (fee-inclusive) denomination grossed up at the buy's pinned pricing
            terms, so it compares directly against this package's budget.
            Net-as-reported for legacy buys with no pinned terms.
          type: number
        clicks:
          description: Clicks recorded against this package, when reported.
          nullable: true
          type: number
      required:
        - impressions
        - spend
        - clicks
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````