The Voomerr Get Offer API allows users to retrieve their available offers. The API accepts a user ID and a currency code and returns a list of offers available to the user in the specified currency.
Endpoint #
The Voomerr Get Offer API endpoint is POST https://admin.voomerr.com/api/get_my_offers.php
Request Parameters #
The following parameters are required to retrieve available offers:
| Parameter | Type | Required | Description |
|---|---|---|---|
| user_id | string | Yes | The ID of the user for whom offers need to be retrieved. |
| currency | string | Yes | The currency code in which offers need to be retrieved. |
Example Request #
POST https://admin.voomerr.com/api/get_my_offers.php
{
"user_id": "123456789",
"currency": "USD"
}
Response #
The response from the API will contain a JSON object with the following fields:
| Field | Type | Description |
|---|---|---|
| success | boolean | Whether the request was successful or not. |
| offers | array | An array containing available offers for the user in the specified currency. |
Each offer object in the ‘offers’ array will contain the following fields:
| Field | Type | Description |
|---|---|---|
| offer_id | string | The ID of the offer. |
| title | string | The title of the offer. |
| description | string | The description of the offer. |
| image_url | string | The URL of the image associated with the offer. |
| terms_and_conditions | string | The terms and conditions associated with the offer. |
If the request is successful, the ‘success’ field will be ‘true’, and the ‘offers’ field will contain an array of offer objects. If the request fails, the ‘success’ field will be ‘false’, and the response will contain an error message indicating that the retrieval of offers has failed.
Example Response #
{
"success": true,
"offers": [
{
"offer_id": "123",
"title": "10% off on all orders over $100",
"description": "Get 10% off on all orders over $100",
"image_url": "https://example.com/offer_image.jpg",
"terms_and_conditions": "Offer valid for a limited time only. Minimum order value must be $100 to avail the discount."
},
{
"offer_id": "456",
"title": "20% off on first order",
"description": "Get 20% off on your first order",
"image_url": "https://example.com/offer_image.jpg",
"terms_and_conditions": "Offer valid only for new customers. Maximum discount of $50."
}
]
}
