Promotion codes
List promotion codes
Retrieve a list of all promotion codes
GET
/
v1
/
promotion-codes
List promotion codes
curl --request GET \
--url https://api.example.com/v1/promotion-codesimport requests
url = "https://api.example.com/v1/promotion-codes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/promotion-codes', 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/promotion-codes",
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/promotion-codes"
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/promotion-codes")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/promotion-codes")
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": [
{
"code": "PROMO123",
"first_time_order": true,
"limit_to_specific_partner": false,
"coupon_specific_partners": [],
"limit_to_specific_customer": false,
"coupon_specific_customers": [],
"minimum_order_status": true,
"minimum_order_value": 22,
"expiration_date_status": false,
"expiration_date_value": null,
"redemption_times_status": false,
"redemption_times_value": null,
"metadata": [],
"additional_info": [],
"times_redeemed": 2
}
],
"links": {
"first": "https://api.partnero.com/v1/promotion-codes?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/promotion-codes",
"per_page": 10,
"to": 1
},
"status": 1
}
A promotion code is a redeemable code that points to a coupon. You can create multiple codes for a single coupon with different restrictions.
Endpoint
GET https://api.partnero.com/v1/promotion-codes
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/promotion-codes' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY'
Response
{
"data": [
{
"code": "PROMO123",
"first_time_order": true,
"limit_to_specific_partner": false,
"coupon_specific_partners": [],
"limit_to_specific_customer": false,
"coupon_specific_customers": [],
"minimum_order_status": true,
"minimum_order_value": 22,
"expiration_date_status": false,
"expiration_date_value": null,
"redemption_times_status": false,
"redemption_times_value": null,
"metadata": [],
"additional_info": [],
"times_redeemed": 2
}
],
"links": {
"first": "https://api.partnero.com/v1/promotion-codes?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/promotion-codes",
"per_page": 10,
"to": 1
},
"status": 1
}
Response Fields
| Field | Type | Description |
|---|---|---|
data[].code | string | The promotion code |
data[].first_time_order | boolean | Valid only for first-time orders |
data[].limit_to_specific_partner | boolean | Restricted to specific partner |
data[].limit_to_specific_customer | boolean | Restricted to specific customer |
data[].minimum_order_status | boolean | Minimum order required |
data[].minimum_order_value | number | Minimum order amount |
data[].expiration_date_status | boolean | Has expiration date |
data[].expiration_date_value | date | Expiration date |
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 promotion codes
curl --request GET \
--url https://api.example.com/v1/promotion-codesimport requests
url = "https://api.example.com/v1/promotion-codes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/promotion-codes', 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/promotion-codes",
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/promotion-codes"
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/promotion-codes")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/promotion-codes")
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": [
{
"code": "PROMO123",
"first_time_order": true,
"limit_to_specific_partner": false,
"coupon_specific_partners": [],
"limit_to_specific_customer": false,
"coupon_specific_customers": [],
"minimum_order_status": true,
"minimum_order_value": 22,
"expiration_date_status": false,
"expiration_date_value": null,
"redemption_times_status": false,
"redemption_times_value": null,
"metadata": [],
"additional_info": [],
"times_redeemed": 2
}
],
"links": {
"first": "https://api.partnero.com/v1/promotion-codes?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https://api.partnero.com/v1/promotion-codes",
"per_page": 10,
"to": 1
},
"status": 1
}