List discount codes

Bearer authdiscounts.readAlpha

Alpha: This endpoint is available only to approved API integrations and may change without notice.

Lists active discount codes for the authenticated shop. Filter by campaign or code when resolving a code at checkout. The response includes reward configuration needed to apply the offer.

GETapi.superfiliate.com/api/v1/discount_codes

Query parameters2

campaign_id

integer

Only return codes for this campaign.

code

string

Only return this code. Matching is case-insensitive.

Responses

A list of discount codes

array of objects — item fields

idinteger
codestring
Code associated with this resource.
campaign_idinteger | null
Identifier for the related campaign.
reward_unitstring
The reward unit for this resource.
reward_valuestring
The reward value for this resource.
minimum_subtotal_valuestring
The minimum subtotal value for this resource.
lead_discount_new_customers_onlyboolean
The lead discount new customers only for this resource.
lead_reward_unitstring
The lead reward unit for this resource.
lead_reward_valuestring
The lead reward value for this resource.
lead_discount_min_valuestring | null
The lead discount min value for this resource.
lead_apply_once_per_customerboolean
The lead apply once per customer for this resource.
recovered_customer_reward_unitstring | null
The recovered customer reward unit for this resource.
recovered_customer_reward_valuestring | null
The recovered customer reward value for this resource.
reject_recovered_customerboolean
The reject recovered customer for this resource.
commission_include_shippingboolean
The commission include shipping for this resource.
commission_include_taxesboolean
The commission include taxes for this resource.
cashback_valuestring
The cashback value for this resource.
The cashback duration for this resource.
- valueinteger
  The value for this resource.
- unitstring
  The unit for this resource.
attribution_window_daysinteger | null
The attribution window days for this resource.
time_to_process_in_hoursinteger
The time to process in hours for this resource.
reward_currencystring
The reward currency for this resource.
lead_discount_typestring
The lead discount type for this resource.
lead_reward_usage_limitinteger | null
The lead reward usage limit for this resource.