try out ↗

← API Index


/api/logon4

Authenticate a user and return session and cache information

Change Note: dedicated logon endpoint, replaces generic exec3.jsp dispatch

Parameters

Name Description Type
cid user id string
pass user password string
guest true: dummy guest logon to obtain a valid session. boolean
auto if true the session is automatically assigned the next possible delivery day boolean
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Response Types

Type Version Description
LogonResult 1 Result of a logon attempt with session and cache information
ShopDate 8 A delivery date with order, tour, shipping, and address information

OpenAPI

See logon4.yaml

Referenced in skills