Authorization


Registration   Forgot password?

API GENERAL INFORMATION


1. Please find Merchant API at the following address:

http://shopxml.com/API/script_name.php

where script_name.php is name of the interface file.

For example:
http://shopxml.com/API/orders.php
http://shopxml.com/API/orders_process.php


2. There is no preference for transmitting the data by GET or POST method unless it is specified. GET method is not the most efficient technique for transmitting long stings of data, so in these cases POST method should be implied.


3. There are two essential variables for using interface. Please remember, certain variables are not mentioned in each specific interface repeatedly. These are the following two variables:

api_id - products database ID
api_key - programming interface key for the above mentioned database which is the code generated by our administrators

For example: http://shopxml.com/API/orders.php?api_id=56&api_key=354dsg43652


4. All transmittable variables should be URL-encoded (as well as its name and value). Parameters can be arrays. In this case parameters name will contain brackets [].

For example: status[43]=3, or order[]=214.
(URL encoded parameter: status%5B43%5D=3, order%5B%5D=214)


5. While using interface the errors can occur. Samples of possible errors are listed below. In the case of error server usually posts the following string:

error|error_id|error_name|error_data

The string of four fields is separated by the symbol | (vertical line), where:

error - keyword - error identification
error_id - ID of an error arisen, integer
error_name - error name, string
error_data - additional data concerning arisen error; each error contains its specific name and format. For the majority of errors (simple error) the field remains empty since it does not require definition. Received interface answer should be checked thoroughly not to be taken with an error. When no error the answer format is generated by specific interface, in the most of cases by XML.

All interfaces are divided by their types: informational (only transmitting information from existing database) and controlling (the type that updates the data on the server). The controlling type of the interface remains the possibility of certain errors, whereas the informational type of interface would not typically get any errors since the incorrect data being extracted from query is transformed into correct values or used, as it is based on the possibility of such scenario.

For example: If incorrect status of the order is entered into search engine of the database, the search result shows no orders in the answer.


6. Some interfaces are defined to handle orders only. Orders by themselves have an important status attribute which is coded as an integer. Example of the status table can be found below.


7. The XML description uses the following definitions:

- if parameter is set in the brackets <field_name> it means that this parameter is utilized by XML and appears as a nested tag.

- if the parameter name does not contain brackets and just specified as field_name it means that it is utilized by XML and appears as an attribute to the tag.

- if the parameter is marked as * symbol, the parameter is optional, in this case it might be absent. Parameters are always present if they are not marked with a * symbol, however some of them might have empty fields.


8. Those parameters with square brackets after the name (status[]) are defined as an array. It means that many of such variables can be transmitted.

For example: status[25]=3&status[35]=5&status[37]=3

Array index (in brackets) may not be essential at all the cases, therefore it could be transmitted as following:
order[]=21&order[]=33&order[]=34
Contact Us Legal and Policies Sitemap
© XMLShop.com 2004 – 2018