openapi: 3.2.0
info:
  title: Hostfully Order Adjustments API
  license:
    name: Apache 2.0
    url: https://www.hostfully.com/
  version: v3.0.1
servers:
- url: https://sandbox-api.hostfully.com
security:
- JWT-Authentication: []
- Agency-API-key: []
tags:
- name: Order Adjustments
paths:
  /api/v3.3/orders/{orderUid}/order-adjustments:
    get:
      tags:
      - Order Adjustments
      summary: Get order adjustments
      description: Returns a list of order adjustments for the specified order ID or UID.
      operationId: getOrderAdjustments
      parameters:
      - name: orderUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderAdjustmentsResponseWrapper'
        '404':
          description: Order not found.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrderAdjustmentsResponseWrapper'
    post:
      tags:
      - Order Adjustments
      summary: Create order adjustment
      description: Creates a new order adjustment for the specified order UID.
      operationId: createOrderAdjustment
      parameters:
      - name: orderUid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderAdjustmentItemAddingApi3Dto'
        required: true
      responses:
        '201':
          description: Order adjustment created successfully.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrderAdjustmentItemApi3ResponseWrapper'
        '401':
          description: Unauthorized access.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrderAdjustmentItemApi3ResponseWrapper'
        '404':
          description: Order not found.
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OrderAdjustmentItemApi3ResponseWrapper'
  /api/v3.3/orders/{orderUid}/order-adjustments/{adjustmentUid}:
    delete:
      tags:
      - Order Adjustments
      summary: Delete order adjustment
      description: Deletes an order adjustment by its UID and the Order's UID.
      operationId: deleteOrderAdjustment
      parameters:
      - name: orderUid
        in: path
        required: true
        schema:
          type: string
      - name: adjustmentUid
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Successful operation.
components:
  schemas:
    OrderAdjustmentItemApi3Dto:
      type: object
      properties:
        uid:
          type: string
        transactionType:
          type: string
          enum:
          - CHARGE
          - REFUND
        adjustmentType:
          type: string
          enum:
          - RENT
          - TAX
          - FEE
          - SERVICE
          - RESOLUTION
        amount:
          type: number
        note:
          type: string
        createdUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        externalId:
          type: string
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    OrderAdjustmentItemApi3ResponseWrapper:
      type: object
      properties:
        orderAdjustmentItem:
          $ref: '#/components/schemas/OrderAdjustmentItemApi3Dto'
    OrderAdjustmentsResponseWrapper:
      type: object
      properties:
        orderAdjustmentItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderAdjustmentItemApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    OrderAdjustmentItemAddingApi3Dto:
      required:
      - adjustmentType
      - amount
      - transactionType
      type: object
      properties:
        transactionType:
          type: string
          enum:
          - CHARGE
          - REFUND
        adjustmentType:
          type: string
          enum:
          - RENT
          - TAX
          - FEE
          - SERVICE
          - RESOLUTION
        amount:
          type: number
        note:
          maxLength: 60
          minLength: 0
          type: string
  securitySchemes:
    JWT-Authentication:
      type: apiKey
      description: OAuth Access Token
      name: Authorization
      in: header
    Agency-API-key:
      type: apiKey
      description: API Key
      name: X-HOSTFULLY-APIKEY
      in: header
externalDocs:
  description: Hostfully Documentation
  url: https://dev.hostfully.com/v3.0/reference
x-readme:
  explorer-enabled: true
  proxy-enabled: true