Foodpanda
API docs by Redocly

Foodpanda Partner API (v2.0.0)

Download OpenAPI specification:

Welcome to the Partner API, your gateway to seamless integration with our platform. This API empowers your applications to connect directly with our system, allowing you to:

  • Manage your Product Catalog: Easily add and update products ensuring your offerings are always up to date.
  • Process Orders efficiently: Receive real-time order updates, confirm orders, and manage order statuses for a smooth fulfillment process.
  • Grow your business: Create and manage promotions to attract customers and boost sales.
  • Gain valuable Insights: Access order history and other data to optimize your operations and enhance customer satisfaction.

This API is designed for partners, looking to reach more customers and streamline their operations through our platform.

Getting Started

  1. Get your API keys: Contact your account manager or visit our Partner Portal to request your API keys.
  2. Explore the API Documentation: Familiarize yourself with the available endpoints and data structures in this document.
  3. Start Integrating: Use your preferred programming language and tools to integrate the Partner API into your applications.

Glossary

  • Vendor: The store, outlet or merchant listed on our platform responsible for fulfilling orders and managing their product catalog.
  • Chain: A group of stores operating under a common brand, franchise, or region. Our API allows you to manage all outlets in the chain with a single API key.
  • Job: A background process that handles time-consuming tasks, such as product assignment or catalog export.
  • Webhook: A mechanism for receiving real-time notifications about events on our platform, such as order updates or job completions.
  • SKU (Stock Keeping Unit): A unique code used to identify a specific product in your inventory.
  • GTIN (Global Trade Item Number): A globally unique identifier for a product, such as a barcode (e.g., EAN, UPC).
  • POS (Point of Sale): The system used to process transactions and manage orders at your physical store location.

Authentication

Our platform uses access_tokens to authenticate requests. You can generate access_token in the Partner Portal.

How to authenticate:

  • Include your access_token in the Authorization header of every request you make to the Partner API.
  • Prefix your access_token with the string Bearer followed by a space. For example:
Authorization: Bearer <access_token>

Catalog

Manage and optimize your product catalog with precision and efficiency. This section provides a comprehensive set of endpoints to streamline your product management workflows.

Key Features:

  • Effortless Product Management: Add new products, update existing ones, and deactivate outdated listings.
  • Bulk Operations: Perform bulk updates to efficiently manage large product catalogs.
  • Asynchronous Processing: Initiate time-consuming tasks, such as product assignments and exports, in the background to free up your resources.
  • Detailed Product Information: Access and manage a wide range of product attributes, including titles, descriptions, images, pricing, inventory, and categories.
  • Flexible Filtering and Search: Retrieve specific products or subsets of your catalog using powerful filtering and search capabilities.
  • Export Functionality: Download complete or filtered product data for analysis, reporting, or archival purposes.

Add Products

Add Products to your Catalog. This asynchronous endpoint enables multi-vendor product addition. Submit product details and initiate the process. You'll receive a job_id to track the status of your request.

This endpoint is ideal for the following use cases:

  • Onboarding new vendors: Quickly add a large number of products to a vendor's catalog.
  • Expanding product offerings: Easily introduce new products to your existing vendors.
  • Automating catalog updates: Integrate this endpoint into your systems to automatically add products from your inventory management system.
Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

Request Body schema: application/json
vendors
required
Array of strings

Set of vendor IDs. If vendors = ["*"], products will be assigned to all vendors associated with the chain

required
Array of objects (catalog.ProductAssignmentProducts)

List of products to assign

Responses

Request samples

Content type
application/json
{
  • "vendors": [
    ],
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "QUEUED"
}

Product Addition Status

Track the progress of your product listings. This endpoint allows you to monitor the status of your product addition jobs. Check if your job is QUEUED, IN_PROGRESS, COMPLETED or FAILED

  • QUEUED the job has not yet been processed
  • IN_PROGRESS the products/items are being added to your outlet.
  • COMPLETED the job is finished
  • FAILED the job processing failed
Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

job_id
required
string
Example: a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9

Job ID from the response of the POST /catalog endpoint

Responses

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "IN_PROGRESS",
  • "created_at": "2024-09-30T10:00:36.947Z",
  • "updated_at": "2024-09-30T10:05:36.947Z",
  • "result": {}
}

Retrieve Products

