> ## 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.

# Get the advertiser-account capability descriptor

> Read the live, per-tenant-credential descriptor of whether this embedded sales agent can list, read, and idempotently create an advertiser (or its provider-specific equivalent entity), and whether it has a healthy configured default destination. Static-ish and cacheable — never triggers a live probe or a real create the way POST .../gam/advertisers/ensure does. `available: false` means the upstream salesagent has not shipped this endpoint yet for this ESA; it is never an error and never a fabricated descriptor. Callable for every ad-server type, including ones with no advertiser entity (e.g. SpringServe reports `nativeEntity: "demand_partner"` and `not_applicable` operations) — that honest declaration is the point, not a reason to reject the call.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml get /esa/{esaId}/advertiser-capabilities
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: >-
    REST API for partners to manage Seller Accounts, inventory sources, and
    billing.


    ## Authentication


    All endpoints require a Bearer token in the Authorization header:

    ```

    Authorization: Bearer your-api-key

    ```


    ## Base URL


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


    ## For AI Agents


    AI agents can use the MCP endpoint at `/mcp/v2/storefront` 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/storefront
    description: Production server
security: []
tags:
  - name: Account
    description: Account management, service tokens, and preferences
  - name: Asks
    description: >-
      What you are waiting on Scope3 for — support, product, and supply asks in
      one list
  - name: Storefront
    description: Manage storefront and inventory sources
  - name: Storefront Agents
    description: List and manage registered sales, signals, and outcomes agents
  - name: Storefront Activity
    description: Audit log of configuration and inventory changes on the storefront
  - name: Storefront Billing
    description: Payout bank details and billing configuration for Seller Accounts
  - name: AI Usage
    description: Seller Account AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /esa/{esaId}/advertiser-capabilities:
    get:
      tags:
        - Storefront Ad Server Buyer Routing
      summary: Get the advertiser-account capability descriptor
      description: >-
        Read the live, per-tenant-credential descriptor of whether this embedded
        sales agent can list, read, and idempotently create an advertiser (or
        its provider-specific equivalent entity), and whether it has a healthy
        configured default destination. Static-ish and cacheable — never
        triggers a live probe or a real create the way POST
        .../gam/advertisers/ensure does. `available: false` means the upstream
        salesagent has not shipped this endpoint yet for this ESA; it is never
        an error and never a fabricated descriptor. Callable for every ad-server
        type, including ones with no advertiser entity (e.g. SpringServe reports
        `nativeEntity: "demand_partner"` and `not_applicable` operations) — that
        honest declaration is the point, not a reason to reject the call.
      operationId: getEsaAdvertiserCapabilities
      parameters:
        - in: path
          name: esaId
          schema:
            description: >-
              Ad server source connection id. The wire field remains `esaId` for
              API compatibility.
            example: 123
            type: integer
            maximum: 9007199254740991
            minimum: 1
          required: true
          description: >-
            Ad server source connection id. The wire field remains `esaId` for
            API compatibility.
      responses:
        '200':
          description: Get the advertiser-account capability descriptor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EsaAdvertiserCapabilitiesResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Ad server source not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: >-
            The upstream sales agent is unreachable — retry; never inferred as a
            capability signal
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    EsaAdvertiserCapabilitiesResponse:
      description: >-
        Response of GET /esa/{esaId}/advertiser-capabilities. `available: false`
        means the ESA has not shipped the descriptor endpoint yet — never an
        error, and never a fabricated descriptor.
      oneOf:
        - type: object
          properties:
            available:
              type: boolean
              enum:
                - true
            descriptor:
              $ref: '#/components/schemas/EsaAdvertiserCapabilityDescriptor'
          required:
            - available
            - descriptor
          additionalProperties: false
        - type: object
          properties:
            available:
              type: boolean
              enum:
                - false
          required:
            - available
          additionalProperties: false
      type: object
    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
    EsaAdvertiserCapabilityDescriptor:
      description: >-
        Runtime, per-tenant-credential report of whether an embedded sales agent
        can list, read, and idempotently create an advertiser (or its
        provider-specific equivalent entity), plus whether it has a healthy
        configured default destination. See
        docs/spec/sales-agents/account-setup-dispositions.md §8.
      type: object
      properties:
        descriptorVersion:
          type: number
          enum:
            - 1
        esaId:
          type: string
        tenantId:
          type: string
        adServerType:
          description: Ad-server type the managed source will be wired to.
          type: string
          enum:
            - google_ad_manager
            - freewheel
            - springserve
            - adswizz
        nativeEntity:
          $ref: '#/components/schemas/EsaAdvertiserCapabilityNativeEntity'
        observedAt:
          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))$
        operations:
          type: object
          properties:
            listAdvertisers:
              $ref: '#/components/schemas/EsaOperationDescriptor'
            getAdvertiser:
              $ref: '#/components/schemas/EsaOperationDescriptor'
            ensureAdvertiser:
              $ref: '#/components/schemas/EsaOperationDescriptor'
            getDefaultAdvertiser:
              $ref: '#/components/schemas/EsaOperationDescriptor'
            setDefaultAdvertiser:
              $ref: '#/components/schemas/EsaOperationDescriptor'
            manualHandoff:
              $ref: '#/components/schemas/EsaOperationDescriptor'
          required:
            - listAdvertisers
            - getAdvertiser
            - ensureAdvertiser
            - getDefaultAdvertiser
            - setDefaultAdvertiser
            - manualHandoff
          additionalProperties: false
        defaultDestination:
          $ref: '#/components/schemas/EsaDefaultDestinationDescriptor'
        resolvedRoute:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EsaResolvedAdvertiserRoute'
      required:
        - descriptorVersion
        - esaId
        - tenantId
        - adServerType
        - nativeEntity
        - observedAt
        - operations
        - defaultDestination
      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
    EsaAdvertiserCapabilityNativeEntity:
      type: string
      enum:
        - advertiser
        - company
        - supplier_team
        - demand_partner
        - not_applicable
    EsaOperationDescriptor:
      type: object
      properties:
        adapterSupport:
          $ref: '#/components/schemas/EsaAdapterSupport'
        authorization:
          $ref: '#/components/schemas/EsaCredentialAuthorization'
      required:
        - adapterSupport
        - authorization
      additionalProperties: false
    EsaDefaultDestinationDescriptor:
      type: object
      properties:
        current:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/EsaDefaultDestinationCurrent'
      required:
        - current
      additionalProperties: false
    EsaResolvedAdvertiserRoute:
      type: object
      properties:
        winner:
          type: string
          enum:
            - buyer_specific_mapping
            - connection_default
        nativeId:
          type: string
        observedAt:
          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))$
      required:
        - winner
        - nativeId
        - observedAt
      additionalProperties: false
    EsaAdapterSupport:
      description: Static, adapter-class support for one advertiser-capability operation.
      oneOf:
        - type: object
          properties:
            status:
              type: string
              enum:
                - implemented
          required:
            - status
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - not_yet_implemented
            reason:
              type: string
              minLength: 1
          required:
            - status
            - reason
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - not_applicable
            reason:
              type: string
              minLength: 1
          required:
            - status
            - reason
          additionalProperties: false
      type: object
    EsaCredentialAuthorization:
      description: >-
        Effective credential authorization for one advertiser-capability
        operation. `absent` is a first-class 'no safe probe has run' observed
        fact — never defaulted from a read, never coerced to `denied` or
        `verified`.
      oneOf:
        - type: object
          properties:
            status:
              type: string
              enum:
                - verified
            observedAt:
              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))$
            evidenceMethod:
              type: string
              enum:
                - real_create
                - real_write
                - provider_probe
          required:
            - status
            - observedAt
            - evidenceMethod
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - denied
            observedAt:
              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))$
            evidenceMethod:
              type: string
              enum:
                - real_create
                - real_write
                - provider_probe
            reason:
              type: string
          required:
            - status
            - observedAt
            - evidenceMethod
          additionalProperties: false
        - type: object
          properties:
            status:
              type: string
              enum:
                - absent
          required:
            - status
          additionalProperties: false
      type: object
    EsaDefaultDestinationCurrent:
      type: object
      properties:
        nativeId:
          type: string
          minLength: 1
        readBackStatus:
          type: string
          enum:
            - confirmed
            - stale
            - unreadable
        sellerPolicyVersion:
          nullable: true
          type: string
        permittedExecutionScopes:
          type: array
          items:
            type: string
            enum:
              - agent_billing
              - direct_billing
      required:
        - nativeId
        - readBackStatus
        - sellerPolicyVersion
        - permittedExecutionScopes
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````