Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Current »

NamePromotion Codes Index
DescriptionList all promotion codes configured in the settings app for your brokerage.
TypeGET
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
codeFilter results by case-insensitive codestringOptional
inactiveDisplay inactive results (default is active-only)trueOptional

Examples

RequestResponse
/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
}
  • No labels