Retail Order

This method allows the calling application to create Gift Voucher or plastic card Order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
include
array of strings

Include either accounts or accounts and tokens in the response.

include
Allowed:
Body Params

JSON payload

string

External reference to this order.

purchaser
object
string

[Optional] The tracking reference, if tracking has been used by the calling application

items
array of objects
items
orderTotals
object
payment
object
meta
object
Headers
string
required

Client ID, This will be provided by EES and is unique to the company calling the API.

string
required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

string
enum
Defaults to close

This general HTTP header controls (or rather influences) whether the network connection stays open after the current transaction finishes. If the sent value is keep-alive, the connection should stay in a special state, allowing to be reused for subsequent requests to the same server. Please note these connections will be closed after reaching timeout threshold by server (usually after 5 seconds).

Allowed:
string
enum

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

Allowed:
string

Unique Reference for the API transaction within the calling company.

string

This flag denotes the number of attempts that have been made for this request.

string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem Id / Name.

string

Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-*

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json