Admin

List all coupons

Retrieve a list of all coupons with optional filtering by active status, discount type, and search.

get/admin/coupons

Request

Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
URL: https://api.presscart.com/admin/coupons
Auth: HTTP bearer

Query parameters

limitnumber nullable

pagenumber nullable

order_by'asc' | 'desc'

sort_bystring

include_archived'true' | 'false'

skip_pagination'true' | 'false'

activeboolean

discount_type'percent_off' | 'amount_off'

searchstring

fetch_allboolean

Response

Coupons retrieved successfully

total_pagesnumber required

current_pagenumber required

next_pagenumber nullable required

previous_pagenumber nullable required

total_recordsnumber required

Example response

{
  "records": [
    {
      "code": "SAVE20",
      "name": "20% Off Summer Sale",
      "description": "Summer promotional discount",
      "discount_type": "percent_off",
      "discount_value": 20,
      "max_redemptions": 100,
      "max_redemptions_per_team": 1,
      "minimum_order_amount": 50,
      "active": true,
      "stripe_coupon_id": "coupon_1234567890",
      "stripe_promotion_code_id": "promo_1234567890",
      "created_by": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.