Supplier

Get Supplier

Returns the supplier and associated contact details.

get/supplier/

Request

Base URL: http://localhost:8080/api/octo
URL: http://localhost:8080/api/octo/supplier/
Auth: HTTP bearer

Headers

Octo-Capabilitiesstring required

A list of the Capabilities (their IDs) initialized with your request.

Accept-Languagestring

This optional request header allows to specify preferred languages for content in the response. A language code that specifies the language of the product content. This code must conform to the BCP 47 standard, following RFC 5646 and RFC 4647 specifications for language tags. Examples include en-US for American English, fr-FR for French (France), and es-ES for Spanish (Spain). This header supports a comma-separated list of language tags with optional quality values (q) to indicate priority, such as en-US, fr-CA;q=0.8, fr;q=0.7, which prioritizes U.S. English, followed by Canadian French, and general French. This header is defined in the HTTP/1.1 specification (RFC 7231) and is commonly used for internationalized websites and services to enhance user experience. For more details, visit MDN Web Docs: Accept-Language - HTTP | MDN. Note this only determines preference and does not guarantee location has content available in the desired language.

Response

The request has succeeded.

idstring required

Unique identifier for the supplier, used across the platform to represent this supplier entity. This identifier must be unique within the supplier system.

namestring required

Name used to identify the supplier within the platform. This name is typically recognized by end customers as the official name of the supplier's business entity. It should clearly represent the supplier's brand or identity to ensure consistency across platforms. For larger multi-venue suppliers, this represents the parent entity's name. Other associated entities or sub-divisions can be specified using the octo/content capability through the venues field.

endpointstring uri required

The base URL that is prepended to all other API paths. The value should not contain a trailing slash and must follow URI format.

shortDescriptionstring nullable

A brief, customer-facing description of the supplier. This field provides a concise overview of the supplier's business and may be null if no description is available.

Example response

{
  "id": "697e3ce8-1860-4cbf-80ad-95857df1f640",
  "name": "Merlin Entertainments",
  "endpoint": "https://api.my-booking-platform.com/v1",
  "contact": {
    "website": null,
    "email": "support@ventrata.com",
    "telephone": null,
    "address": "Marble Arch, London, W1H 7EJ, United Kingdom"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.