This is the initial version of the UGAL API and is still subject to changes.

Email support@ugal.com with any question or comment.

UGAL API - Product catalogs

The catalogs API application requires authentication and provides information about all product catalogs available on the website.

Reading a collection of catalogs

URL GET @ http://{siteName}.ugal.com/api/v1/catalogs.xml
Pagination ?p={pageId}

Returns a collection of catalogs (25 catalogs per page):

// Status: 200 OK
<catalogs>
    <catalog>
        <id>4536</id>
        <title>Bikes for sale</title>
        <status>online</status>
        <url>http://sitename.ugal.com/bikes-for-sale</url>
        <link>http://sitename.ugal.com/api/v1/4536.xml</link>
    </catalog>
    <catalog>
        <id>4587</id>
        <title>Accessories for sale</title>
        <status>online</status>
        <url>http://sitename.ugal.com/accessories-for-sale</url>
        <link>http://sitename.ugal.com/api/v1/4587.xml</link>
    </catalog>
    {...}
</sites>

Reading a catalog

URL GET @ http://{siteName}.ugal.com/api/v1/catalogs/{catalogId}.xml

Returns a representation of the catalog:

// Status: 200 OK
<catalog>
    <id>4536</name>
    <title>Bikes for sale</account>
    <status>online</status>
    <url>http://sitename.ugal.com/bikes-for-sale</url>
</catalog>

Table Of Content

Introduction

Website API

Partner API

Appendixes