Venue API

Venue API allows integrated partners to retrieve various key metrics for their venues, such as offline status, delivery radius and integration status.

This enables our partners to check status of the latest 3 orders - if the latest 3 orders are rejected, you can view it as a red flag and take remedial action.

On this page

Summary Authentication Venue status Venue status object

Authentication

Bearer authentication

The JWT token is used for authentication and is obtained as part of the OAuth 2.0 flow. For detailed implementation guidance, refer to the documentation.

You can get credentials by contacting your Wolt account manager or technical account manager.

Venue status

Venue object describes various key status metrics of a venue, such as offline status, delivery radius and integration status.

Endpoints

get/venues/{venueId}/status get/venues/{venueId}/delivery-provider patch/venues/{venueId}/delivery-provider patch/venues/{venueId}/online patch/venues/{venueId}/opening-times put/venues/{venueId}/special-opening-times

The Venue status object

Properties

external_venue_idstringnullable

The external identifier for the venue provided by the merchant.

statusobject

contact_detailsobject

Contact details for the venue.

opening_times[object]

Opening hours of the venue.

special_times[object]

Special hours of the venue.

delivery_area[object]

Delivery polygon coordinates of the venue.

last_three_orders_status[string]

Status of the last three orders of the venue.

Venue status object example

{
  "external_venue_id": "STORE-123",
  "status": {
    "is_open": true,
    "is_online": true,
    "is_ipad_free": true
  },
  "contact_details": {
    "address": "Iso Roobertinkatu 29",
    "phone": "+3580406658664"
  },
  "opening_times": [
    {
      "opening_day": "MONDAY",
      "opening_time": "00:00",
      "closing_day": "SUNDAY",
      "closing_time": "24:00"
    }
  ],
  "special_times": [],
  "delivery_area": [
    {
      "lat": 60.17734425244339,
      "lng": 24.917020270161032
    },
    {
      "lat": 60.18264159449447,
      "lng": 24.946073088071387
    },
    {
      "lat": 60.18649367021024,
      "lng": 24.954304719812797
    },
    {
      "lat": 60.179993030281196,
      "lng": 24.97730486732482
    },
    {
      "lat": 60.171082655559786,
      "lng": 24.982873324091287
    },
    {
      "lat": 60.159158238649525,
      "lng": 24.973915371901455
    },
    {
      "lat": 60.15349563690458,
      "lng": 24.932272999563537
    },
    {
      "lat": 60.15807398616596,
      "lng": 24.91556762926527
    },
    {
      "lat": 60.17264816668299,
      "lng": 24.911451813394592
    },
    {
      "lat": 60.17734425244339,
      "lng": 24.917020270161032
    }
  ],
  "venue_config": {
    "order_api_enabled": true,
    "menu_api_enabled": true,
    "prep_time_duration": 600,
    "pre_order_prep_time_duration": 600,
    "max_acceptance_prep_time_duration": null,
    "rate_limit_settings": {
      "itemsUpdate": {
        "refresh_rate_in_minutes": 1,
        "limit": 120
      },
      "getMenu": {
        "refresh_rate_in_minutes": 1,
        "limit": 999
      }
    }
  },
  "last_three_orders_status": [
    "PRODUCTION",
    "REJECTED",
    "REJECTED"
  ]
}