Configuring stock 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, Facilities in your free trial, and Listings 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's stock?

Stock is the total amount of goods or the amount of a particular type of goods available in a store or warehouse.

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 let the system know how many products (listings) we have to sell in our shop (facility).

Let's add a stock to the listings we created for our facility.

Add stock to listing

1

Open the stocks endpoint

In Postman, find the POST Create Stock endpoint and click to open. You'll see the body is prefilled with some data. For example:

{
    "facility": {
        "facilityRef": "{YOUR_FACILITY_ID}" // the ID of the facility you created
    },
    "tenantArticleId": "{YOUR_TENANT_ARTICLE_ID}", // the ID of the listing you created
    "value": 42, // the amount of stock on hand
    "traitConfig": 
    [
        {
        "trait": "ACCESSIBLE", // setting this allows the stock to be considered for incoming orders
        "enabled": true
        }, 
        {
        "trait": "PICKABLE", // setting this allows the stock to be picked for incoming orders
        "enabled": true
        }
    ]
}

We're only using the required fields in this example, and not all the available option. See our stocks article for more details and the API specification.

2

Get the facility ID

Copy the id that was created from our Facilities in your free trial article and paste into the request body where it says YOUR_FACILITY_ID

3

Get the article ID

Copy the tenantArticleId from one of the listings we created in Listings in your free trial and paste into the request body where it says YOUR_TENANT_ARTICLE_ID

4

Edit data

You can edit the body in any other 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 201 Created response. You'll notice some extra fields that are part of the response and have been automatically created.

The stock 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 orders. What they are, how to set them up, and how to edit them.