...
Page Properties |
---|
label | api_docs_promotion_codes |
---|
|
Name | Promotion Codes Show |
---|
Description | Display a single promotion code. |
---|
Type | GET |
---|
URL | /v9/promotion_codes/:id |
---|
|
Long Description
Display information about a single promotion code that has been configured for your brokerage in the settings app.
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/45 |
Code Block |
---|
language | ruby |
---|
{
"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
} |
|