This page is outdated. Please go to our new documentation under .
What are listings?
Listings are the items we offer in a facilty. Even though they are optional, they are very helpful for several functionalities, especially the dynamic order routing. For more information on the entity, please see Listing.
Why has every facility its own listings?
An article that we offer in Lisbon might not run at all in Helsinki. That's why it makes more sense to not list that article in facilities which do not sell an item. In this tutorial the items offered are very similar. In Helsinki, LU.XY does not sell summer dresses and sandals. In Lissabon, they don't sell winter boots and parkas.
Adding listings to the facilities
After we decided which items to list in which facility, we can start to add them to the facilities. In this tutorial page, we start with the store in Frankfurt, where all items are sold. You need the ID of the facility you want to create a listing in. The ID can be received via the facility endpoint, which we used to create the facility.
For adding a listing, we send a PUT request to the containing a ListingsForCreation object:
The response should be an empty 200 OK response, if the request was successful. Let's have a look at the properties:
tenantArticleId: The ID the article has in your systems, must be unique.
price: The price at which the article is sold.
title: The title that article has.
imageUrl: URL where an image is found of that article, will be shown in the clients we offer.
scannableCodes: List of scannable codes for that item. Used while picking. Might be the EAN or any other barcode.
mesaurementUnitKey: Unit in which that article is count, in this case we sell hole units of garments. In the food context, that might a weighing unit like kilograms.
With the facilities and the listings being set, we can start using the orders endpoint for testing.
