List all discount codes

GET 
/openapi/2025-06/discount_codes

Retrieves a list of all discount codes.

Request

Query Parameters

cursor string

Cursor for pagination

page_size int32

A limit on the number of objects to be returned. Ranges from 1 to 250. Default is 10

page int32

Page number (1-based). Mutually exclusive with cursor

need_detail_url boolean

If true, returns detail URLs in the response

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

discount_code object[]

Discount code

Array [

idstring

Discount ID

allocation_methodstring

Allocation method

allocation_limitint32

Allocation limit

allocation_limit_amountfloat

Allocation limit amount

app_idstring

App ID

codestring

Discount code

customer_selectionstring

Customer selection criteria

discount_typestring

Discount type

ends_atstring

End timestamp

entitled_area_list object[]

List of entitled areas

Array [

country_codestring

Country code (e.g., CN)

province_codesstring[]

List of province codes

]

entitled_collection_idsstring[]

Entitled collection IDs

entitled_filter_idsstring[]

Entitled filter IDs

entitled_filter_liststring[]

Deprecated: use entitled_filter_detail_list instead.

entitled_filter_detail_list object[]

List of entitled filters

Array [

idstring

Filter ID

starts_atstring

Start time in RFC3339 format (e.g., 2020-06-15T16:00:00Z)

ends_atstring

End time in RFC3339 format; empty means it never expires

]

entitled_product_idsstring[]

Entitled product IDs

entitled_variant_idsstring[]

Entitled variant IDs

variant_product_idsstring[]

Product IDs of variants

is_admin_showstring

Whether visible in admin

once_per_customerint32

Whether usable once per customer

prerequisiteint32

Prerequisite condition

prerequisite_customer_idsstring[]

List of prerequisite customer IDs

prerequisite_customer_rangestring

Customer prerequisite range

prerequisite_customer_segment_idsstring[]

Customer segment prerequisite IDs

prerequisite_quantity_range object[]

Quantity prerequisite range

Array [

greater_than_or_equal_tostring

Greater than or equal to value

valuestring

The value

value_percentagestring

Percentage value

value_event_typestring

Value event type

value_conditionstring

Value condition

target_typestring

Target type

target_datastring[]

Target data

]

prerequisite_subtotal_range object[]

Subtotal prerequisite range

Array [

greater_than_or_equal_tostring

Greater than or equal to value

valuestring

The value

value_percentagestring

Percentage value

value_event_typestring

Value event type

value_conditionstring

Value condition

target_typestring

Target type

target_datastring[]

Target data

]

prerequisite_threshold_quantity_rangestring

Threshold quantity range

prerequisite_threshold_subtotal_rangestring

Threshold subtotal range

product_numint32

Number of products

progressstring

Progress

propertiesstring

Properties

sortstring

Sort configuration

starts_atstring

Start timestamp

statusstring

Status

target_price_typestring

Target price type

target_selectionstring

Target selection

target_typestring

Target type

times_usedint32

Number of times used

titlestring

Title

usage_limitint32

Usage limit. -1 means unlimited

use_with_otherint32

Whether discount can be used with others

using_statestring

Using state

valuefloat

The value

value_typestring

Value type

detail_urlstring

Detail page URL

]

cursorstring

The cursor for the next page of results

has_moreboolean

Whether there are more results

totalint32

Total number of records across all pages (for page-mode pagination)

Example

json

{
  "code": "string",
  "message": "string",
  "data": {
    "discount_code": [
      {
        "id": "string",
        "allocation_method": "string",
        "allocation_limit": 0,
        "allocation_limit_amount": 0,
        "app_id": "string",
        "code": "string",
        "customer_selection": "string",
        "discount_type": "string",
        "ends_at": "string",
        "entitled_area_list": [
          {
            "country_code": "string",
            "province_codes": [
              "string"
            ]
          }
        ],
        "entitled_collection_ids": [
          "string"
        ],
        "entitled_filter_ids": [
          "string"
        ],
        "entitled_filter_list": [
          "string"
        ],
        "entitled_filter_detail_list": [
          {
            "id": "string",
            "starts_at": "string",
            "ends_at": "string"
          }
        ],
        "entitled_product_ids": [
          "string"
        ],
        "entitled_variant_ids": [
          "string"
        ],
        "variant_product_ids": [
          "string"
        ],
        "is_admin_show": "string",
        "once_per_customer": 0,
        "prerequisite": 0,
        "prerequisite_customer_ids": [
          "string"
        ],
        "prerequisite_customer_range": "string",
        "prerequisite_customer_segment_ids": [
          "string"
        ],
        "prerequisite_quantity_range": [
          {
            "greater_than_or_equal_to": "string",
            "value": "string",
            "value_percentage": "string",
            "value_event_type": "string",
            "value_condition": "string",
            "target_type": "string",
            "target_data": [
              "string"
            ]
          }
        ],
        "prerequisite_subtotal_range": [
          {
            "greater_than_or_equal_to": "string",
            "value": "string",
            "value_percentage": "string",
            "value_event_type": "string",
            "value_condition": "string",
            "target_type": "string",
            "target_data": [
              "string"
            ]
          }
        ],
        "prerequisite_threshold_quantity_range": "string",
        "prerequisite_threshold_subtotal_range": "string",
        "product_num": 0,
        "progress": "string",
        "properties": "string",
        "sort": "string",
        "starts_at": "string",
        "status": "string",
        "target_price_type": "string",
        "target_selection": "string",
        "target_type": "string",
        "times_used": 0,
        "title": "string",
        "usage_limit": 0,
        "use_with_other": 0,
        "using_state": "string",
        "value": 0,
        "value_type": "string",
        "detail_url": "string"
      }
    ],
    "cursor": "string",
    "has_more": true,
    "total": 0
  }
}