AlzaTrade API - How to use

A guide on how to use the functionality available through the AlzaTrade API.

Orders

The endpoint /orders is used to obtain a paginated collection of orders with support for filtering and sorting via query parameters.

Using the /orders/unshipped endpoint, you can download your unshipped orders. The resulting data can be filtered by shipment departure time from-to. The filter is optional. If not specified, all unshipped orders will be returned.

Listings

The /listings endpoint group is used for product listing operations. It currently includes endpoints to retrieve data for categories and their templates, which can be used to list a product.

To retrieve available categories, you can use two endpoints:

  • /listings/categories - returns category data as a single collection
  • /listings/categories/tree - returns categories in a tree structure, as they are displayed in the Alza Trade portal
To retrieve a list of manufacturers, call /listings/manufacturers. No filters are used here, it is a static list.

If you want to retrieve a template for a selected category based on its ID, the simplest way is to call the /listings/templates endpoint and include the desired category ID (one or more IDs at once) in the parameter. Use this endpoint if you intend to retrieve data for a small number of categories (up to 50). Repeated or parallel calls may exceed the rate limit, resulting in an HTTP 429 - Too Many Requests response.

If you need data for a larger number of categories or all categories, use a combination of endpoints to assemble the category template. These include:

  • /listings/parameters - parameters linked to categories
  • /listings/seo-prefixes - a collection of SEO prefixes linked to categories
These endpoints can be called with or without category filters. If no filter is applied, data for all categories is retrieved. These operations may take a longer time.

Have any questions? Contact us