Glossary

Here you’ll find definitions for terms used in the documentation as well as information about common parameters and entities.

Basket

(Bag / Kart) A shopping basket is a collection of items that the customer intends to purchase. The contents of the basket will generally be variants of products or a gift voucher. It is not possible for a basket to contain both products and a gift voucher.

When products are added to a basket, the appropriate amount of stock is reserved for that customer. This has two implications;

  1. When you add a product to the basket, a stock level check is performed to ensure that there is adequate stock to accommodate the potential purchase. Stock levels may have changed, so something that was described as ‘in stock’ when being viewed might be ‘out of stock’ attempting to add to the basket.
  2. Stock is reserved (i.e. assigned to the basket) for a specific amount of time (currently 1 hour – but this is subject to change). Once that time expires, the stock is released (i.e. made available for other customers) and the item is automatically moved into the customers ‘saved basket’.

category

The ASOS product catalogue is arranged into a tree like structure of categories and floors. Think of ASOS as a large department store where there are Women’s and a Men’s floors with each floor having various departments.

A category is a group of products set up to be shown together for example “Dresses”, “Beauty” or “Jewellery & Watches”.  The category structure is hierarchical and the master parent nodes are floors. Our main floors are Women (id 1000) and Men (id 1001).

A category can also contain other child categories, for example Beauty (id 1314) contains sub categories for different types of beauty products including Hair, Make-up, Nails and more.

A product can exist in more than one category.

categoryId

Identifier for a category.

currency

Three letter code for the currency you wish to show prices in. These are based on ISO 4217 currency designators, with the exception of RMB which can be used instead of CNY for Chinese Yuan. Default is GBP.  Supported values: GBP, EUR, USD, SEK, NOK, DKK, AUD, RUB, CAD, RMB, CNY.

customerId

This unique string is the id that links a customer to their basket and their saved items throughout their time at ASOS. A customer is given a new id when they first visit the site and their basket or saved basket information is linked to this. Registering will associate the id with the customer's account. When a customer logs in to their account their registered id replaces any temporary id they were given and any basket or saved basket information is transferred to the correct id.

Currently the customerId can only be obtained from the customerguid value found in the asos.com cookie ‘asos’. This will be rectified in a later API release.

Filtering / Refining

Process of further reducing the product set in a category or search results collection by choosing prefered refinement options. For example in category for dresses choosing colour Blue and brand ASOS would return only blue ASOS dresses from that category.

locale

This parameter is reserved for future use. Always pass ‘en_API’ as the value.

refine

Parameter. Semi colon delimited string of refinement filter options in the format NameOne:ValueOne;NameTwo:ValueTwo.

The name:value pairs can be initially retrieved from the facets section of an unrefined category or search result product listings response. 

sortBy

String parameter passed into some API methods to indicate the sort order of results. Allowed values:

  • AlphaAscending - Alphabetical order ascending.
  • AlphaDescending - Alphabetical order descending.
  • FreshnessAscending - Orders items by how new they are on the site. Newer items first.
  • FreshnessDescending - Orders items by how new they are on the site. Older items first.
  • PriceAscending - Order by price ascending.
  • PriceDescending - Order by price descending.
  • PriceTypeAscending - Display discounted items before full price items.
  • PriceTypeDescending - Display full price items before discounted items.
  • none

Variant

Represents a particular size and colour combination for a product. Variants are what the user actually adds to the basket and they relate directly to physical items of stock in our warehouse. Think of the Product item as representing the idea of a product (eg “ASOS Wrap Dress with Tie Waist”) and its variants being the detail or the ‘tangible’ items people buy (eg Black, size UK 10). Variants of the same product can have different prices.

1 Comment

  1. citysexylingerie3 years ago

    I love the elegant dress that allows me to be more confident. Today I found a very elegant dress, shopping http://www.citysexylingerie.com I have to admit, dress impressive, and I really like it. But before you order on this website, I'd like to know your opinion. Worth going to?

Please sign in to post a comment.