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

# Create a buyer-instructions row

> Create a new buyer-instructions row. The (operatorDomain, brandDomain) tuple is unique per storefront — duplicate scopes return 409; use PATCH to update an existing row.



## OpenAPI

````yaml /v2/storefront-api-v2.yaml post /buyer-instructions
openapi: 3.0.0
info:
  title: Scope3 Storefront API
  version: 2.0.0
  description: |-
    REST API for partners to manage storefronts, 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: 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 storefronts
  - name: AI Usage
    description: Storefront AI token usage visibility by model
  - name: MCP
    description: Model Context Protocol endpoints
paths:
  /buyer-instructions:
    post:
      tags:
        - Storefront
      summary: Create a buyer-instructions row
      description: >-
        Create a new buyer-instructions row. The (operatorDomain, brandDomain)
        tuple is unique per storefront — duplicate scopes return 409; use PATCH
        to update an existing row.
      operationId: createBuyerInstructions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBuyerInstructionsBody'
      responses:
        '201':
          description: Create a buyer-instructions row
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BuyerInstructionsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: >-
            A buyer-instructions row already exists for this (operatorDomain,
            brandDomain) on the storefront. Use PATCH to update it.
          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:
    CreateBuyerInstructionsBody:
      description: >-
        Request body for creating a buyer-instructions row. (operatorDomain,
        brandDomain) is unique per storefront — duplicate scopes fail with a
        validation error; use PATCH instead.
      type: object
      properties:
        operatorDomain:
          description: >-
            Operator (e.g. agency/DSP) the row applies to, or null to match any
            operator. (operatorDomain, brandDomain) form the scope — one of the
            four shapes: house (both null), house+brand (brand only), operator
            (operator only), operator+brand (both).
          nullable: true
          example: nike.com
          type: string
          minLength: 1
          maxLength: 253
        brandDomain:
          description: >-
            Advertiser brand the row applies to, or null to match any brand. See
            operatorDomain for the four scope shapes.
          nullable: true
          example: nike.com
          type: string
          minLength: 1
          maxLength: 253
        discountPercent:
          description: >-
            Discount percent off the storefront base price for buys that match
            this scope. Null = no discount contribution.
          nullable: true
          example: 15
          type: number
          minimum: 0
          maximum: 100
        notes:
          description: >-
            Freeform notes the Merchandising Agent applies to compositions for
            matching buyers (e.g. "Brand requires GroupM viewability ≥ 70%").
            Null = no notes contribution.
          nullable: true
          type: string
          maxLength: 2000
        countries:
          description: Optional country filter. Null = row applies regardless of country.
          nullable: true
          example:
            - US
            - CA
          minItems: 1
          type: array
          items:
            type: string
            pattern: ^[A-Z]{2}$
      required:
        - operatorDomain
        - brandDomain
        - discountPercent
        - notes
        - countries
    BuyerInstructionsResponse:
      description: A single buyer-instructions row.
      type: object
      properties:
        id:
          description: Surrogate id (BIGINT serialized as string).
          example: '17'
          type: string
        storefrontId:
          description: Storefront the row belongs to (BIGINT serialized as string).
          example: '1234'
          type: string
        operatorDomain:
          nullable: true
          type: string
        brandDomain:
          nullable: true
          type: string
        discountPercent:
          nullable: true
          type: number
        notes:
          nullable: true
          type: string
        countries:
          nullable: true
          type: array
          items:
            type: string
        createdAt:
          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))$
        updatedAt:
          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))$
        createdBy:
          nullable: true
          type: string
      required:
        - id
        - storefrontId
        - operatorDomain
        - brandDomain
        - discountPercent
        - notes
        - countries
        - createdAt
        - updatedAt
        - createdBy
      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
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or access token

````