Amberai Brand API

openapi: 3.2.0
info:
  title: Amber Public Brand API
  version: 1.3.0
  description: Read your brand's catalog, sourcing, orders, shipments, finance, and documents. All business endpoints are read-only and require an API key. Products are Parent Products; Product Options and SKUs are separate resources. Use filters to find records, follow their IDs to related data, and paginate to retrieve every result. See the integration tutorials for complete examples and data conventions for amounts, IDs, and timestamps.
servers:
- url: https://app.amber.ai/api/public/v1
tags:
- name: Brand
paths:
  /brands/{brand}:
    get:
      tags:
      - Brand
      summary: Verify access and get the authorized brand
      operationId: getBrand
      security:
      - ApiKeyAuth: []
      parameters:
      - name: brand
        in: path
        required: true
        description: Brand slug authorized by this API key.
        schema:
          type: string
          example: acme
      responses:
        '200':
          description: The requested record.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Brand'
        '400':
          description: Invalid parameter, unsupported include, or cursor used with different filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, expired, or out-of-scope API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: The record was not found or is not available to your brand.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded. Retry after the indicated delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Seconds before retrying.
              schema:
                type: integer
                minimum: 0
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
        errorCode:
          type: string
        details:
          description: Parameter validation issues, when available.
          $ref: '#/components/schemas/Error/$defs/__schema0'
      required:
      - error
      - errorCode
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
          - type: string
          - type: number
          - type: boolean
          - type: 'null'
          - type: array
            items:
              $ref: '#/components/schemas/Error/$defs/__schema0'
          - type: object
            propertyNames:
              type: string
            additionalProperties:
              $ref: '#/components/schemas/Error/$defs/__schema0'
    Brand:
      type: object
      properties:
        id:
          type: string
          pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
          description: Brand UUID for relationships and document subjects.
        slug:
          type: string
          description: Brand slug used in public API paths.
        name:
          type: string
          description: Brand display name.
      required:
      - id
      - slug
      - name
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: A brand-scoped or global amb_sk_... API key.