Happy Buyers External API

openapi: 3.0.1
info:
  title: Happy Buyers External API
  description: 'External API for Happy Buyers organization metadata and inventory
    data.


    Requests are authenticated with an API key in the hca-api-key header. Results
    are scoped to

    the organization attached to that key. List endpoints use limit/offset pagination
    and return

    totalCount plus hasMore.

    '
  version: v1
servers:
- url: https://api.happycabbage.ai
  description: External API
security:
- ApiKeyAuth: []
tags:
- name: POS Brands
  description: Organization POS brand metadata and mappings
- name: Orders
  description: Orders
- name: Inventory Health
  description: Inventory health data
- name: Identity
  description: API key identity and organization context
- name: Universal Brands
  description: Canonical brand metadata across POS systems
- name: Daily Sales Metadata
  description: Daily product sales and stock metadata
- name: Packages
  description: Package-level product inventory
- name: Stores
  description: Organization location metadata
- name: Product Inventory
  description: Product-level inventory, sales, and demand metrics
- name: Product Line Inventory
  description: Product-line inventory, demand, and replenishment metrics
- name: Product Lines
  description: Product-lines
- name: POS Categories
  description: Organization POS category metadata and mappings
- name: Blockout Dates
  description: Blockout dates
- name: Universal Categories
  description: Canonical product category metadata across POS systems