Access a comprehensive, paginated list of products assigned to a vendor. This endpoint allows you to efficiently retrieve and filter your product data. Use query parameters to: Search for products by name, SKU or barcode (query_term).

  • Filter by specific categories (category_global_ids).
  • Refine results by locale (locale) and active status (is_active).
  • Control the number of results per page (page_size) and navigate through pages (page).
Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

query Parameters
query_term
string
Example: query_term=Milk

The value of text search. The vendor products retrieved are assured to be their titles containing the query or match the barcode or sku. The search is based on the provided locale

locale
string
Example: locale=en_GB

The value locale of the field to be filtered

page
integer
Default: 1
Example: page=1

Page number

page_size
integer [ 1 .. 500 ]
Default: 20
Example: page_size=10

Items per page

category_global_ids
string
Example: category_global_ids=9d283d0d-af05-4640-bf41-4cac901bfca,9d283d0d-af05-4640-bf41-4cac901bfcb

Comma-separated list of category global ids. The vendor products retrieved are assured to have at least one of the categories supplied. If empty, all the vendor products are considered.

expand
boolean
Default: false
Example: expand=true

When value is true both remote_product_id and master_category_path fields are fulfilled. Otherwise these properties come in null value

is_active
boolean

Filter by active products. If this parameter is not provided all products are retrieved. Options:

  • true for only active products
  • false for only inactive products

Responses

Response samples

Content type
application/json
{
  • "page_number": 1,
  • "total_pages": 3,
  • "page_size": 92,
  • "products": [
    ]
}

Update Products

Update product information efficiently, whether it's a single item or a whole batch. We'll process your request in the background and provide a 202 Accepted status with a job_id for tracking. Stay updated via webhook notifications defined under Callbacks → Update products results webhook at the bottom of this operation or use the Product Addition Status endpoint to get the results.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

Request Body schema: application/json

Edit parameters. sku is a mandatory field and at least one of the fields price, active or quantity must be present for every product in the payload

Product activation status is determined based on the active flag, available quantity, and the sales buffer configured in Partner Portal:

active quantity vs. sales buffer Resulting Product Status
false Any Inactive
true quantity > sales buffer Active
true quantity <= sales buffer Inactive
Not provided quantity > sales buffer Active
Not provided quantity <= sales buffer Inactive
Array of objects (catalog.EditProductRequest)

array of products

Responses

Callbacks

Request samples

Content type
application/json
Example

Update all price and active

{
  • "products": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "QUEUED"
}

Callback payload samples

Callback
POST: Update products results webhook
Content type
application/json
{}

Export Product Catalog

Download a complete snapshot of your product catalog for a specific vendor. This endpoint initiates an asynchronous export job to retrieve detailed product information. Once the export is complete, the data will be sent to the webhook configured in your partner portal.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

Responses

Callbacks

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "QUEUED"
}

Callback payload samples

Callback
POST: Export products results webhook
Content type
application/json
{}

Category

Organize your products effectively with a robust category structure. This section offers endpoint to retrieve the hierarchical relationships between your product categories, enabling efficient navigation and filtering for you.

Key Features:

  • Hierarchical Structure: Established parent-child relationships between categories to create a logical and intuitive structure.
  • Leaf Category Filtering: Retrieve only the most specific categories (those without subcategories) for streamlined data retrieval.

Vendor Categories

Retrieve a list of all categories assigned to a vendor. This endpoint allows you to quickly access the category structure associated with a specific vendor.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

query Parameters
only_leaves
boolean
Default: true
Example: only_leaves=true

Boolean value indicating whether or not to include only leaf categories

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Order

Streamline your order processing and fulfillment workflows for a seamless customer experience. This section provides endpoints to access, manage, and update order information in real-time, ensuring efficient and accurate order fulfillment.

Key Features:

  • Real-time Order Updates: Receive and process order updates as they happen, enabling immediate action and reducing delays.
  • Order Status Management: Update order statuses to reflect the progress of each order, keeping customers informed and improving transparency.
  • Item Modification and Cancellation: Make changes to order items, handle replacements, and manage cancellations efficiently.
  • POS Integration: Seamlessly integrate your point-of-sale systems with our platform for automated order updates and streamlined operations.
  • Order History and Reconciliation: Retrieve detailed order history for reconciliation, analysis, and reporting purposes.

Order Notification Webhook

Prerequisites

