Brand
Discounts
List

List Discounts (admin)

Retrieve a list of available discounts in the system. This includes details such as discount codes, rules, start and end dates, and whether a discount is active, dynamic, or disabled.

Overview

  • Method: GET
  • Path: /brand/discounts/list
  • Tags: brand

Use Cases

  • View all discount codes currently stored in the system.
  • Check if a discount is active, disabled, or time-limited.
  • Review discount rules and metadata for reporting or troubleshooting.
  • Identify parent-child discount relationships for complex promotions.

Parameters

No parameters required.

Request Body

No request body required.

Responses

200

Successful response

Content Type: application/json

{
  "discounts": "string",
  "code": "string",
  "is_dynamic": true,
  "is_disabled": true,
  "rule_id": "string",
  "parent_discount_id": "string",
  "starts_at": "2024-01-01T00:00:00.000Z",
  "ends_at": "2024-01-01T00:00:00.000Z",
  "created_at": "2024-01-01T00:00:00.000Z",
  "updated_at": "2024-01-01T00:00:00.000Z",
  "deleted_at": "2024-01-01T00:00:00.000Z",
  "metadata": {
    "key": {}
  }
}

400

Bad Request

Content Type: application/json

{
  "error": "string",
  "details": [
    {}
  ]
}

401

Unauthorized

404

Not Found

500

Internal Server Error

Example Usage

curl -X GET \
  https://api.pillexa.com/brand/discounts/list \
  -H "Content-Type: application/json" \
Create DiscountVerify