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

# Change only the named fields of a product for an ad server source

> Apply a partial update to a wholesale product on the ad server source's upstream tenant. Only the fields present in the body are applied; a field you omit — or send as `null` — keeps its stored value, and `inventory` merges one level deep. Prefer this over the full-replace PUT unless you hold a complete product — a replace clears the pricing options, channels and targeting it does not re-send. A partial update may leave a product incomplete, in which case it stays out of the buyer-facing catalog until it is completed. The response body is the upstream adapter's payload and varies by ad server.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml patch /esa/{esaId}/products/{productId}
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}/products/{productId}:
    patch:
      tags:
        - Storefront Ad Server Catalog
      summary: Change only the named fields of a product for an ad server source
      description: >-
        Apply a partial update to a wholesale product on the ad server source's
        upstream tenant. Only the fields present in the body are applied; a
        field you omit — or send as `null` — keeps its stored value, and
        `inventory` merges one level deep. Prefer this over the full-replace PUT
        unless you hold a complete product — a replace clears the pricing
        options, channels and targeting it does not re-send. A partial update
        may leave a product incomplete, in which case it stays out of the
        buyer-facing catalog until it is completed. The response body is the
        upstream adapter's payload and varies by ad server.
      operationId: patchEsaProduct
      parameters:
        - in: path
          name: esaId
          schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 9007199254740991
            description: >-
              Ad server source connection id. The wire field remains `esaId` for
              API compatibility.
            example: 123
          required: true
          description: >-
            Ad server source connection id. The wire field remains `esaId` for
            API compatibility.
        - in: path
          name: productId
          schema:
            type: string
            minLength: 1
            description: Upstream product id for the ad server source.
            example: prod_abc
          required: true
          description: Upstream product id for the ad server source.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EsaProductPatchBody'
      responses:
        '200':
          description: Change only the named fields of a product for an ad server source
        '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: >-
            No ad server source or product with this id, or the source is
            deactivated.
          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:
    EsaProductPatchBody:
      type: object
      properties:
        wholesale_product_id:
          nullable: true
          type: string
          minLength: 1
          maxLength: 100
        name:
          nullable: true
          type: string
          minLength: 1
          maxLength: 200
        description:
          nullable: true
          type: string
        status:
          nullable: true
          type: string
        delivery_type:
          nullable: true
          type: string
        channels:
          nullable: true
          type: array
          items:
            anyOf:
              - anyOf:
                  - type: string
                    enum:
                      - display
                  - type: string
                    enum:
                      - olv
                  - type: string
                    enum:
                      - social
                  - type: string
                    enum:
                      - search
                  - type: string
                    enum:
                      - ctv
                  - type: string
                    enum:
                      - linear_tv
                  - type: string
                    enum:
                      - radio
                  - type: string
                    enum:
                      - streaming_audio
                  - type: string
                    enum:
                      - podcast
                  - type: string
                    enum:
                      - dooh
                  - type: string
                    enum:
                      - ooh
                  - type: string
                    enum:
                      - print
                  - type: string
                    enum:
                      - cinema
                  - type: string
                    enum:
                      - email
                  - type: string
                    enum:
                      - gaming
                  - type: string
                    enum:
                      - retail_media
                  - type: string
                    enum:
                      - influencer
                  - type: string
                    enum:
                      - affiliate
                  - type: string
                    enum:
                      - product_placement
                  - type: string
                    enum:
                      - sponsored_intelligence
              - type: string
                enum:
                  - audio
              - type: string
                enum:
                  - video
        format_options:
          nullable: true
          type: array
          items:
            type: object
            additionalProperties: {}
        inventory:
          nullable: true
          type: object
          additionalProperties: {}
        pricing_options:
          nullable: true
          type: array
          items:
            type: object
            additionalProperties: {}
      additionalProperties: {}
      description: >-
        Partial change body for an ad-server-source product. Only the fields
        present are applied; an omitted field — or one sent as null — keeps its
        stored value, and `inventory` merges one level deep. Unknown/extra
        fields are forwarded as-is.
    ErrorResponse:
      type: object
      properties:
        data:
          type: string
          nullable: true
          enum:
            - null
        error:
          $ref: '#/components/schemas/ApiError'
      required:
        - data
        - error
      additionalProperties: false
      description: Standard error response
    ApiError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
        message:
          type: string
          description: Human-readable error message
        field:
          description: Field path associated with the error
          type: string
        details:
          description: Additional error context
          type: object
          additionalProperties: {}
      required:
        - code
        - message
      additionalProperties: false
      description: Structured error object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````