Get promotion code

Retrieve a specific promotion code

GET /v1/promotion-codes/{code}

Get promotion code

cURL

curl --request GET \
  --url https://api.example.com/v1/promotion-codes/{code}

200 OK

{
  "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,
    "coupon": {
      "name": "PARTNERO25",
      "uuid_code": "coupon_123",
      "active": true,
      "coupon_discount_type": "percent",
      "coupon_discount_amount": 25,
      "coupon_duration_type": "months",
      "coupon_duration_value": 11,
      "created_at": "2025-05-09T06:22:59.000000Z",
      "updated_at": "2025-05-09T06:23:44.000000Z"
    }
  },
  "status": 1
}

Endpoint

GET https://api.partnero.com/v1/promotion-codes/{code}

Path Parameters

Parameter	Type	Required	Description
code	string	Yes	The promotion code

Request

cURL

curl --location 'https://api.partnero.com/v1/promotion-codes/PROMO123' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

Response

200 OK

{
  "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,
    "coupon": {
      "name": "PARTNERO25",
      "uuid_code": "coupon_123",
      "active": true,
      "coupon_discount_type": "percent",
      "coupon_discount_amount": 25,
      "coupon_duration_type": "months",
      "coupon_duration_value": 11,
      "created_at": "2025-05-09T06:22:59.000000Z",
      "updated_at": "2025-05-09T06:23:44.000000Z"
    }
  },
  "status": 1
}

Response Fields

Field	Type	Description
data.code	string	The promotion code
data.coupon	object	The associated coupon details
data.first_time_order	boolean	Valid only for first-time orders
data.minimum_order_value	number	Minimum order amount required
data.times_redeemed	integer	Total number of redemptions for this code
data.additional_info	object	Internal data, including a redemptions log when redemptions are recorded via the API