Use Cases - Endpoints Explained#

Partner API/Orders (Pelican Picking) has a range of functionalities designed to ensure your order management journey is as seamless as possible. See a list of the use cases below:

Retrieve order Information on:

Single Order
Multiple Orders

Retrieve single order details#

Purpose:
If you want to check the status of an individual order using GET endpoint /order_id

How It Works:
The GET Order ID endpoint allows you to retrieve details of a specific order from our Order Transmission Service.

The Order ID must be in UUID format (e.g. 807c225f-ac6d-445d-a074-ea960c892ca7).
Refer to the order_id field in the order payload.
Only orders from the past 60 days can be accessed through this endpoint.

Note

It is likely that observed order status will be picked_up or cancelled. You can use picked_up status of reconciliations
If orderID type uuid is not available to retrieve orders, please make use of the GET vendorID endpoint (/vendors/{vendor_id}).

Request:

curl --location  --request GET 'https://foodora.partner.deliveryhero.io/v2/orders/807c225f-ac6d-445d-a074-ea960c892ca7' \
--header 'Accept: application/json' \
--header 'Authorization: ***

Response: HTTP 200 with order object

Retrieve multiple orders details#

Purpose:
If your webhook is temporarily unavailable and you need to retrieve order history from a specific store.

How It Works:
The Vendor ID endpoint allows you to specify a date range to retrieve store orders. Only orders from the last 60 days are accessible.

Allowed GET Request Parameters:

start_time – Start date & time should be in UTC (e.g., 2024-09-11T10:40:00).
end_time – End date & time should be in UTC (e.g., 2024-08-12T12:40:00, max 60-day range).
page_size – Number of orders per page (default: 20).
page – Page number of results (default: 1).

Note

VendorID refers to store identifier by default `store_id` field from payload is to be used as vendorID. If a Partner has internal store configurations, `external_partner_config_id` should be used in the endpoint as vendorID.

Request:

curl --location 'https://foodora.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/7253942?start_time=2024-09-11T10%3A40%3A00&end_time=2024-09-12T12%3A40%3A00&page_size=&page=' \
--header 'Content-Type: application/json' \
--header 'Authorization: ***' \
--data ''

Response: 200 with orders array object

Below are the Error codes observed while integrating with GET endpoints:

400 bad request is observed when the request body is not valid
401 Unauthorised is observed when token is not valid
404 Not found is observed when order is not available in our DB

API≪ How to Integrate APITesting Integration ≫