Use Cases - Endpoints Explained#

Partner API/Outlet Management has a few functionalities designed to ensure an easy process to update the store status. Check the use cases and how to configure them below:

Manage the Outlet via PUT
Check your Outlet status via GET

Manage your Outlet#

Check API Specifications

Using the PUT /status endpoint, it is easy to create or updates an availability status of the given store/outlet.

Here are the available statuses:

CLOSED_TODAY- store will be closed till the end of the day
CLOSED_UNTIL - store will be closed till the date specified in closed_until field
OPEN - open closed store if it's within opening hours according to schedule
CHECKIN- use this status to acknowledge required check in. This status works only if checking feature has been enabled for the store

Check-in Feature Overview

The "Check-in" feature allows you to acknowledge your scheduled opening time. By default, this feature is disabled and does not require a check-in status to be sent. To activate the check-in flow, please contact your account manager.

How the Check-in Feature Works? This feature enables you to confirm the upcoming opening of your shop up to 30 minutes before its scheduled opening hours. If the you fail to acknowledge, the shop will remain closed even if it is scheduled to be open. However, the shop can still be opened by calling the API with a "OPEN" status.

1. Close the Store#

The PUT endpoint is used to update the status of the store. To do this, you'll need an API token that you've already generated in the Partner Portal and use the following curl as an example:

Example of the request:

curl --location --request PUT 'https://yemeksepeti.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
  "status": "CLOSED_UNTIL",
  "closed_reason": "TECHNICAL_PROBLEM",
  "closed_until": "2024-09-30T10:00:36Z"
}

Here are the available statuses: TOO_BUSY_NO_DRIVERS TOO_BUSY_KITCHEN UPDATES_IN_MENU TECHNICAL_PROBLEM CLOSED OTHER BAD_WEATHER HOLIDAY_SPECIAL_DAY

2.Open the Store#

If you want to open the store, you the closed_reason should be omitted:

curl --location --request PUT 'https://yemeksepeti.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
  "vendor_id": "naez",
  "status": "OPEN"
}

Check your Outlet status via GET#

Check API Specifications

GET endpoint provides the status of the specific outlet.

The status can have four values:

- CLOSED_TODAY- vendor will be closed till the end of the day
- CLOSED_UNTIL - vendor will be closed till the date specified in closed_until field
- OPEN - open closed vendor if it's within opening hours according to schedule
- CHECKIN- use this status to acknowledge required check in. This status works only if checking feature has been enabled for the vendor

The example of the request :

curl --location --request GET 'https://yemeksepeti.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/status' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \

The response:

{
  "vendor_id": "naez",
  "status": "CLOSED_UNTIL",
  "closed_reason": "TECHNICAL_PROBLEM",
  "closed_until": "2024-09-30T10:00:36Z"
}

API≪ How to Integrate APITesting Integration ≫