Listings in your free trial

Prerequisites

• Access to a free trial tenant (email with credentials)

• Read our Free trial information, Setting up Postman for your free trial, and Facilities in your free trial articles

• Access to Postman (you can use an HTTP tool of your choice, but for this article, we'll focus on working with Postman)

What are listings?

Listings represent the articles offered at a specific facility. Listings are managed per facility, ensuring that only available articles are listed. Although optional, they are essential for certain functionalities, such as dynamic order routing.

A listing can be seen as a product, an item, an article, and so on.

Why does it matter for my free trial?

For this tutorial, we're assuming we're a shop with products to sell and a consumer wants to order those products. For that, we need to attach those products (listings) to our shop (facility).

Let's add a listing to the facility we created.

Create a listing

1

Copy the facility ID

In Postman, copy the id that was created from our Facilities in your free trial article.

2

Open the create facility endpoint

Find the PUT Update Listings For Facility endpoint (under Facilities, then Facility Listings) and click to open. You'll see the body is prefilled with some data for multiple listings. For example:

{
    "listings": [
        {
            "tenantArticleId": "SNEAK-W-4891", // required unique ID you provide for your listing 
            "title": "White sneakers", // optional name of article that will be displayed in Backoffice and apps
            "imageUrl": "https://img.example.com/img/sneakw4891.jpg", // optional image of the article that will be displayed in Backoffice and apps
            "scannableCodes": ["738502847562", "SNEAK-W-4891"] // optional unique ID codes for picking and packing purposes, could be an EAN or barcode
        },
        {
            "tenantArticleId": "TSHIRT-W-2468",
            "title": "Basic T-shirt white",
            "imageUrl": "https://img.example.com/img/tshirtw2468.jpg",
            "scannableCodes": ["829401938473", "TSHIRT-W-2468"]
        }
    ]
}

We're not all the available fields in this example. See our Listings article for more details.

3

Paste the facility ID

In the request, click facilityId and paste your copied ID into the Params.

4

Edit data

You can edit the Body in any way you wish, or leave it as it is.

5

Send the request

Click Send.

Ensure you've refreshed your authToken if it's been more than 60 minutes since your last refresh.

You should get a 200 OK response. You'll notice some extra fields that are part of the response and have been automatically created.

The listing will also be visible in Backoffice for other team members to use, but we'll go through that later in this section.

In the next article, we'll take you through configuring stock. What they are, how to set them up, and how to edit them.