Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Huuray Order API

The Order API from Huuray — 1 operation(s) for order.

Huuray Order API is one of 9 APIs that Huuray publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 6 schemas. It is described by OpenAPI 3.0.1, at version v4.

Requests are made against the base URL https://api.huuray.com.

1 operations 1 paths 6 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v4
Base URL
https://api.huuray.com
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

Huuray Order API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-TOKEN (ApiToken).

  • ApiToken — The API-Token provided to you by Huuray.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Order 1
POST
/v4/Order
Used to order giftcards
2 params body → 200201202400401403404422

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are OrderRequest (7 properties), OrderResponse (6 properties), OrderVoucher (6 properties), OrderProduct (5 properties). Each schema is shown below with its type and property counts.

OrderProduct
object
An object containing information about a product
5 properties 4 required
OrderVoucher
object
An object containing information about a voucher
6 properties
OrderRecipient
object
An object containing information about a single recipient
4 properties
OrderRequest
object
An object containing all the necessary information for ordering giftcards
7 properties 2 required
Response
object
The minimal possible response for any request
3 properties
OrderResponse
object
The response from the Order request
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huuray-order-api-openapi.yml Raw ↑

Other APIs Huuray publishes across the network.

Huuray Balance API
Huuray Cancel API
Huuray Catalogue API
Huuray ExchangeRates API
Huuray Resend API
Huuray Search API
Huuray Stock API
Huuray Template API