Sections
Products
The products API application requires authentication and provides information about all products available on the website.
Read a collection of products
| URL | GET @ http://{siteName}.ugal.com/api/v1/products.xml |
|---|---|
| Filters |
?catalogId={catalogId} ?title={productTitle} |
| Pagination | ?p={pageId} |
Returns a collection of products (25 products per page):
// Status: 200 OK
<products>
<product>
<id>2811</id>
<title>BMW X5</title>
<status>online</status>
<url>http://sitename.ugal.com/cars/bmw-x5</url>
<link>http://sitename.ugal.com/api/v1/products/2811.xml</link>
<catalog>
<id>4322</id>
<title>Cars</title>
<status>online</status>
<url>http://sitename.ugal.com/cars</url>
<link>http://sitename.ugal.com/api/v1/catalogs/4322.xml</link>
</catalog>
</product>
{...}
</products>
Read a product
| URL | GET @ http://{siteName}.ugal.com/api/v1/products/{productId}.xml |
|---|
Returns a representation of the product:
// 200 OK
<product>
<id>2786</id>
<title>Porsche 911</title>
<status>online</status>
<url>http://sitename.ugal.com/cars/porsche-911</url>
<catalog>
<id>4322</id>
<title>Cars</title>
<status>online</status>
<url>http://sitename.ugal.com/cars</url>
<link>http://sitename.ugal.com/api/v1/catalogs/4322.xml</link>
</catalog>
<items>
<item>
<reference>911-red</reference>
<status>online</status>
<label>Red</label>
<link>http://sitename.ugal.com/api/v1/items/911-red.xml</link>
</item>
<item>
<reference>911-blue</reference>
<status>online</status>
<label>Blue</label>
<link>http://sitename.ugal.com/api/v1/items/911-blue.xml</link>
</item>
</items>
</product>