Set Up a Webhook to receive Order Events:

  • Step 1: Develop a webhook to receive live order events.
  • Step 2: Ensure the webhook is ready to receive updates for any modifications during the order lifecycle (e.g., status changes, cancellations) and share the endpoint with platform/update in partner portal etc.

Webhook notification

You will receive a POST request webhook notifications regarding newly placed orders or order status changes. Depending on the integration type, next options are available:

Partner Picking Device

  • RECEIVED - The initial status of the order. This status means that the order processing has not yet started by the partner.
  • READY_FOR_PICKUP - Order picking and packing is finished by the partner and is ready for pickup by a delivery rider.
  • DISPATCHED - Order has been dispatched.
  • CANCELED - Order is canceled by the customer, delivery rider or the partner.
  • DELIVERED - Order is delivered to the customer.

Pelican Picking Device

  • READY_FOR_PICKUP - Order picking and packing is finished by the partner and is ready for pickup by a delivery rider.
  • CANCELED - Order is canceled by the customer, delivery rider or the partner.
  • DELIVERED - Order is delivered to the customer.

Please note: to enhance API call security, a static token for webhook notifications can be added through the Vendor Portal.

Authorizations:
ApiKeyAuth
Request Body schema: application/json

Order details

accepted_for
string <dateTime>

Time stamp in UTC which indicates the estimated delivery time

promised_for
string <dateTime>

Time stamp in UTC which indicates the promised delivery time

comment
string

Comment related to the order

external_order_id
string

Order id generated by Foodpanda Platform

isPreorder
boolean

Indicator if the order is a pre-order

order_code
string

A shortened order number used by riders to identify orders while picking them up from partners. Partners are required to refer to this code while handing over orders to riders for delivery.

order_id
string

Order id in UUID format. For eg, 9d4a63b5-3e07-4440-96af-aa04797da3a0

order_type
string
Enum: "DELIVERY" "PICKUP"

This field defines order delivery type. DELIVERY or PICKUP are the possible values

object

Order cancellation information / if there is cancellation

object

Client/Store/Vendor information

object

Object containing personal details of the customer. All the details inside are masked to protect customer identity

Array of objects (order.OrderItem)

Array containing order item details

object

Payment information of the order

status
string
Enum: "RECEIVED" "READY_FOR_PICKUP" "DISPATCHED" "CANCELLED" "DELIVERED"

Depending on the integration type, next options are available:

Partner Picking Device

  • RECEIVED - The initial status of the order. This status means that the order processing has not yet started by the partner.
  • READY_FOR_PICKUP - Order picking and packing is finished by the partner and is ready for pickup by a delivery rider.
  • DISPATCHED - Order has been dispatched.
  • CANCELED - Order is canceled by the customer, delivery rider or the partner.
  • DELIVERED - Order is delivered to the customer.

Pelican Picking Device

  • READY_FOR_PICKUP - Order picking and packing is finished by the partner and is ready for pickup by a delivery rider.
  • CANCELED - Order is canceled by the customer, delivery rider or the partner.
  • DELIVERED - Order is delivered to the customer.
object

Internal system fields

transport_type
string
Enum: "VENDOR_DELIVERY" "LOGISTICS_DELIVERY"

This field defines transport type for the order. Available values are:

  • VENDOR_DELIVERY - Partner is responsible for delivering the order to the customer
  • LOGISTICS_DELIVERY - Foodpanda rider is responsible for delivering the order to the customer

Responses

Request samples

Content type
application/json
{
  • "accepted_for": "2022-02-07T16:03:06Z",
  • "promised_for": "2022-02-07T17:03:06Z",
  • "comment": "My first order",
  • "external_order_id": "order-78107",
  • "isPreorder": false,
  • "order_code": "wxfr-2440-rtbs",
  • "order_id": "9d4a63b5-3e07-4440-96af-aa04797da3a0",
  • "order_type": "DELIVERY",
  • "cancellation": {
    },
  • "client": {
    },
  • "customer": {
    },
  • "items": [
    ],
  • "payment": {
    },
  • "status": "RECEIVED",
  • "sys": {
    },
  • "transport_type": "LOGISTICS_DELIVERY"
}

Order Details

Retrieve comprehensive information for a specific order. This endpoint provides detailed information about an order, including:

  • Order status and fulfillment details
  • Customer information (masked for privacy)
  • Items ordered and their pricing
  • Payment information
  • Delivery details
