ERP API Services

Updated on
 
The diagram shows the general sequence for the processing of leads and sales via zanox ERP Web Services:
 
 

Step 1: Login

You authenticate yourself vis-à-vis zanox ERP Web Services with UserService login method. This method returns a ticket string with which you authenticate yourself for every further SOAP request. The ticket becomes invalid after 20 minutes of inactivity or if the logout method is activated.

Step 2: Export

The export service enables the export of existing leads, sales or shopping baskets. A zanox-wide unique tracking ID is delivered for each dataset. Based on this tracking ID, the desired amendments can be carried out on the relevant lead, sale or shopping basket by means of a subsequent update process.

Step 3: Import

During import, a distinction is drawn between the import types "Update" and "Insert." Amended tracking information is designated as "Update," newly-imported tracking information as "Insert".
 
The import service provides all necessary methods for the Update. Status changes (confirmations, rejections) can be carried out on existing leads and sales. In addition to this, detail information can be added, such as a processing note or the total price (only for sales). In this regard, the UpdatePpl, UpdatePps and UpdateBasket methods are used.
 
On the other hand, new sales, which are unknown to the zanox system can be inserted using the Insert methods. In the event of an Insert, the tracking ID will be generated at the time of import.
 
The import occurs in two phases. In phase 1, the leads and sales are saved by the ERP Web Services at zanox. Phase 2 runs as an automatic job independent of phase 1. In doing so, the data from phase 1 is regularly processed and the changes made visible to advertisers and publishers. zanox guarantees that the processing and visualisation of imported datasets will occur at least once a day.
 
During import, every Insert or Update process is assigned a so-called history ID. You will receive this ID as a return value of your Insert or Update process. You can obtain access to the current processing status via the history ID. In this regard, you should use the GetImportLog method.

Step 4: Error output

Any error messages from import phase 1 will be transmitted to you directly after the import. In addition to this, you will receive details regarding how many leads and sales were received and how many leads and sales were transferred to the import job. To this end, for each non-transferred lead/sale, the corresponding error will be transmitted. Ideally, you should retrieve the error messages from import phase 2 by means of a cronjob or similar. Here, an error code will be stated for each failed lead/sale.

Possible error codes:

Ignored: The lead/sale is already in the desired state. Consequently, an update will be ignored.
 
Rejected: The lead/sale has already been confirmed or the partner ID is incorrect (i.e. invalid/inapplicable to the program/stems from a cancelled partnership, etc.). Consequently, an update will be rejected.
 
The error messages can then be sent to the responsible person, e.g. by email, so that the problem can be escalated.

Overall sequence

The general sequence of events can be summarised as follows:
  1. Export of the leads/sales for a defined period
  2. Review of the leads/sales using ones own system, setting of values for Review_State (Status), Review_Note (Note) and, where required, amendment of the total price (only for sales)
  3. Import of the leads/sales and saving the history ID
  4. In the event that there are further sales in your system, which should be assigned to publishers (bonus transactions, etc.), these may be added by means of Insert. > Save history ID
  5. Retrieval of the status of import and update errors and, where applicable, escalation
  6. 24 hours later: Retrieval of the status of processing and, where applicable, escalation
 
In the following sections, the above-mentioned steps are explained on the basis of the methods of the zanox ERP Web Services. Particular attention is to be paid to the stipulated required parameters for an Insert and Update.