Use Cases - Endpoints Explained#

Partner API/Catalog has a range of functionalities designed to ensure your catalog management journey is as seamless as possible. See a list of the use cases below:

• Update single or bulk products via PUT
• Retrieve a list of available products via GET
• Find out your product categories via GET
• Export snapshot of your assortment via POST
• Expand your assortment (add products) via POST
• Review the status of job via GET

Update single or bulk products#

Check API Specifications

PUT /catalog endpoint, you can update the product's attributes such as price and availability. sku, barcode, quantity, price, active & maximum_sales_quantity.

Endpoint can be utilised in two ways

1. Single product updates (OR)
2. Bulk product updates. If a partner configures a webhook (recommended).

• It’s an async process and status of SKU updates are sent to webhook
• It is possible to update entire assortment per store using the endpoint

Single product update#

Request :

curl --location --globoff --request PUT 'https://foodpanda.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "products": [
    {
      "sku": "LS-33",
      "active": false,
      "price": 10
    }  ]
}'

Response: 200 you can find the response structure here

{
      "sku": "3671"
}

Bulk product updates#

Request:

curl --location --globoff --request PUT 'https://foodpanda.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data '{
  "products": [
    {
      "sku": "LS-33",
      "active": false,
      "price": 10
    },
    {
      "sku": "LS-22",
      "active": true
    },
    {
      "sku": "LS-24",
      "price": 369
    } ]
}'

Response: 202 async job is created in our catalog & you can find the response structure here

{
"job_id": "a946a2c7-f4e7-46ac-ae63-8a59",
"job_status": "QUEUED"
}

Retrieve a list of available products#

Check API Specifications

GET /catalog endpoint, you can retrieve the listed products information such as title, images, status, price and category for each store in a paginated format. You can use this feature to search through your product selection.

Endpoint can accommodate below query parameters:

• query_term, search for products by name or SKU
• category_global_ids, filter by specific categories
• locale,refine results by locale e.g en_GB
• is_active, filter by active products. If this parameter is not provided all products are retrieved.
• page_size,control the number of results per page
• page, navigate through pages

Request:

curl --location --requets GET 'https://foodpanda.partners.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog?query_term=milk&locale=en_GB&page=10&page_size=10' \
--header 'Authorization: Bearer test'

Response: 200 you can find the response sample here

Find out your product categories#

Check API Specifications

Using GET /categories endpoint, you can retrieve the listed categories for each store. This endpoint allows you to quickly access the category structure associated with a specific vendor.

Request:

curl --location --request GET 'https://foodpanda.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/categories' \
--header 'Authorization: Bearer test'

Response: 200 you can find response details here

Export snapshot of your assortment#

Check API Specifications

Using the POST /export endpoint, you can download and verify the entire assortment data of the store. 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.

Request:

curl --location --globoff --request POST 'https://foodpanda.partner.deliveryhero.io/v2/chains/{chain_id}/vendors/{vendor_id}/catalog/export'

Response: 200 you find more details on response structure here

Expand your assortment#

Check API Specifications (Add Products)

Using the POST /catalog endpoint, you can create new Products in our Catalog. You can create products multi-vendor

Request flow is as follows:

• Submit POST request with body containing product detail
• Receive a job_id
• Track the status of job

This endpoint is ideal for

• Onboarding new vendors
• Expanding product offerings
• Automating catalog updates

GET Product Addition Status#

Check API Specifications

By using this GET endpoint, you will be able to track the progress of your product creation from the POST /catalog endpoint. This endpoint allows you to monitor the status of your created jobs. Check if your job is QUEUED, IN_PROGRESS, COMPLETED or FAILED