Adding listings to facilities

Listing overview

Listings represent the articles offered at a specific facility. Although optional, they are essential for certain functionalities, such as dynamic order routing.

Facility-specific listings

Different facilities may carry different assortments. For example, an article sold in Lisbon might not be offered in Helsinki. This is why listings are managed per facility, ensuring that only available articles are listed. In this tutorial's example, the assortments are mostly similar, but the Helsinki facility does not offer summer dresses and sandals, while the Lisbon facility does not offer winter boots and parkas.

Create listings for a facility

Once the desired articles for a facility are determined, the listings can be added. This tutorial uses a store in Frankfurt as an example, where all articles are sold.

To create listings, the target facility's ID is required. This ID can be retrieved from the facility endpoint that was used to create the facility. A PUT request containing a ListingsForCreation object is sent to the listings endpoint to add the listings.

PUT https://{YOUR-TENANT-NAME}.api.fulfillmenttools.com/api/facilities/{FACILITY-ID}/listings

{
    "listings": [
        {
            "tenantArticleId": "SNEAK-W-4891",
            "price": 119.00,
            "title": "White Sneakers",
            "imageUrl": "https://img.example.com/img/sneakw4891.jpg",
            "scannableCodes": ["738502847562", "SNEAK-W-4891"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "JEANS-B-2605",
            "price": 59.95,
            "title": "Washed Slim Fit Jeans",
            "imageUrl": "https://img.example.com/img/jeansb2605.jpg",
            "scannableCodes": ["73898484754", "JEANS-B-2605"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "TSHIRT-W-2468",
            "price": 19.90,
            "title": "Basic T-Shirt White",
            "imageUrl": "https://img.example.com/img/tshirtw2468.jpg",
            "scannableCodes": ["5558156789", "TSHIRT-W-2468"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "COAT-C-0304",
            "price": 394.50,
            "title": "Trenchcoat cream",
            "imageUrl": "https://img.example.com/img/coatc0304.jpg",
            "scannableCodes": ["48976451328", "COAT-C-0304"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "LOAFERS-B-1788",
            "price": 79.80,
            "title": "Brown Leather Loafers",
            "imageUrl": "https://img.example.com/img/loafersb1788.jpg",
            "scannableCodes": ["41986457228", "LOAFERS-B-1788"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "OXFORD-W-9766",
            "price": 64.90,
            "title": "White Oxford Button Down Shirt",
            "imageUrl": "https://img.example.com/img/oxfordw9766.jpg",
            "scannableCodes": ["41986457669", "OXFORD-W-9766"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "DRESS-B-5094",
            "price": 49.95,
            "title": "Blue Summer Dress",
            "imageUrl": "https://img.example.com/img/dressb5094.jpg",
            "scannableCodes": ["50986457664", "DRESS-B-5094"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "BLAZER-G-6354",
            "price": 39.99,
            "title": "Green Blazer",
            "imageUrl": "https://img.example.com/img/blazerg6354.jpg",
            "scannableCodes": ["6386457654", "BLAZER-G-6354"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "PANTS-G-4430",
            "price": 39.99,
            "title": "Green Pants",
            "imageUrl": "https://img.example.com/img/pants-g-4430.jpg",
            "scannableCodes": ["63864430654", "PANTS-G-4430"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "TNECK-GR-3277",
            "price": 34.99,
            "title": "Grey Turtleneck Sweater With Texture",
            "imageUrl": "https://img.example.com/img/tneckgr3277.jpg",
            "scannableCodes": ["32864770654", "TNECK-GR-3277"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "SANDALS-S-7318",
            "price": 69.99,
            "title": "Summer Sandals",
            "imageUrl": "https://img.example.com/img/sandalss7318.jpg",
            "scannableCodes": ["14864773654", "SANDALS-S-7318"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "BOOTS-B-8971",
            "price": 109.50,
            "title": "Beige Winter Boots",
            "imageUrl": "https://img.example.com/img/bootsb8971.jpg",
            "scannableCodes": ["89764773651", "BOOTS-B-8971"],
            "measurementUnitKey": "UNIT"
        },
        {
            "tenantArticleId": "PARKA-B-8822",
            "price": 94.50,
            "title": "Black Winter Parka",
            "imageUrl": "https://img.example.com/img/parkab8822.jpg",
            "scannableCodes": ["889722773651", "PARKA-B-8822"],
            "measurementUnitKey": "UNIT"
        }
    ]
}

A successful request returns an empty 200 OK response. The properties in the request body are detailed below:

• tenantArticleId: The unique identifier for the article within the tenant's system.

• price: The selling price of the article.

• title: The display title for the article.

• imageUrl: A URL for the article's image, which can be displayed in client applications.

• scannableCodes: A list of scannable codes for the article, such as a European Article Number (EAN) or other barcodes. These are used during the picking process.

• measurementUnitKey: The unit in which the article is measured. For example, UNIT for individual garments or a weight unit like KILOGRAMS in a food context.

With facilities and listings configured, the next step is to use the orders endpoint for testing.