---
title: "Look up a promotion code"
url: "https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78/operations/getPromotion"
---

> Full API specification: https://portal.konghotels.cloud/apis/kong-hotels-partner-api-1/versions/23cc133a-2f87-4d55-9490-0b8b2bb7dd78.md

# Look up a promotion code

`GET` `/promotions/{promotionCode}`

Operation ID: `getPromotion`

Pass `property`, `check_in` and `check_out` to check whether the code applies to a stay (`meta.eligibility`).

## Path parameters

- `promotionCode` (string, required)

## Query parameters

- `property` (string, optional)
- `check_in` (string, date, optional)
- `check_out` (string, date, optional)

## Responses

- `200` - The promotion.
- `404` - Not found, or owned by another partner.
- `422` - Invalid input or a booking rule violation.

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Kong Hotels Partner API
  version: 1.0.0
servers:
  - url: https://api.konghotels.cloud
    description: Kong Gateway
paths:
  /promotions/{promotionCode}:
    get:
      tags:
        - Promotions
      operationId: getPromotion
      summary: Look up a promotion code
      description: Pass `property`, `check_in` and `check_out` to check whether the
        code applies to a stay (`meta.eligibility`).
      parameters:
        - name: promotionCode
          in: path
          required: true
          schema:
            type: string
            examples:
              - KONGWEEKEND
        - name: property
          in: query
          schema:
            type: string
        - name: check_in
          in: query
          schema:
            type: string
            format: date
        - name: check_out
          in: query
          schema:
            type: string
            format: date
      responses:
        "200":
          description: The promotion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: "#/components/schemas/Promotion"
                  meta:
                    type: object
                    properties:
                      eligibility:
                        $ref: "#/components/schemas/PromotionEligibility"
        "404":
          $ref: "#/components/responses/NotFound"
        "422":
          $ref: "#/components/responses/ValidationFailed"
security:
  - KongKeyAuth: []
  - KongConsumer: []
components:
  schemas:
    Promotion:
      type: object
      properties:
        code:
          type: string
          examples:
            - KONGWEEKEND
        name:
          type: string
        description:
          type: string
        discount:
          type: object
          properties:
            type:
              type: string
              enum:
                - percent
                - fixed_amount
            value:
              type: string
              examples:
                - "12.00"
            currency:
              type:
                - string
                - "null"
              description: Only for fixed_amount; the promotion applies only to properties in
                this currency.
        booking_window:
          type: object
          properties:
            from:
              type: string
              format: date
            until:
              type: string
              format: date
        stay_window:
          type: object
          properties:
            from:
              type:
                - string
                - "null"
              format: date
            until:
              type:
                - string
                - "null"
              format: date
        min_nights:
          type: integer
        property_codes:
          type:
            - array
            - "null"
          items:
            type: string
          description: null means all properties.
    PromotionEligibility:
      type: object
      properties:
        property_code:
          type: string
        check_in:
          type: string
          format: date
        check_out:
          type: string
          format: date
        is_eligible:
          type: boolean
        reasons:
          type: array
          items:
            type: string
            enum:
              - not_currently_bookable
              - property_not_participating
              - stay_dates_outside_window
              - minimum_nights_not_met
              - currency_mismatch
    Problem:
      type: object
      description: RFC 9457 problem details. Extra members (e.g. `available_units`,
        `restrictions`, `reasons`) may be present.
      required:
        - type
        - title
        - status
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
        detail:
          type: string
        instance:
          type: string
        request_id:
          type: string
      additionalProperties: true
    ValidationProblem:
      allOf:
        - $ref: "#/components/schemas/Problem"
        - type: object
          properties:
            errors:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            restrictions:
              type: array
              items:
                type: string
  responses:
    NotFound:
      description: Not found, or owned by another partner.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/Problem"
          example:
            type: https://developers.konghotels.example/problems/not-found
            title: Resource not found
            status: 404
            detail: Property not found.
            instance: /properties/KXXXX
            request_id: 9a8b7c6d-5e4f-4a3b-2c1d-0e9f8a7b6c5d
    ValidationFailed:
      description: Invalid input or a booking rule violation.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ValidationProblem"
          examples:
            validation:
              value:
                type: https://developers.konghotels.example/problems/validation-failed
                title: Validation failed
                status: 422
                detail: One or more fields are invalid.
                instance: /quotes
                request_id: 7e6d5c4b-3a2f-4e1d-8c0b-9a8f7e6d5c4b
                errors:
                  check_out:
                    - The check out field must be a date after check in.
            bookingRule:
              value:
                type: https://developers.konghotels.example/problems/booking-rule-violation
                title: Booking rule violation
                status: 422
                detail: Rate plan ADV cannot be sold for these dates.
                instance: /quotes
                request_id: 8f7e6d5c-4b3a-4f2e-9d1c-0b9a8f7e6d5c
                restrictions:
                  - min_advance_purchase
  securitySchemes:
    KongKeyAuth:
      type: apiKey
      in: header
      name: apikey
      description: Your API key, validated by Kong Gateway. The header name depends on
        the gateway's key-auth configuration.
    KongConsumer:
      type: apiKey
      in: header
      name: X-Consumer-ID
      description: "**Local development only.** Simulates the consumer identity Kong
        Gateway injects after authentication."
```