Promotion Codes / Index

Name	Promotion Codes Index
Description	List all promotion codes configured in the settings app for your brokerage.
Type	GET
URL	/v9/promotion_codes

Long Description

Display all promotion codes that are configured for your brokerage and their associated names and values.

Parameters

Name	Description	Value Type	Required
code	Filter results by case-insensitive code	string	Optional
inactive	Display inactive results (default is active-only)	true	Optional

Notes

minimum_spend:
- Validates against order price * quantity, rejecting code and order if minimum_spend is not met.
maximum_redemptions
- Value returned will be -1 if unlimited, otherwise a positive integer.

Examples

Request

Response

/v9/promotion_codes

{
  "current_page": 1,
  "total_entries": 1,
  "promotion_codes": [
    {
      "start_date": null,
      "active": true,
      "end_date": null,
      "percentage": false,
      "value": 10.0,
      "url": "/promotion_codes/45",
      "updated_at": "2013-07-17T19:31:05Z",
      "created_at": "2013-07-17T19:31:05Z",
      "name": "A Code",
      "id": 45,
      "code": "CODE123",
      "minimum_spend": "10.0",
      "maximum_redemptions": 100,
      "redemptions_count": 17
    }
  ],
  "per_page": 100
}