Coupons
List coupons
Retrieve a list of all coupons
GET
/
v1
/
coupons
List coupons
curl --request GET \
--url https://api.example.com/v1/couponsimport requests
url = "https://api.example.com/v1/coupons"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coupons"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coupons")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "PARTNERO25",
"uuid_code": "coupon_123",
"active": true,
"coupon_discount_type": "percent",
"coupon_discount_amount": 25,
"coupon_duration_type": "months",
"coupon_duration_value": 11,
"redemption_specific_date_status": false,
"redemption_specific_date_value": null,
"redemption_times_status": true,
"redemption_times_value": 24,
"promotion_codes": {
"data": []
},
"metadata": [],
"additional_info": [],
"times_redeemed": 3,
"created_at": "2025-05-07T17:43:26.000000Z",
"updated_at": "2025-05-07T17:43:26.000000Z",
"deleted_at": null
}
],
"links": {
"first": "https://api.partnero.com/v1/coupons?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/coupons",
"per_page": 10,
"to": 1
},
"status": 1
}
Endpoint
GET https://api.partnero.com/v1/coupons
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
limit | integer | 10 | Number of results per page (10-100) |
page | integer | 1 | Page number for pagination |
Request
cURL
curl --location 'https://api.partnero.com/v1/coupons' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'
Response
{
"data": [
{
"name": "PARTNERO25",
"uuid_code": "coupon_123",
"active": true,
"coupon_discount_type": "percent",
"coupon_discount_amount": 25,
"coupon_duration_type": "months",
"coupon_duration_value": 11,
"redemption_specific_date_status": false,
"redemption_specific_date_value": null,
"redemption_times_status": true,
"redemption_times_value": 24,
"promotion_codes": {
"data": []
},
"metadata": [],
"additional_info": [],
"times_redeemed": 3,
"created_at": "2025-05-07T17:43:26.000000Z",
"updated_at": "2025-05-07T17:43:26.000000Z",
"deleted_at": null
}
],
"links": {
"first": "https://api.partnero.com/v1/coupons?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/coupons",
"per_page": 10,
"to": 1
},
"status": 1
}
Response Fields
| Field | Type | Description |
|---|---|---|
data[].name | string | Customer-facing coupon name |
data[].uuid_code | string | Unique coupon identifier |
data[].active | boolean | Whether coupon is active |
data[].coupon_discount_type | string | percent or static |
data[].coupon_discount_amount | number | Discount amount or percentage |
data[].coupon_duration_type | string | once, hours, days, months, years, lifetime |
data[].coupon_duration_value | integer | Duration value |
data[].promotion_codes | object | Associated promotion codes |
data[].metadata | object | Custom key-value pairs |
data[].times_redeemed | integer | Total number of redemptions |
data[].additional_info | object | Internal data, including a redemptions log when redemptions are recorded via the API |
⌘I
List coupons
curl --request GET \
--url https://api.example.com/v1/couponsimport requests
url = "https://api.example.com/v1/coupons"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/coupons', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/coupons",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/coupons"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/v1/coupons")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/coupons")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": [
{
"name": "PARTNERO25",
"uuid_code": "coupon_123",
"active": true,
"coupon_discount_type": "percent",
"coupon_discount_amount": 25,
"coupon_duration_type": "months",
"coupon_duration_value": 11,
"redemption_specific_date_status": false,
"redemption_specific_date_value": null,
"redemption_times_status": true,
"redemption_times_value": 24,
"promotion_codes": {
"data": []
},
"metadata": [],
"additional_info": [],
"times_redeemed": 3,
"created_at": "2025-05-07T17:43:26.000000Z",
"updated_at": "2025-05-07T17:43:26.000000Z",
"deleted_at": null
}
],
"links": {
"first": "https://api.partnero.com/v1/coupons?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/coupons",
"per_page": 10,
"to": 1
},
"status": 1
}