Order submitter

Order submitter is an integration product from Wolt which is designed to help partners reduce time they spend managing orders they receive through Wolt.

On this page

Summary Order Order object

Order

Order object describes an order on Wolt.

The Order object

Properties

idstring

Unique identifier for the order.

venueobject

Details of the venue where the order was placed.

priceobject

Total price of the order.

deliveryobject

The delivery method of the order.

items[object]

Items included in the order.

created_atstring

The date and time (ISO 8601 format) when the order was received by Wolt's system.

consumer_commentstringnullable

Comment added to the order by consumer.

When making an order using Wolt app, a consumer can leave a message to the restaurant. For example to inform the kitchen about dietary restrictions.

pickup_etastring

The date and time (ISO 8601 format) when the courier is expected to pick up the order.

attribution_idstring

Unique identifier for the attribution.

This is used to track consumer "source" if the consumer is coming to Wolt from a merchant's website or app. Merchants can create a unique attribution IDs for a campaign or source and pass it to Wolt. This ID is carried through the order flow and reflected in the order.

typestringenum: preorder, instant

An order can be of two different types.

instant: When an order is to be fulfilled instantly.
preorder: When a consumer schedules an order.

pre_orderobjectnullable

Pre-order details for the order.

consumer_namestring

Name of the consumer who made the order.

If a self-delivery venue has full name setting enabled they will receive the full name of the consumer, otherwise the name will include only first name and first letter of last name.

consumer_phone_numberstringnullable

Phone number of the consumer who made the order.

Consumer phone number is not shared unless absolutely necessary. This is toggled on only for select markets where the phone number is available on the Wolt Merchant app or for self-delivery venues. The field is null in all other cases.

order_numberstring

A human readable order number that is unique only for open orders. Order numbers can repeat and are not unique for a venue.

order_statusstringenum: received, fetched, acknowledged, production, ready, delivered, rejected, other

Status of the order. An order progresses through a life cycle that consists of different states:

received: The order was fetched by the Wolt Merchant app and/or acknowledged by venue staff on the app.
fetched: The order was fetched in the Wolt Merchant app.
acknowledged: The order was interacted by venue staff on the Wolt Merchant app.
production: Preparation of the order has started.
ready: The order has been prepared and is awaiting delivery.
delivered: The order has been delivered to the consumer.
rejected: The venue or Wolt's system rejected the order.
refunded: Wolt has processed a refund for the order.

modified_atstring

The date and time (ISO 8601 format) when the order was last modified.

Orders move through a life cycle and can change the order status. This change is also considered a modification, so the date and time could be the time when a purchase changed its status from acknowledged to production.

company_tax_idstringnullable

Unique identifier for company tax.

In some markets, consumers are allowed to bill their company for the purchase. In these situations they input the company's tax ID and this information is passed on for accounting purposes.

Order object example

{
  "id": "62db996d7706bd423bb10db6",
  "venue": {
    "id": "602fb85a64983ea30328f131",
    "name": "Burger Venue"
  },
  "price": {
    "amount": 24200,
    "currency": "EUR"
  },
  "delivery:": {
    "status": "delivered",
    "type": "homedelivery",
    "time": "2021-06-14T12:07:19.812Z",
    "fee": {
      "amount": 1000,
      "currency": "EUR"
    },
    "location": {
      "street_address": "Mannerheimintie 1",
      "apartment": "C 2",
      "city": "Helsinki",
      "country": "Finland",
      "coordinates": {
        "lon": 53.390234,
        "lat": -7.782839
      },
      "formatted_address": "Mannerheimintie 1 C 2, 00100, Helsinki\nDrive past the big rock to see the entrance.\nLeave parcel to entrance.\nDoor code: 1234\n"
    },
    "small_order_surcharge": null
  },
  "items": [
    {
      "id": "602fb890e765db64dc152203",
      "item_type": "order-item",
      "count": 1,
      "pos_id": "1623629",
      "options": [
        {
          "id": "602fb890e765db64dc152196",
          "name": "In the burger",
          "value": "Cheese",
          "price": {
            "amount": 1000,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623576"
        },
        {
          "id": "602fb890e765db64dc1521ca",
          "name": "Side",
          "value": "Fries",
          "price": {
            "amount": 0,
            "currency": "EUR"
          },
          "pos_id": "1623560",
          "count": 1,
          "value_pos_id": "1623560"
        },
        {
          "id": "602fb890e765db64dc15219e",
          "name": "Dips",
          "value": "Bearnaise",
          "price": {
            "amount": 200,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623555"
        },
        {
          "id": "602fb890e765db64dc15219c",
          "name": "Dips",
          "value": "Chipotle Mayo",
          "price": {
            "amount": 0,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623553"
        },
        {
          "id": "602fb890e765db64dc1521af",
          "name": "Extras sides",
          "value": "Real Nuggets (4 stk)",
          "price": {
            "amount": 5000,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623634"
        },
        {
          "id": "602fb890e765db64dc1521b0",
          "name": "Extras sides",
          "value": "Spicy Hotdog",
          "price": {
            "amount": 4000,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623635"
        },
        {
          "id": "602fb890e765db64dc1521a9",
          "name": "Sodas",
          "value": "Lemon Soda 0,33 l",
          "price": {
            "amount": 0,
            "currency": "EUR"
          },
          "pos_id": null,
          "count": 1,
          "value_pos_id": "1623532"
        }
      ],
      "total_price": {
        "amount": 24200,
        "currency": "EUR"
      },
      "base_price": {
        "amount": 14000,
        "currency": "EUR"
      },
      "unit_price": {
        "amount": 24200,
        "currency": "EUR"
      },
      "name": "Fried Chicken Burger Combo",
      "category": {
        "id": "5bf00d226feade000a37266e",
        "name": "Combos"
      },
      "is_bundle_offer": false
    }
  ],
  "created_at": "2021-05-05T10:19:38.856Z",
  "consumer_comment": "Don't forget the ketchup please!",
  "pickup_eta": "2021-05-05T10:25:09.636Z",
  "attribution_id": "123456789",
  "type": "instant",
  "pre_order": {
    "preorder_time": "2021-05-05T10:22:16.631Z",
    "pre_order_status": "confirmed"
  },
  "consumer_name": "Frank L",
  "consumer_phone_number": "+35850111222333",
  "order_number": "485",
  "order_status": "delivered",
  "modified_at": "2021-05-05T10:22:16.631Z",
  "company_tax_id": "TXN 123 999",
  "loyalty_card_number": "loyalty-card-number"
}