Authorizations:
ApiKeyAuth
path Parameters
order_id
required
string
Example: 9d4a63b5-3e07-4440-96af-aa04797da3a0

Order id

Responses

Response samples

Content type
application/json
{
  • "accepted_for": "2022-02-07T16:03:06Z",
  • "promised_for": "2022-02-07T17:03:06Z",
  • "comment": "My first order",
  • "external_order_id": "order-78107",
  • "isPreorder": false,
  • "order_code": "wxfr-2440-rtbs",
  • "order_id": "9d4a63b5-3e07-4440-96af-aa04797da3a0",
  • "order_type": "DELIVERY",
  • "cancellation": {
    },
  • "client": {
    },
  • "customer": {
    },
  • "items": [
    ],
  • "payment": {
    },
  • "status": "RECEIVED",
  • "sys": {
    },
  • "transport_type": "LOGISTICS_DELIVERY"
}

Update Order

Update order information for seamless order management. This endpoint is crucial for integrating your 3rd party POS or Order Mnagement System with our platform. Use it to update order statuses, modify items, and manage cancellations. This real-time interaction ensures accurate order data and efficient fulfillment.

Authorizations:
ApiKeyAuth
path Parameters
order_id
required
string
Example: 9d4a63b5-3e07-4440-96af-aa04797da3a0

Order Id

Request Body schema: application/json

Order Info

object
required
Array of objects (order.OrderItemToUpdate)

Internal Store ID / Vendor ID defined under Q-Commerce by Catalog Either item.id or item.sku is required. If both are passed then item.id takes precedence over item.sku

order_id
required
string

Order id in UUID format

status
required
string
Enum: "CANCELLED" "DISPATCHED" "READY_FOR_PICKUP" "UPDATE_CART"

This field defines order status. Some rules must be followed providing correct status:

  • If the order cannot be fulfilled, it can be cancelled
  • If the status is being updated as CANCELLED, an appropriate cancellation reason needs to be also entered
  • For VENDOR_DELIVERY transport_type
    • Accepted values are CANCELLED or DISPATCHED
    • Once the order is picked and dispatched for delivery, update the status as DISPATCHED
    • Orders cannot be CANCELLED after the status is set to DISPATCHED and vice versa
  • For LOGISTICS_DELIVERY transport_type
    • Accepted values are CANCELLED or READY_FOR_PICKUP
    • Once the order is picked and ready for pickup, update the status as READY_FOR_PICKUP
    • Orders cannot be CANCELLED after the status is set to “READY_FOR_PICKUP” and vice versa
  • UPDATE_CART status is used for item modifications. In contrast to other statuses, the Partner can call API with UPDATE_CART as many times as needed to ensure the order contains the correct set of items

Responses

Request samples

Content type
application/json
{
  • "cancellation": {
    },
  • "items": [
    ],
  • "order_id": "9d4a63b5-3e07-4440-96af-aa04797da3a0",
  • "status": "CANCELLED"
}

Response samples

Content type
application/json
{
  • "accepted_for": "2022-02-07T16:03:06Z",
  • "promised_for": "2022-02-07T17:03:06Z",
  • "comment": "My first order",
  • "external_order_id": "order-78107",
  • "isPreorder": false,
  • "order_code": "wxfr-2440-rtbs",
  • "order_id": "9d4a63b5-3e07-4440-96af-aa04797da3a0",
  • "order_type": "DELIVERY",
  • "cancellation": {
    },
  • "client": {
    },
  • "customer": {
    },
  • "items": [
    ],
  • "payment": {
    },
  • "status": "RECEIVED",
  • "sys": {
    },
  • "transport_type": "LOGISTICS_DELIVERY"
}

Vendor Orders

Retrieve a paginated history of orders for a specific vendor. This endpoint is ideal for reconciliation and analysis, providing detailed order information stored on our platform. Filter orders by a date range using the start and end parameters. You can also control pagination with page_size and page.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

query Parameters
start_created_at_datetime
string <dateTime>
Deprecated
Default: "today at 00:00 time"
Example: start_created_at_datetime=2023-01-01T15:00:00

Deprecated, use start_time parameter instead Start CreatedAt datetime (ISO 8601). Maximum 60 days in the past.

