Orders 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, Listings in your free trial, and Configuring stock 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 an order?

An order is the entry point for the fulfillment process. The platform consumes the following information from an order object:

• The consumer's location

• The time the order was placed

• The line items of the order, including:

  • Article (title and tenantArticleId)

  • quantity

This is the minimum information the platform needs for order fulfillment. However, more information can be provided. For example, an order line item can contain a list of scannable codes that must be scanned when the item is picked in a facility. Furthermore, it's recommended to configure the deliveryPreferences for the order.

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, and then pick up that order from our shop. For that, we need to let the system know that an order has taken place on our online shop.

Let's add an order to our facility.

Placing an order

1

Open the orders endpoint

In Postman, find the POST Add new order endpoint (under Order routing, then Orders). You'll see the body is prefilled with some data. For our example, we'll replace all the prefilled data with our own.

{
    "orderDate": "2025-12-11T08:16:07.000Z",
    "status": "OPEN",
    "consumer": {
        "addresses": [
            {
                "firstName": "Phil",
                "lastName": "Bison",
                "street": "4th Street",
                "houseNumber": "1000",
                "postalCode": "90403",
                "city": "Los Angeles",
                "country": "US",
                "phoneNumbers": [
                    {
                        "value": "0177-555-6273",
                        "label": "private",
                        "type": "MOBILE"
                    }
                ],
                "email": "[email protected]"
            }
        ]
    },
    "orderLineItems": [
        {
            "article": {
                "tenantArticleId": "TSHIRT-W-2468",
                "title": "Basic T-Shirt White"
            },
            "quantity": 1
        },
        {
             "article": {
                "tenantArticleId": "SNEAK-W-4891",
                "title": "White Sneakers"
            },
            "quantity": 1
        }        
    ],
    "deliveryPreferences": {
        "collect": [
            {
            "facilityRef": "INSERT-YOUR-FACILITYID",
            "paid": true
            }
        ]
    },
      "tenantOrderId": "R456728546"
}

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

2

Edit data

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

3

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.

Although you can create orders manually, we recommend implementing a solution that receives incoming orders from shop systems. See our orders integration article for more information.

The order will also be visible in Backoffice for other team members to use. We'll take you through using Backoffice in the next article.