Table of Contents
The “Get gig products” API allows the user to retrieve all products offered by a particular gig.
Endpoint #
The Voomerr Get Gig Products endpoint is POST https://admin.voomerr.com/get_gig_products.php
Request Parameters #
The following parameters are required to be sent along with the API request:
| Parameter | Required | Description |
|---|---|---|
| user_id | Yes | The ID of the user whose gig products you want to retrieve. |
| gig_id | Yes | The ID of the gig whose products you want to retrieve. |
| currency | Yes | The currency in which you want the prices to be returned. |
Response Parameters #
The response from the API will be in JSON format and will contain the following fields:
| Parameter | Description |
|---|---|
| success | A boolean indicating whether the request was successful or not. |
| message | A message describing the result of the request. |
| products | An array of objects containing details about each product associated with the specified gig. |
| product | Details of an individual product associated with the specified gig. This field will repeat per product. |
‘products’ array #
The ‘products’ array contains details about each product associated with the specified gig.
| Parameter | Description |
|---|---|
| product_id | The ID of the product. |
| name | The name of the product. |
| image | The URL of the product image. |
| price | The price of the product in the specified currency |
| currency | The currency of the product price. |
‘product’ object #
The ‘product’ object contains details of an individual product associated with the specified gig. This field will repeat per product.
| Parameter | Description |
|---|---|
| product_id | The ID of the product. |
| name | The name of the product. |
| image | The URL of the product image. |
| price | The price of the product in the specified currency |
| currency | The currency of the product price. |
Example Request #
json
{
"user_id": "1234",
"gig_id": "5678",
"currency": "USD"
}
Example Response #
json
{
"success": true,
"message": "Gig products retrieved successfully.",
"products": [
{
"product_id": "1234",
"name": "Pizza Margherita",
"image": "https://example.com/pizza_margherita.jpg",
"price": 12.99,
"currency": "USD"
},
{
"product_id": "5678",
"name": "Pizza Pepperoni",
"image": "https://example.com/pizza_pepperoni.jpg",
"price": 14.99,
"currency": "USD"
}
]
}