end_created_at_datetime
string <dateTime>
Deprecated
Default: "Today at now time"
Example: end_created_at_datetime=2023-01-01T16:00:00

Deprecated, use end_time parameter instead End CreatedAt datetime (ISO 8601)

start_time
string <dateTime>
Default: "today at 00:00 time"
Example: start_time=2023-01-01T15:00:00

Start CreatedAt datetime (ISO 8601). Maximum 60 days in the past

end_time
string <dateTime>
Default: "Today at now time"
Example: end_time=2023-01-01T16:00:00

End CreatedAt datetime (ISO 8601)

page_size
integer [ 1 .. 500 ]
Default: 20
Example: page_size=10

Items per page

page
integer
Default: 1
Example: page=1

Page number

Responses

Response samples

Content type
application/json
{
  • "orders": [
    ],
  • "page_number": 2,
  • "page_size": 20,
  • "total_pages": 15
}

Promotion

Drive sales and boost customer engagement with targeted promotions. This section provides endpoints for creating and managing a variety of promotional campaigns to incentivize purchases and enhance customer loyalty.

Key Features:

  • Flexible Promotion Types: Implement various promotion types, including discounts, bundles, and special offers.
  • Promotion Scheduling: Schedule promotions to run for specific durations.
  • Easy Updates and Deactivation: Modify existing promotions, add or remove products, or deactivate campaigns as needed.
  • Asynchronous Processing: Create or update promotions in the background for efficient processing and resource management.
  • Status Tracking: Monitor the status and outcome of your promotion updates to ensure they are applied correctly.

Manage Promotion

Create or update promotions to boost your sales and engage customers. This endpoint simplifies promotion management with its upsert functionality:

  • Create new promotions: Define the promotion details, including the type, discounts, conditions, and target audience.
  • Update existing promotions: Modify any aspect of your promotion, add or remove products, or deactivate it entirely.

The API intelligently determines whether to create a new promotion or update an existing one based on the unique combination of name, vendors, condition.start_time, and condition.end_time.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

Request Body schema: application/json

Updating promotion

reason
string
Default: "COMPETITIVENESS"
Enum: "OVERSTOCK" "DELISTING" "COMPETITIVENESS" "EXPIRING_SOON" "NMR" "TRADING"

Reason why the promotion is being run. Not displayed on platforms and is used for reporting purposes only. Supported options:

  • OVERSTOCK - Excess inventory to clear
  • DELISTING - SKUs to clear if no longer selling this SKU in the future
  • COMPETITIVENESS - Standard, regular promotions to make sure we offer good value and are competitive vs. competition
  • EXPIRING_SOON - Expiring stock to sell quickly
  • NMR - Suppliers paying for banners to gain visibility for their products (with or without discount)
  • TRADING - promotions to drive traffic/volume and achieve sales targets (more tactical, eg flash sales, basket discounts)
active
boolean
Default: true

Set as false to deactivate the promotion

vendors
required
Array of strings

Set of vendor IDs relevant to the promotion. If vendors = ["*"] promotion will be applied to all vendors associated with the chain

type
required
string
Value: "STRIKETHROUGH"

Promotion type. Currently, only strikethrough is supported

object (promotion.DisplayName)

The name of the promotion. This will be shown to customers (in the cart page). For example: Buy 1 Get 1 Free, Buy 2 get 50% off 2nd

  • Keys are in the format of ISO 639-1 language code and ISO 3166-1 country codes separated by _ (e.g., 'en_SG')
  • Values are the corresponding names
required
object (promotion.Condition)

Flexible setup of the conditions

required
Array of objects (promotion.Discount) <= 20000 items

Setup of the discounted products

object (promotion.Limits)

Set of available limitations on promotion or order level

Responses

Request samples

Content type
application/json

Simple strikethrough: -10% for 2 SKUs

{
  • "vendors": [
    ],
  • "type": "STRIKETHROUGH",
  • "active": true,
  • "reason": "COMPETITIVENESS",
  • "display_name": {
    },
  • "conditions": {
    },
  • "discount": [
    ]
}

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "QUEUED"
}

Promotion Status

This endpoint provides the status of the promotion update job:

  • QUEUED if the job has not yet been processed.
  • COMPLETED the job has finished processing. Note that this does not necessarily mean the promotion was created. For example, if all SKUs were invalid, the promotion may not have been created. However, if all inputs were valid, the promotion should be successfully created.
  • FAILED the job processing failed.

