API Information
Introduction¶
v 2.0
Section 2¶
V2.0
Our API documentation can be found at http://api.exigo.com . On this website, we provide the full
SOAP, input and output properties and examples in multiple languages, including C# (Exigo’s
recommended language), and VB.
Our API can be used outside of our software to perform many of Exigo’s functions, including
creating, returning and updating customers, creating orders and autoships, charge credit cards and
other payments, and many other functions. In order to use our API, you must have a special
username and password setup by Exigo. You will have one set of credentials by default, but you can
request additional ones if you would like one for any additional vendors.
Our API’s cannot be written directly into our content engine, but API’s can be included into your
pages in a .NET User Control (file ending in .ascx). We manage your API features within the content
engine using Subversion (SVN), a version-controlled environment integrated with our software. To
manage your SVN, we recommend a free software called TortoiseSVN
(http://tortoisesvn.net/downloads), but you may use any SVN software you choose.
To use the API web services, you will need a user account with username, password and company
code. Your permission for your user account should be enabled to allow use of the API.
When you click on any web service, you will see little magnifying glasses at the end of some fields. If
you click on the icon, you can login using your user account credentials. You will then be directed to
a list of the parameters that are available for that field for the company. At the top right, you will see
what company you are logged into and you can browse all lookup fields in each web service. You will
be able to look up warehouses, ship methods, customer types, user defined fields, item codes, price
types, etc.
Any "update" service will only modify the fields that are passed. If you do not pass the birthdate
field, then it will not update and the existing value in the database will remain .
Any "set" service will require all fields, such as the account/billing information.
To confirm what fields are required in all services, you can click on the WSDL link at the top left of
the page when you go to api.exigo.com. It will then display the information for all fields in all
services. For any field that has "nillable=true" the default value used by Exigo if a new record will be
used and if the record already exists, the value currently stored in the table will remain and not
change.
Any technical support for the use of these web services should be requested through our Support
Ticket Tracking system using the API category.