Klook Supplier API

openapi: 3.1.0
info:
  title: OCTO API Specification Availability Supplier API
  version: '1.0'
  contact:
    email: sayhello@octo.travel
    url: https://www.octo.travel/contact
    name: OCTO Standards NP Inc
  description: 'OCTO (Open Connectivity for Tours, Activities, and Attractions) is an open standard API specification for the in-destination experiences sector of the travel industry. The standard defines agreed-upon schemas, endpoints, and capabilities commonly needed when connecting platforms, resellers, OTAs, and other technologies in tours, activities, and attractions._


    OCTO is open source. Available to anyone who wants to use it. You do not need to be a member to use this specification in your business.'
servers:
- url: https://api.example.com/octo
tags:
- name: Supplier
  externalDocs:
    url: https://docs.octo.travel/octo-core/supplier
    description: Docs
paths:
  /supplier:
    get:
      summary: Get Supplier
      tags:
      - Supplier
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                x-examples:
                  example-1:
                    id: 697e3ce8-1860-4cbf-80ad-95857df1f640
                    name: Edin Explore
                    endpoint: https://api.ventrata.com/api-octo
                    contact:
                      website: null
                      email: support@ventrata.com
                      telephone: null
                      address: Marble Arch, London, W1H 7EJ, United Kingdom
                examples:
                - id: 48b4d2e9-cd8b-4ac2-a5ee-4217bf2622c2
                  name: John Doe's company
                  endpoint: http://example.com
                  contact:
                    website: null
                    email: john.doe@email.com
                    telephone: null
                    address: null
                properties:
                  id:
                    type: string
                    example: 697e3ce8-1860-4cbf-80ad-95857df1f640
                    description: Unique identifier used in the platform to represent the supplier.
                  name:
                    type: string
                    description: Name the supplier uses to identify itsel. Usually what the end customer will know the supplier as.
                    example: Edin Explore
                  endpoint:
                    type: string
                    format: uri
                    description: This is the base URL that will be prepended to ALL other paths. The value SHOULD NOT contain a trailing `/`.
                    example: https://api.my-booking-platform.com/v1
                  contact:
                    type: object
                    required:
                    - website
                    - email
                    - telephone
                    - address
                    properties:
                      website:
                        type:
                        - 'null'
                        - string
                        format: uri
                        description: This SHOULD be the website of the Supplier that is separate from the Booking Platform but MAY be a unique destination within the Booking Platform about the Supplier.
                        example: https://acme-tours.co.fake
                      email:
                        type:
                        - 'null'
                        - string
                        format: email
                        description: The email support contact for the Supplier.
                        example: info@edinexplore.com
                      telephone:
                        type:
                        - 'null'
                        - string
                        description: The phone support contact for the Supplier.
                        example: +1 888-555-1212
                      address:
                        type:
                        - 'null'
                        - string
                        description: The (snail) mail address support contact for the Supplier.
                        example: 123 Fake St. Springfield, USA
                required:
                - id
                - name
                - endpoint
                - contact
      description: Returns the supplier and associated contact details.
components:
  securitySchemes:
    Auth:
      type: http
      scheme: bearer
externalDocs:
  url: https://docs.octo.travel/
  description: OCTO Developer Hub