Skip to main content

Headers

Headersโ€‹

When communicating with EVA there are numbers of special headers that can be sent or received.

Request headersโ€‹

Below is the list of headers that can be used when sending data to EVA.

NamePurposeNotesRequired
AuthorizationUser authentication token as received from the Login request.If omitted calls will be made in an anonymous context.Depends on service called.
Accept-LanguagesWhat language (culture) you want your response to be.E.g. en-EN, de-AT.โŒ
EVA-User-AgentIdentifies the client making the call.Required for access management and analytical purposes by the EVA backend .โœ…
EVA-App-TokenAuthentication to distinguish between anonymous calls. Vital for anonymous carts.Automatically applied by the SDK to calls when a new one is received from the backend. Ignored when a logged-in user authentication token is provided.If no Authorization header is set.
EVA-StationIDCurrently active station identifier.Needs to be added for legal reasons to track which station was used for calls lacking the station ID in its payload.No, except for legal reasons.
EVA-Requested-OrganizationUnitIDOrganization unit selection.Can be used to indicate which organization unit a call needs to act on when not specified in its payload.โŒ
EVA-Requested-OrganizationUnit-QueryOrganization unit selection based on a query: { Name: '...', BackendID: '...' }Can be used to indicate which organization unit a call needs to act on when not specified in its payload.โŒ
EVA-IDs-ModeCan be set to ExternalIDs to be able to use BackendIDs instead of EVA identifiersThis applies to: Products, OUs, Orders, OrderLines, Shipments, Payments, and Subscriptions.โŒ
EVA-IDs-LeniencyThresholdNumber of IDs that are allowed to be unresolved in the request.To be used alongside EVA-IDs-Mode in case larger requests fail when some IDs go unresolved. Will return unresolved IDs in the warning header and remove these from the request.โŒ
EVA-IDs-BackendSystemIDxxโŒ
EVA-App-ContextIDUnique call identifier (UUID).Automatically added by the SDK for analytical purposes in tracking individual calls.โŒ
EVA-App-ContextChainIDUnique call chain identifier (UUID).Automatically added by the SDK for analytical purposes in tracking chains of calls.โŒ
EVA-App-PayloadIDUnique request payload identifier (md5 hash).Automatically added by the SDK for analytical purposes in tracking unique request payloads.โŒ
EVA-Service-NameName of the EVA service.Added for analytical purposes.โŒ
ClientNameThe name of the SDK being used.Added for analytical purposes.โŒ
ClientVersionThe SDK version used.Added for analytical purposes.โŒ
EVA-API-VersionThe version of the API typings used in the client application SDK.Added for analytical purposes and to lock out older clients (in the future).โœ…

Response headersโ€‹

Below is the list of headers that can be received from the EVA backend

NamePurposeNotesRequired
EVA-App-TokenNew anonymous application token to be used on consecutive calls.Automatically picked up by the SDK and applied to any future calls.โŒ
EVA-WarningInform clients about using deprecated features or other notices.Can be sent multiple times.โŒ
EVA-OrganizationUnit-ExternalIDs-MapxxโŒ
EVA-Product-ExternalIDs-MapxxโŒ