openapi: 3.2.0
info:
  title: Magnite Postal Code Lists API
  version: '1.0'
  description: 'Operations tagged Postal Code Lists across 2 of this provider''s published API definitions: magnite-springserve-v0-openapi.yml, magnite-springserve-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://console.springserve.com
  description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
- url: https://api.springserve.com
  description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
security:
- api_key: []
- bearer_token: []
tags:
- name: Postal Code Lists
paths:
  /api/v0/postal_code_lists:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: ref/schemas.yaml#/components/schemas/ListResponse
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/postal_code_list_create_simple'
              full:
                $ref: '#/components/examples/postal_code_list_create_full'
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v0/postal_code_lists/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Show
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_get
    put:
      summary: Update
      requestBody:
        content:
          application/json:
            schema:
              type: object
            examples:
              simple:
                $ref: '#/components/examples/postal_code_list_update_simple'
              full:
                $ref: '#/components/examples/postal_code_list_update_full'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_put
    delete:
      summary: Destroy
      responses:
        '204':
          description: No content
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/postal_code_lists:
    get:
      summary: Index
      parameters:
      - $ref: ref/params.yaml#/components/parameters/pageParam
      - $ref: ref/params.yaml#/components/parameters/perParam
      - $ref: ref/params.yaml#/components/parameters/sortParam
      - $ref: ref/params.yaml#/components/parameters/searchParam
      - $ref: ref/params.yaml#/components/parameters/filterParams
      - $ref: ref/params.yaml#/components/parameters/includeParam
      - $ref: ref/params.yaml#/components/parameters/idsParam
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_get
    post:
      summary: Create
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PostalCodeListCreateRequest'
              - type: object
                properties:
                  postal_codes:
                    type: array
                    items:
                      type: string
                    examples:
                    - - '10001'
                      - GB:SW1A
                      - FR:75001
                required:
                - postal_codes
            examples:
              simple:
                $ref: '#/components/examples/postal_code_list_create_simple'
              full:
                $ref: '#/components/examples/postal_code_list_create_full'
          multipart/form-data:
            schema:
              allOf:
              - $ref: '#/components/schemas/PostalCodeListCreateRequest'
              - type: object
                properties:
                  csv_file:
                    type: string
                    format: binary
                required:
                - csv_file
        required: true
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostalCodeListResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostalCodeListErrorResponse'
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_post
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/postal_code_lists/{id}:
    get:
      summary: Show
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostalCodeListResponse'
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_get
    patch:
      summary: Update
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/PostalCodeListUpdateRequest'
              - type: object
                properties:
                  postal_codes:
                    type: array
                    items:
                      type: string
                    description: List of postal codes. Can be used only when the list_action parameter is provided.
                    examples:
                    - - '10001'
                      - GB:SW1A
                      - FR:75001
            examples:
              simple:
                $ref: '#/components/examples/postal_code_list_update_simple'
              full:
                $ref: '#/components/examples/postal_code_list_update_full_2'
          multipart/form-data:
            schema:
              allOf:
              - $ref: '#/components/schemas/PostalCodeListUpdateRequest'
              - type: object
                properties:
                  csv_file:
                    type: string
                    format: binary
                    description: CSV file with postal codes. Can be used only when the list_action parameter is provided.
      responses:
        '200':
          description: Updated Postal Code List successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostalCodeListResponse'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostalCodeListErrorResponse'
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_patch
    delete:
      summary: Delete
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No content
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_delete
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/postal_code_lists/permissions:
    get:
      summary: Collection Permissions
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
  /api/v1/postal_code_lists/{id}/permissions:
    get:
      summary: Permissions Member
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
      tags:
      - Postal Code Lists
      operationId: postal_code_lists_id_permissions_get
    servers:
    - url: https://console.springserve.com
      description: Production API endpoint named by the SpringServe developer documentation (API - Getting Started).
    - url: https://api.springserve.com
      description: Same application; also serves the Swagger UI at /api-docs. Verified 2026-08-13.
components:
  examples:
    postal_code_list_update_full:
      summary: Full
      value:
        name: Postal Code List Name
        description: Postal Code List Description
        active: true
        postal_codes:
        - '10001'
    postal_code_list_update_simple:
      summary: Simple
      value:
        name: Postal Code List Name
    postal_code_list_create_simple:
      summary: Simple
      value:
        name: Postal Code List Name
        postal_codes:
        - '10001'
    postal_code_list_create_full:
      summary: Full
      value:
        name: Postal Code List Name
        description: Postal Code List Description
        postal_codes:
        - '10001'
        active: true
    postal_code_list_update_full_2:
      summary: Full
      value:
        name: Postal Code List Name
        description: Postal Code List Description
        active: true
        list_action: append
        postal_codes:
        - '10001'
  schemas:
    PostalCodeListResponse:
      type: object
      properties:
        id:
          type: integer
        account_id:
          type: integer
        name:
          type: string
        description:
          type: string
        active:
          type: boolean
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        postal_codes:
          type: array
          items:
            type: string
    PostalCodeListCreateRequest:
      type: object
      properties:
        name:
          type: string
          examples:
          - Postal Code List Name
        description:
          type: string
          examples:
          - Postal Code List Description
        active:
          type: boolean
          examples:
          - true
      required:
      - name
    PostalCodeListErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: General error message
          examples:
          - Postal codes can't be blank
        errors:
          type: object
          description: Detailed validation errors by field
          additionalProperties:
            type: array
            items:
              type: string
          examples:
          - postal_codes:
            - can't be blank
    PostalCodeListUpdateRequest:
      type: object
      properties:
        name:
          type: string
          examples:
          - Update Postal Code List Name
        description:
          type: string
          examples:
          - Update Postal Code List Description
        active:
          type: boolean
          examples:
          - true
        list_action:
          type: string
          enum:
          - append
          - replace
          - remove
          examples:
          - append
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: Authorization
      description: SpringServe authorization token based authentication.
    bearer_token:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: SpringServe authorization bearer token based authentication.  This key is included in the response from the /api/v0/auth and /api/v1/auth endpoints.  This key will be automatically set if you run the example for /api/v0/auth or /api/v1/auth
x-refined-from:
- magnite-springserve-v0-openapi.yml
- magnite-springserve-v1-openapi.yml