result provides additional details about the job processing, such as any SKUs or vendors that will not be included in the promotion due to an error once the processing is complete.

Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

job_id
required
string
Example: a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9

Job ID from the response of the PUT /promotion endpoint

Responses

Response samples

Content type
application/json
{
  • "job_id": "a946a2c7-f4e7-46ac-ae63-8a5497cb0ad9",
  • "job_status": "QUEUED",
  • "created_at": "2024-09-30T10:00:36Z",
  • "updated_at": "2024-09-30T10:05:36Z",
  • "result": {
    }
}

Outlet Management

Control your outlet's operational status and schedule with ease, ensuring accurate availability information for customers. This section offers endpoints to manage opening hours, closures, and check-ins, providing real-time updates and flexible control over your outlet's operations.

Key Features:

  • Real-time Status Updates: Instantly update and retrieve your outlet's status (open/closed) and schedule changes, reflecting current availability.
  • Flexible Control: Manage opening hours, temporary closures (busy mode), and required check-ins before opening the outlet for customers, adapting to operational needs.

Outlet Status

Gets availability status of the given vendor. The following statuses:

  • CLOSED_TODAY - the vendor was closed and will stay not operational for entire day
  • CLOSED_UNTIL - the vendor was closed till specific date-time. Specific closure time is specified in closed_until field
  • CLOSED - the vendor was closed without end date
  • OPEN - the vendor is operational
Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

Responses

Response samples

Content type
application/json
{
  • "vendor_id": "naez",
  • "status": "CLOSED_UNTIL",
  • "closed_reason": "TECHNICAL_PROBLEM",
  • "closed_until": "2024-09-30T10:00:36Z",
  • "checkin_interval": {
    }
}

Manage Outlet

Updates an availability status of the given vendor. Supported statuses are:

  • CLOSED_TODAY - the vendor was closed and will stay not operational for entire day
  • CLOSED_UNTIL - the vendor was closed till specific date-time. Specific closure time is specified in closed_until field
  • OPEN - the vendor is operational
Authorizations:
ApiKeyAuth
path Parameters
chain_id
required
string
Example: 550e8400-e29b-41d4-a716-446655440000

Unique chain identifier

vendor_id
required
string
Example: naez

Unique vendor identifier generated by our platform

Request Body schema: application/json

Updating availability status

status
required
string
Enum: "CLOSED_TODAY" "CLOSED_UNTIL" "OPEN" "CHECKIN"

Supported statuses are:

  • 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 withing 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
closed_reason
string
Enum: "TOO_BUSY_NO_DRIVERS" "TOO_BUSY_KITCHEN" "UPDATES_IN_MENU" "UNREACHABLE" "TECHNICAL_PROBLEM" "CLOSED" "OTHER" "TOO_MANY_REJECTED_ORDERS" "ORDER_FAILURE" "COURIER_DELAYED_AT_PICKUP" "RESTRICTED_VISIBILITY" "BAD_WEATHER" "HOLIDAY_SPECIAL_DAY" "ONBOARDING" "READY_TO_GO_ONLINE" "OFFBOARDING" "RETENTION" "COMPLIANCE_ISSUES" "OWNERSHIP_CHANGE" "REFURBISHMENT" "FOOD_HYGIENE" "FRAUD" "RELIGIOUS_OBSERVANCE" "CHECK_IN_REQUIRED" "CHECK_IN_FAILED" "AREA_DISRUPTION"

The reason why the vendor had been closed. Will be omitted if the vendor status is OPEN

closed_until
string <dateTime>
Default: ""

Date and time till the vendor will stay closed in UTC (ISO 8601 format, UTC timezone). Filed will be omitted for all statuses, except CLOSED_UNTIL

Responses

Request samples

Content type
application/json
{
  • "status": "CLOSED_UNTIL",
  • "closed_reason": "TECHNICAL_PROBLEM",
  • "closed_until": "2024-09-30T10:00:36Z"
}

Response samples

Content type
application/json
{
  • "vendor_id": "naez",
  • "status": "CLOSED_UNTIL",
  • "closed_reason": "TECHNICAL_PROBLEM",
  • "closed_until": "2024-09-30T10:00:36Z",
  • "checkin_interval": {
    }
}