paths:
  /external/v1/product-lines/{id}:
    get:
      tags:
      - Product Lines
      summary: Get a product line
      description: Returns one product line for the API key organization. Requires
        `product_lines:read`.
      operationId: getProductLine
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Product line details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductLineDetailResponse'
        '401':
          description: Missing, malformed, or invalid API key
        '404':
          description: Product line not found
        '403':
          description: API key does not include product_lines:read
    put:
      tags:
      - Product Lines
      summary: Update a product line
      description: Updates a product line for the API key organization. Requires `product_lines:write`.
      operationId: updateProductLine
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductLineUpdateRequest'
        required: true
      responses:
        '400':
          description: Invalid request body
        '401':
          description: Missing, malformed, or invalid API key
        '404':
          description: Product line not found
        '403':
          description: API key does not include product_lines:write
        '200':
          description: Updated product line
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductLineDetailResponse'
  /external/v1/product-inventory/{productId}/stores/{storeId}/carry-status:
    put:
      tags:
      - Product Inventory
      summary: Update product carry status
      description: 'Updates whether a product should continue to be carried at a store.

        Discontinued products will still be viewable but will not be recommended for
        reorders.

        Requires `inventory:write`.

        '
      operationId: updateCarryStatus
      parameters:
      - name: productId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: storeId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CarryStatusUpdateRequest'
        required: true
      responses:
        '400':
          description: Invalid request body
        '401':
          description: Missing, malformed, or invalid API key
        '404':
          description: Store or product inventory not found
        '200':
          description: Updated carry status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CarryStatusUpdateResponse'
        '403':
          description: API key does not include inventory:write
  /external/v1/orders/{orderId}/items:
    get:
      tags:
      - Orders
      summary: List order items
      description: Returns product and product-line items for an order in the API
        key organization. Requires `orders:read`.
      operationId: getOrderItems
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Maximum records to return. Defaults to `100`.
        required: false
        schema:
          maximum: 500
          minimum: 0
          type: string
          description: Maximum records to return. Defaults to `100`.
          default: '100'
      - name: offset
        in: query
        description: Zero-based record offset. Defaults to `0`.
        required: false
        schema:
          minimum: 0
          type: string
          description: Zero-based record offset. Defaults to `0`.
          default: '0'
      - name: sortTarget
        in: query
        description: Field used to sort order items.
        required: false
        schema:
          type: string
          description: Field used to sort order items.
      - name: sortDirection
        in: query
        description: Sort direction. Defaults to `ASC`.
        required: false
        schema:
          type: string
          description: Sort direction. Defaults to `ASC`.
          default: ASC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseOrderItemResponse'
    put:
      tags:
      - Orders
      summary: Add order item
      description: Adds a product, product-line, or custom item to an order. Requires
        `orders:write`.
      operationId: addOrderItem
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderItemAddRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderItemResponse'
  /external/v1/orders/{orderId}/invoices/{invoiceId}:
    get:
      tags:
      - Orders
      summary: Get order invoice
      description: Returns invoice metadata for an order in the API key organization.
        Requires `orders:read`.
      operationId: getOrderInvoice
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderInvoiceResponse'
    put:
      tags:
      - Orders
      summary: Update order invoice
      description: Updates invoice metadata for an order in the API key organization.
        Requires `orders:write`.
      operationId: updateOrderInvoice
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInvoiceUpdateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderInvoiceResponse'
    delete:
      tags:
      - Orders
      summary: Remove order invoice
      description: Removes invoice metadata and its file from an order in the API
        key organization. Requires `orders:write`.
      operationId: removeOrderInvoice
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /external/v1/orders/{id}:
    put:
      tags:
      - Orders
      summary: Update an order
      description: Updates order metadata for the API key organization. Requires `orders:write`.
      operationId: updateOrder
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateRequest'
        required: true
      responses:
        '404':
          description: Order not found
        '400':
          description: Invalid request body
        '401':
          description: Missing, malformed, or invalid API key
        '403':
          description: API key does not include orders:write
        '200':
          description: Updated order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
  /external/v1/blockout-dates/{id}:
    get:
      tags:
      - Blockout Dates
      summary: Get a blockout date
      description: Returns one blockout date. Requires `blockout_dates:read`.
      operationId: getBlockoutDate
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockoutDateResponse'
    put:
      tags:
      - Blockout Dates
      summary: Update a blockout date
      description: Updates a blockout date. Requires `blockout_dates:write`.
      operationId: updateBlockoutDate
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockoutDateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockoutDateResponse'
    delete:
      tags:
      - Blockout Dates
      summary: Delete a blockout date
      description: Deletes a blockout date. Requires `blockout_dates:write`.
      operationId: deleteBlockoutDate
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /external/v1/product-lines:
    get:
      tags:
      - Product Lines
      summary: List product lines
      description: Returns product lines for the API key organization. Requires `product_lines:read`.
      operationId: getProductLines
      parameters:
      - name: offset
        in: query
        description: Zero-based result offset for pagination.
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 0
      - name: limit
        in: query
        description: Maximum number of product lines to return. Maximum is 500.
        required: false
        schema:
          maximum: 500
          minimum: 0
          type: integer
          format: int32
          default: 100
        example: 100
      - name: isFavorite
        in: query
        description: Filter by whether the product line is marked as a favorite.
        required: false
        schema:
          type: boolean
        example: true
      - name: universalCategoryIds
        in: query
        description: Universal category ID filters. Pass repeated query parameters,
          for example universalCategoryIds=1&universalCategoryIds=2.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
        example: 12
      - name: posBrandIds
        in: query
        description: POS brand ID filters. Pass repeated query parameters, for example
          posBrandIds=1&posBrandIds=2.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
        example: 42
      - name: search
        in: query
        description: Case-insensitive product line search text.
        required: false
        schema:
          type: string
        example: gummies
      - name: productLineId
        in: query
        description: Exact product line ID filter.
        required: false
        schema:
          type: integer
          format: int32
        example: 123
      - name: universalBrandIds
        in: query
        description: Universal brand ID filters, passed as repeated query parameters.
        required: false
        schema:
          type: array
          items:
            type: integer
            format: int32
        example: 90
      responses:
        '401':
          description: Missing, malformed, or invalid API key
        '200':
          description: Paged product line results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseProductLineDetailResponse'
        '400':
          description: Invalid query parameter
        '403':
          description: API key does not include product_lines:read
    post:
      tags:
      - Product Lines
      summary: Create a product line
      description: Creates a new product line for the API key organization. Requires
        `product_lines:write`.
      operationId: createProductLine
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProductLineCreateRequest'
        required: true
      responses:
        '200':
          description: Created product line
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductLineDetailResponse'
        '400':
          description: Invalid request body
        '401':
          description: Missing, malformed, or invalid API key
        '403':
          description: API key does not include product_lines:write
  /external/v1/orders:
    get:
      tags:
      - Orders
      summary: List orders
      description: Returns `DRAFT`, `READY_TO_SEND`, `SUBMITTED`, and `RECEIVED` orders
        for the API key organization. Requires `orders:read`.
      operationId: getOrders
      parameters:
      - name: limit
        in: query
        description: Maximum records to return. Defaults to `100`.
        required: false
        schema:
          maximum: 500
          minimum: 0
          type: string
          description: Maximum records to return. Defaults to `100`.
          default: '100'
      - name: offset
        in: query
        description: Zero-based record offset. Defaults to `0`.
        required: false
        schema:
          minimum: 0
          type: string
          description: Zero-based record offset. Defaults to `0`.
          default: '0'
      - name: sortTarget
        in: query
        description: Field used to sort orders. `CREATED_AT` sorts by order creation
          time.
        required: false
        schema:
          type: string
          description: Field used to sort orders. `CREATED_AT` sorts by order creation
            time.
      - name: sortDirection
        in: query
        description: Sort direction. Defaults to `DESC`.
        required: false
        schema:
          type: string
          description: Sort direction. Defaults to `DESC`.
          default: DESC
      - name: universalBrandId
        in: query
        description: Only return orders containing products for this universal brand
          id.
        required: false
        schema:
          type: string
          description: Only return orders containing products for this universal brand
            id.
      - name: status
        in: query
        description: Only return orders with this status, including `DRAFT`.
        required: false
        schema:
          type: string
          description: Only return orders with this status, including `DRAFT`.
      - name: createdAtFrom
        in: query
        description: Minimum inclusive order `createdAt` timestamp.
        required: false
        schema:
          type: string
          description: Minimum inclusive order `createdAt` timestamp.
      - name: createdAtUntil
        in: query
        description: Maximum exclusive order `createdAt` timestamp.
        required: false
        schema:
          type: string
          description: Maximum exclusive order `createdAt` timestamp.
      - name: includeArchived
        in: query
        description: Include archived orders. Defaults to `false`.
        required: false
        schema:
          type: string
          description: Include archived orders. Defaults to `false`.
          default: 'false'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseOrderResponse'
    post:
      tags:
      - Orders
      summary: Create an order
      description: Creates a `DRAFT` order for the API key organization. Requires
        `orders:write`.
      operationId: createOrder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateRequest'
        required: true
      responses:
        '200':
          description: Created order
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        '400':
          description: Invalid request body
        '401':
          description: Missing, malformed, or invalid API key
        '403':
          description: API key does not include orders:write
  /external/v1/orders/{orderId}/invoices:
    get:
      tags:
      - Orders
      summary: List order invoices
      description: Returns invoice metadata for an order in the API key organization.
        Requires `orders:read`.
      operationId: getOrderInvoices
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Maximum records to return. Defaults to `100`.
        required: false
        schema:
          maximum: 500
          minimum: 0
          type: string
          description: Maximum records to return. Defaults to `100`.
          default: '100'
      - name: offset
        in: query
        description: Zero-based record offset. Defaults to `0`.
        required: false
        schema:
          minimum: 0
          type: string
          description: Zero-based record offset. Defaults to `0`.
          default: '0'
      - name: sortTarget
        in: query
        description: Field used to sort invoices.
        required: false
        schema:
          type: string
          description: Field used to sort invoices.
      - name: sortDirection
        in: query
        description: Sort direction. Defaults to `DESC`.
        required: false
        schema:
          type: string
          description: Sort direction. Defaults to `DESC`.
          default: DESC
      - name: search
        in: query
        description: Search text matched against invoice name and filename.
        required: false
        schema:
          type: string
          description: Search text matched against invoice name and filename.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseOrderInvoiceResponse'
    post:
      tags:
      - Orders
      summary: Add order invoice
      description: Adds invoice metadata to an order in the API key organization.
        Requires `orders:write`.
      operationId: addOrderInvoice
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInvoiceCreateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderInvoiceResponse'
  /external/v1/orders/{orderId}/invoices/{invoiceId}/upload-url:
    post:
      tags:
      - Orders
      summary: Generate order invoice upload URL
      description: Generates a temporary upload URL for an order invoice in the API
        key organization. Requires `orders:write`.
      operationId: generateTemporaryUploadUrl
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInvoiceUrlRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
  /external/v1/orders/{orderId}/invoices/{invoiceId}/download-url:
    post:
      tags:
      - Orders
      summary: Generate order invoice download URL
      description: Generates a temporary download URL for an order invoice in the
        API key organization. Requires `orders:read`.
      operationId: generateTemporaryDownloadUrl
      parameters:
      - name: orderId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      - name: invoiceId
        in: path
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderInvoiceUrlRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
  /external/v1/blockout-dates:
    get:
      tags:
      - Blockout Dates
      summary: List blockout dates
      description: List blockout dates. Requires `blockout_dates:read`.
      operationId: getBlockoutDates
      parameters:
      - name: limit
        in: query
        description: Maximum records to return. Defaults to 100.
        required: false
        schema:
          maximum: 500
          minimum: 0
          type: string
          description: Maximum records to return. Defaults to 100.
          default: '100'
      - name: offset
        in: query
        description: Zero-based result offset. Defaults to 0.
        required: false
        schema:
          minimum: 0
          type: string
          description: Zero-based result offset. Defaults to 0.
          default: '0'
      - name: sortTarget
        in: query
        description: Field used to sort results. Defaults to START_DATE.
        required: false
        schema:
          type: string
          description: Field used to sort results. Defaults to START_DATE.
      - name: sortDirection
        in: query
        description: Sort direction. Defaults to ASC.
        required: false
        schema:
          type: string
          description: Sort direction. Defaults to ASC.
          default: ASC
      - name: storeId
        in: query
        description: Only return blockout dates for this store UUID.
        required: false
        schema:
          type: string
          description: Only return blockout dates for this store UUID.
      - name: includeAllStores
        in: query
        description: When filtering by `storeId`, include blockout dates that apply
          to all stores when `true`, or exclude them when `false`.
        required: false
        schema:
          type: string
          description: When filtering by `storeId`, include blockout dates that apply
            to all stores when `true`, or exclude them when `false`.
      - name: search
        in: query
        description: Case-insensitive blockout date name or description search text.
        required: false
        schema:
          type: string
          description: Case-insensitive blockout date name or description search text.
      - name: isAllStores
        in: query
        description: Only return blockout dates that apply to all stores.
        required: false
        schema:
          type: string
          description: Only return blockout dates that apply to all stores.
      - name: isRecurring
        in: query
        description: Only return recurring or non-recurring blockout dates.
        required: false
        schema:
          type: string
          description: Only return recurring or non-recurring blockout dates.
      - name: activeOnOrAfter
        in: query
        description: Only return blockout dates active on or after this date, inclusive.
        required: false
        schema:
          type: string
          description: Only return blockout dates active on or after this date, inclusive.
      - name: activeBefore
        in: query
        description: Only return blockout dates active before this date, exclusive.
        required: false
        schema:
          type: string
          description: Only return blockout dates active before this date, exclusive.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseBlockoutDateResponse'
    post:
      tags:
      - Blockout Dates
      summary: Create a blockout date
      description: Creates a blockout date. Requires `blockout_dates:write`.
      operationId: createBlockoutDate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BlockoutDateRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BlockoutDateResponse'
  /external/v1/whoami:
    get:
      tags:
      - Identity
      summary: Identify the current API key
      description: Returns the API key name, key creation time, and organization context
        for the authenticated hca-api-key header.
      operationId: whoami
      responses:
        '200':
          description: Authenticated API key identity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdentityResponse'
        '401':
          description: Missing, malformed, or invalid API key
  /external/v1/universal-categories:
    get:
      tags:
      - Universal Categories
      summary: List universal categories
      description: Returns canonical product categories. Results are global categories
        and are available to any authenticated external API key.
      operationId: getUniversalCategories
      parameters:
      - name: limit
        in: query
        description: Maximum number of categories to return. Maximum is 100.
        required: false
        schema:
          maximum: 100
          minimum: 0
          type: integer
          format: int32
          default: 100
        example: 100
      - name: offset
        in: query
        description: Zero-based result offset for pagination.
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 0
      - name: search
        in: query
        description: Case-insensitive category name or label search text.
        required: false
        schema:
          type: string
        example: flower
      - name: sortTarget
        in: query
        description: Field to sort by.
        required: false
        schema:
          type: string
          enum:
          - LABEL
        example: LABEL
      - name: sortDirection
        in: query
        description: Sort direction. Prefer ASC or DESC; lowercase values are deprecated
          aliases.
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          - ASC
          - DESC
          - ASC_NULLS_FIRST
          - ASC_NULLS_LAST
          - DESC_NULLS_FIRST
          - DESC_NULLS_LAST
        example: ASC
      responses:
        '401':
          description: Missing, malformed, or invalid API key
        '200':
          description: Paged universal category results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitOffsetResponseUniversalCategoryResponse'
        '400':
          description: Invalid query parameter
  /external/v1/universal-brands:
    get:
      tags:
      - Universal Brands
      summary: List universal brands
      description: Returns canonical brands for the API key organization. Requires
        the organization_metadata:read scope.
      operationId: getUniversalBrands
      parameters:
      - name: limit
        in: query
        description: Maximum number of brands to return. Maximum is 100.
        required: false
        schema:
          maximum: 100
          minimum: 0
          type: integer
          format: int32
          default: 100
        example: 100
      - name: offset
        in: query
        description: Zero-based result offset for pagination.
        required: false
        schema:
          minimum: 0
          type: integer
          format: int32
          default: 0
        example: 0
      - name: search
        in: query
        description: Case-insensitive brand name search text.
        required: false
        schema:
          type: string
        example: acme
      - name: sortTarget
        in: query
        description: Field to sort by.
        required: false
        schema:
          type: string
          enum:
          - NAME
        example: NAME
      - name: sortDirection
        in: query
        description: Sort direction. Prefer ASC or DESC; lowercase values are deprecated
          aliases.
        required: false
        schema:
          type: string
          enum:
          - asc
          - desc
          - ASC
          - DESC
          - ASC_NULLS_FIRST
          - ASC_NULLS_LAST
          - DESC_NULLS_FIRST
          - DESC_NULLS_LAST
        example: ASC
      responses:
        '403':
          description: API key does not include organization_metadata:read
        '200':
        

# --- truncated at 32 KB (168 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/happy-cabbage-analytics/refs/heads/main/openapi/happy-cabbage-analytics-happy-buyers-external-openapi.yml