v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Order

Fulfil Order

This method allows the calling application to fulfil an existing Order

post/order/fulfil

Headers

X-EES-AUTH-CLIENT-IDstring string required

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

X-EES-AUTH-HASHstring string required

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

Connection'close' | 'keep-alive'

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).

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

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.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

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

X-CUSTOM-SUBSYSTEM-IDstring string

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

X-CUSTOM-KEYstring string

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

Request body

itemIdinteger

EES AIR Order Item ID

tokensstring[]
amountinteger

Amount value denominated to smallest currency unit (for GBP this should be in pence)

Response

Created

itemIdinteger

EES AIR Order Item ID

orderIdinteger

EES AIR Order ID

programmeIdinteger

EES AIR Campaign ID

consumerIdinteger

EES AIR Consumer ID

quantityinteger

Order Item Token quantity

status'COMPLETE' | 'AWAITING_FULFILMENT' | 'FAILED'

Order Item Fulfilment status

deliveryIdinteger

EES AIR Delivery ID

valueinteger

Value

totalinteger

Total

discountTotalinteger

Discount Total

accountsstring[]
dateCreatedstring date-time

Creation Date Time

lastUpdatedstring date-time

Last Updated Date Time

tokensstring[]