Login

API Overview
Updated on
 
Logs a user into zanox ERP Web Services. In doing so, definition of a valid and active advertiser
account is required. The advertiser account must have a program that has
been explicitly enabled for the use of zanox ERP Web Services.

Input

<Login xmlns="http://services.zanox.com/erp">
    <username>zanox</username>
    <password>zanox</password>
</Login>

 

Object Data type Description Mandatory?
username normalizedstring User's login name x
password normalizedstring User's password x

Output

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <soap:Header>
      <zanox xmlns="http://services.zanox.com/erp">
         <ticket>XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX</ticket>
      </zanox>
   </soap:Header>
   <soap:Body>
      <LoginResponse xmlns="http://services.zanox.com/erp">
         <user admin="false">
            <name xmlns="http://services.zanox.com/erp/User">zanox</name>
         </user>
      </LoginResponse>
   </soap:Body>
</soap:Envelope>
Object Data type Description
user   Contains one element <name> as child
name normalizedstring Name of the logged-in user

 

Upon successful login, a unique session ticket will be returned in the header to identify the user in the
SOAP header. This ticket later has to be included in all following ERP API requests. The XS schema defines the request header with the auth ticket as mandatory for every request.

Resource Information

Rate Limited? No
Requests per rate limit window N/A
Authentication Requires Authentication
Response Formats xml
Resource family login
Response Object user
API Version 3.0.1.1