Use Cases - Endpoints Explained#

Partner API/Promotions has a range of functionalities designed to ensure an easy process to create and manage your promotions. See a list of the use cases and how to configure them below:

• Manage Promotion via PUT
  • Create promotion
  • Modify promotion
  • Deactivate promotion
• Check your Promotion status via GET

Manage Promotion#

Check API Specifications

Using the PUT /promotion endpoint, it is easy to create or update promotions to boost partner’s sales and engage customers.

Through this endpoint you’ll be able to:

1. Create a Promotion,
2. Modify a Promotion
3. Deactivate a Promotion

1. Create a promotion#

The PUT endpoint is used to create a promotion. 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://foodpanda.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": true,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_SG": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
    {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 15.11,
      "active": true,
      "sku": [
        "ABCEx3"
            ]
        },
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": true,
      "sku": [
        "D14"
            ]
        }
    ]
}

2. Modify a promotion#

If you want to modify the promotion and remove the existing SKU from the running promotion, based in the example above the request should look the following way:

curl --location --request PUT 'https://foodpanda.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data{
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": true,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_SG": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": false,
      "sku": [
        "D14"
            ]
        }
    ]
}

In this case we have removed SKU D14 from the running promotion. SKU ABCEx3 stayed in the promotion and running.

3. Deactivate a promotion#

If you want to stop the running promotion, you should send another request with the same data as during the promotion creation and set active status as false on the active level in the beginning of the request.

curl --location --request PUT 'https://foodpanda.partner.deliveryhero.io/v2/chains/f9cc1b05-8610-4e14-b9f5-9dde917e143d/promotion' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \
--data {
"vendors": [
    "s8ym"
  ],
  "type": "STRIKETHROUGH",
        "active": false,
  "reason": "COMPETITIVENESS",
  "display_name": {
    "en_SG": "Promotions"
  },
  "conditions": {
    "start_time": "2025-03-28T15:59:59.895Z",
    "end_time": "2025-03-30T16:59:59.895Z"
  },
  "discount": [
    {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 15.11,
      "active": true,
      "sku": [
        "ABCEx3"
            ]
        },
        {
      "discount_subtype": "FINAL_PRICE",
      "discount_value": 5.31,
      "active": true,
      "sku": [
        "D14"
            ]
        }
    ]
}

In all three cases the same URL will be used as in the example above.

Check your Promotion status via GET#

Check API Specifications

GET endpoint provides the status of the promotion that has been created with the PUT endpoint together with the information about the status of the promotions.

Job status can have three values:

• QUEUED if the job has not yet been processed
• COMPLETED job is finished successfully
• FAILED- the job failed

You can view the details of the created promotion directly in your Partner Portal. The Shops Promotions Plugin will display:

1. If your Promotions was created
2. How your Promotion was created
3. What is the status of your promotions (Cancelled, Ended, Running, Upcoming)
4. Start and end dates of the promotions
5. What SKUs were included to the promotions
6. What is the name and the reason of your promotion