EAeagleeye
Order

Cancel Order

This method allows the calling application to cancel an existing Order that is awaiting fulfilment. Only plastic card (or mixed) orders that have not already been fulfilled can be cancelled.

patch/order/{orderId}/cancel

Request

  • Base URL
    https://consumer.uk.eagleeye.com/2.0
  • URL
    https://consumer.uk.eagleeye.com/2.0/order/{orderId}/cancel
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID

Path parameters

orderIdinteger required

EES AIR Order ID.

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-*

Response

Order Cancelled

orderIdinteger

EES AIR Order ID

unitIdinteger

EES AIR Unit ID

creatorIdinteger

EES AIR Creator ID

consumerIdinteger

EES AIR Consumer ID

referencestring

Requested Order Reference

trackingstring

Requested External tracking value

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

EES AIR Order Status

purchaserIdinteger

EES AIR Order Purchaser ID

dateCreatedstring date-time

Order Creation date-time

lastUpdatedstring date-time

Order last update date-time

Changes

No recorded changes to this operation across all 1 revision of this API.