openapi: 3.1.1
info:
  title: BUYER PUBLIC Business Units UOM API
  version: '3'
  description: The Fairmarkit Buyer API is a RESTful API that uses HTTP requests to allow you to access and use your Fairmarkit data. It has predictable resource-oriented URLs that use standard HTTP response codes, authentication, and verbs. See the Fairmarkit API developer portal for more information.
  termsOfService: https://www.fairmarkit.com/terms-of-service
  contact:
    name: Fairmarkit Support
    url: https://fmkt.zendesk.com/hc/en-us
    email: support@fairmarkit.com
servers:
- url: https://staging.fairmarkit.com/
tags:
- name: UOM
paths:
  /services/self-service/api/v4/uom/uoms:
    get:
      tags:
      - UOM
      summary: List UOMs
      operationId: UomApi_get_available_permission_set_list_services_self_service_api_v4_uom_uoms_get
      parameters:
      - required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          title: Limit
          default: 20
          description: Maximum number of records to return. Defaults to 20.
        name: limit
        in: query
        description: Maximum number of records to return. Defaults to 20.
      - required: false
        schema:
          type: integer
          minimum: 0
          title: Offset
          default: 0
          description: Zero-based offset of the first record to return. Defaults to 0.
        name: offset
        in: query
        description: Zero-based offset of the first record to return. Defaults to 0.
      - required: false
        schema:
          type: boolean
          title: Active
          description: Filter by active status.
        name: active
        in: query
        description: Filter by active status.
      - required: false
        schema:
          type: string
          title: Search
          description: Search term used to filter results.
        name: search
        in: query
        description: Search term used to filter results.
      - required: false
        schema:
          type: string
          title: X-Fm-Api-Key
        name: X-FM-API-KEY
        in: header
      responses:
        '200':
          description: Successful Response
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/UOMListRetrieve'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      description: Returns a list of UOMs.
components:
  schemas:
    UOMListRetrieve:
      properties:
        results:
          items:
            $ref: '#/components/schemas/UOMRetrieve'
          type: array
          title: Results
        next:
          type: string
          title: Next
        previous:
          type: string
          title: Previous
      type: object
      required:
      - results
      title: UOMListRetrieve
    UOMRetrieve:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        title:
          type: string
          title: Title
        abbreviation:
          type: string
          title: Abbreviation
        code:
          type: string
          title: Code
        description:
          type: string
          title: Description
        is_active:
          type: boolean
          title: Is Active
      type: object
      required:
      - id
      - title
      - abbreviation
      - code
      - is_active
      title: UOMRetrieve
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      description: Validation error response.
      properties:
        detail:
          title: Detail
          type: array
          description: Details about a specific error to display in error response.
          items:
            $ref: '#/components/schemas/ValidationError'
    ValidationError:
      title: ValidationError
      required:
      - loc
      - msg
      - type
      type: object
      description: Details for a validation error.
      properties:
        loc:
          title: Location
          type: array
          description: Error location
          items:
            anyOf:
            - type: string
            - type: integer
        msg:
          title: Message
          type: string
          description: Human readable explanation of the error.
        type:
          title: Error Type
          type: string
          description: Computer-readable identifier of the error type.