openapi: 3.2.0
info:
  title: Hostfully Orders 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: Orders
paths:
  /api/v3.3/orders:
    get:
      tags:
      - Orders
      summary: Get orders with filters
      description: Retrieves orders with optional filtering by guest UID, property UID, lead UID or update timestamp. At least one filter parameter must be provided
      operationId: getAll_9
      parameters:
      - name: guestUid
        in: query
        required: false
        schema:
          type: string
      - name: propertyUid
        in: query
        required: false
        schema:
          type: string
      - name: leadUid
        in: query
        required: false
        schema:
          type: string
      - name: updatedSince
        in: query
        required: false
        schema:
          type: string
          example: '2026-04-20T11:52:36'
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrdersApiResponseWrapper'
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
    OrderChannelCommissionApi3Dto:
      type: object
      properties:
        amount:
          type: number
    OrdersApiResponseWrapper:
      type: object
      properties:
        orders:
          type: array
          items:
            $ref: '#/components/schemas/OrderApi3Dto'
        _metadata:
          $ref: '#/components/schemas/Api3ResponseMetadata'
    DiscountGraphQLApiTO:
      type: object
      properties:
        discountCode:
          type: string
        discountType:
          type: string
          enum:
          - AMOUNT
          - PERCENT
        amount:
          type: number
        percent:
          type: number
    Api3ResponseMetadata:
      type: object
      properties:
        count:
          type: integer
          format: int32
        totalCount:
          type: integer
          format: int32
    OrderFeesApi3Dto:
      type: object
      properties:
        cleaningFee:
          $ref: '#/components/schemas/OrderFeeApi3Dto'
        otherFees:
          type: array
          items:
            $ref: '#/components/schemas/OrderFeeApi3Dto'
    OrderApi3Dto:
      type: object
      properties:
        uid:
          type: string
        leadUid:
          type: string
        creationUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        updatedUtcDateTime:
          type: string
          example: '2026-04-20T11:52:36'
        rent:
          $ref: '#/components/schemas/OrderRentApi3Dto'
        securityDeposit:
          type: number
          description: "The securit deposit paid, if any, in this reservation. \n1. It is not inclusive in case the Additional Charge Option is enabled for the agency \n2. It is not inclusive for normal Security Deposit (due at check in)\n3. It is inclusive for normal Security Deposit (due at booking time)"
        fees:
          $ref: '#/components/schemas/OrderFeesApi3Dto'
        services:
          type: array
          items:
            $ref: '#/components/schemas/OrderServiceApi3Dto'
        adjustments:
          type: array
          items:
            $ref: '#/components/schemas/OrderAdjustmentApi3Dto'
        rateMultiplier:
          type: number
        currency:
          type: string
          enum:
          - USD
          - EUR
          - GBP
          - CAD
          - JPY
          - INR
          - MYR
          - AUD
          - KES
          - MXN
          - HKD
          - NZD
          - CHF
          - BRL
          - CLP
          - COP
          - PEN
          - ARS
          - UYU
          - VEF
          - CNY
          - THB
          - KRW
          - IDR
          - SGD
          - TWD
          - AED
          - ZAR
          - CZK
          - DKK
          - DOP
          - SEK
          - BGN
          - ILS
          - NOK
          - RON
          - RUB
          - PHP
          - VND
          - HUF
          - IKR
          - PLN
          - PYG
          - TRY
          - GTQ
          - VUV
          - JOD
          - SAR
          - EGP
          - TTD
          - MAD
          - CVE
          - BBD
          - AWG
          - BHD
          - NONE
        totalAmount:
          type: number
        totalTaxesAmount:
          type: number
        channelCommission:
          $ref: '#/components/schemas/OrderChannelCommissionApi3Dto'
        adjustmentItems:
          type: array
          items:
            $ref: '#/components/schemas/OrderAdjustmentItemApi3Dto'
        externalOrderId:
          type: string
    OrderServiceApi3Dto:
      type: object
      properties:
        title:
          type: string
        grossPrice:
          type: number
        quantity:
          type: integer
          format: int32
        quantityDescription:
          type: string
        serviceUid:
          type: string
        uid:
          type: string
    OrderRentApi3Dto:
      type: object
      properties:
        rentNetPrice:
          type: number
        rentBreakdowns:
          type: array
          items:
            $ref: '#/components/schemas/OrderRentBreakdownApi3Dto'
        extraGuestsNetPrice:
          type: number
        listPrice:
          type: number
        discount:
          $ref: '#/components/schemas/DiscountGraphQLApiTO'
        netPrice:
          type: number
        taxationRate:
          type: number
        taxAmount:
          type: number
        grossPrice:
          type: number
    OrderFeeApi3Dto:
      type: object
      properties:
        uid:
          type: string
        name:
          type: string
        amountType:
          type: string
          enum:
          - AMOUNT
          - TAX
        isEditable:
          type: boolean
        netPrice:
          type: number
        taxationRate:
          type: number
        taxAmount:
          type: number
        grossAmount:
          type: number
        grossPrice:
          type: number
    OrderAdjustmentApi3Dto:
      type: object
      properties:
        isPaid:
          type: boolean
        amount:
          type: number
    OrderRentBreakdownApi3Dto:
      type: object
      properties:
        nightlyAmount:
          type: number
        nightlyDate:
          type: string
          format: date
  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