Skip to main content
GET
/
v1
/
promotion-codes
List promotion codes
curl --request GET \
  --url https://api.example.com/v1/promotion-codes
{
  "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
}

Documentation Index

Fetch the complete documentation index at: https://docs.partnero.com/llms.txt

Use this file to discover all available pages before exploring further.

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

ParameterTypeDefaultDescription
limitinteger15Number of results per page (1-250)
pageinteger1Page 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

FieldTypeDescription
data[].codestringThe promotion code
data[].first_time_orderbooleanValid only for first-time orders
data[].limit_to_specific_partnerbooleanRestricted to specific partner
data[].limit_to_specific_customerbooleanRestricted to specific customer
data[].minimum_order_statusbooleanMinimum order required
data[].minimum_order_valuenumberMinimum order amount
data[].expiration_date_statusbooleanHas expiration date
data[].expiration_date_valuedateExpiration date
data[].times_redeemedintegerTotal number of redemptions
data[].additional_infoobjectInternal data, including a redemptions log when redemptions are recorded via the API