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.

Environments

Production

Test

https://pos-integration-service.development.dev.woltapi.com

On this page

Summary Authentication Venue Venue 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

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

The Venue object

Properties

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 object example

{
  "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"
  ]
}

Get venue status

This operation requires Bearer authentication.

Retrieve venue status by ID.

Returns various key status metrics for a venue, such as offline status, delivery radius and integration status.

The metrics also include 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.

Parameters

venueIdstring

Required. Unique identifier for the venue.

Responses

GET /venues/{venueId}/status

curl https://pos-integration-service.development.dev.woltapi.com/venues/{venueId}/status \
  -H "Authorization: Bearer {{access_token}}"

Response

HTTP/1.1 200 OK

{
  "status": {
    "is_open": true,
    "is_online": true,
    "is_ipad_free": true
  },
  "contact_details": {
    "address": "string",
    "phone": "string"
  },
  "opening_times": [
    {
      "opening_day": "MONDAY",
      "opening_time": "string",
      "closing_day": "MONDAY",
      "closing_time": "string"
    }
  ],
  "special_times": [
    {
      "opening_date": "MONDAY",
      "opening_time": "string",
      "closing_date": "MONDAY",
      "closing_time": "string"
    }
  ],
  "delivery_area": [
    {
      "lat": 0,
      "lng": 0
    }
  ],
  "last_three_orders_status": [
    "RECEIVED"
  ]
}

Retrieve current delivery provider

This operation requires Bearer authentication.

Returns the currently defined delivery provider for a venue on the Wolt marketplace.

The returned value can be one of the following:

WOLT - venue delivers orders using Wolt's courier fleet.
SELF_DELIVERY - venue delivers orders using its own couriers.

Parameters

venueIdstring

Required. Unique identifier for the venue.

Responses

GET /venues/{venueId}/delivery-provider

curl https://pos-integration-service.development.dev.woltapi.com/venues/{venueId}/delivery-provider \
  -H "Authorization: Bearer {{access_token}}"

Response

HTTP/1.1 200 OK

{
  "delivery_provider": "WOLT"
}

Change delivery provider

This operation requires Bearer authentication.

Changes the currently defined delivery provider for a venue on the Wolt marketplace.

Can be performed successfully only if the venue has hybrid delivery functionality enabled.

Important to note - any existing purchases will not be impacted by this change. The delivery provider for a purchase is set and finalized when an order is created by the user.

Parameters

venueIdstring

Required. Unique identifier for the venue.

Properties

delivery_providerstringenum: WOLT, SELF_DELIVERY

Required. New delivery provider that should be used by the venue

Responses

PATCH /venues/{venueId}/delivery-provider

curl -X PATCH https://pos-integration-service.development.dev.woltapi.com/venues/{venueId}/delivery-provider \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer {{access_token}}" \
  -d '{"delivery_provider":"WOLT"}'

Response

HTTP/1.1 204 No Content

Update venue online status

This operation requires Bearer authentication.

Update venue's online status

To schedule the venue to be offline until a certain time, set status=OFFLINE and until to the desired date and time. Otherwise, the venue will be put offline indefinitely.

Scheduling for online status is not supported yet.

Parameters

venueIdstring

Required. Unique identifier for the venue.

Properties

statusstringenum: ONLINE, OFFLINE

Required. The new store status to use.

untilstringnullable

The date and time (ISO 8601 format) when the venue is to be set offline.

Use null or omit the field completely to set venue offline indefinitely.

Responses

PATCH /venues/{venueId}/online

curl -X PATCH https://pos-integration-service.development.dev.woltapi.com/venues/{venueId}/online \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer {{access_token}}" \
  -d '{"status":"ONLINE","until":"2025-03-07T11:10:16.616Z"}'

Response

HTTP/1.1 204 No Content

Update venue opening times

This operation requires Bearer authentication.

Update venue's opening times.

Parameters

venueIdstring

Required. Unique identifier for the venue.

Properties

availability[object]

Venue's operating hours.

Responses

PATCH /venues/{venueId}/opening-times

curl -X PATCH https://pos-integration-service.development.dev.woltapi.com/venues/{venueId}/opening-times \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer {{access_token}}" \
  -d '{"availability":[{"opening_day":"TUESDAY","opening_time":"10:30","closing_day":"TUESDAY","closing_time":"17:30"},{"opening_day":"WEDNESDAY","opening_time":"00:00","closing_day":"WEDNESDAY","closing_time":"24:00"},{"opening_day":"SATURDAY","opening_time":"10:15","closing_day":"SATURDAY","closing_time":"17:45"}]}'

Response

HTTP/1.1 202 Accepted