Retrieve a specific coupon

GET 
/api/v3/coupon/:coupon_id

Allows you to retrieve a specific coupon based on its coupon_id.

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

coupon_id integer

The coupon ID #

code string

Coupon code

descrip string

Description

type string

Coupon type

discount_item_id integer

Item ID # or related discount (if applicable)

enabled boolean

Enabled/disabled

discount array

Discount details

freetrial array

Free trial details

write_datetime string

Date/time the coupon was created

write_ipaddr string

IP address that created the coupon

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "coupon_id": 0,
    "code": "string",
    "descrip": "string",
    "type": "string",
    "discount_item_id": 0,
    "enabled": true,
    "discount": [
      null
    ],
    "freetrial": [
      null
    ],
    "write_datetime": "string",
    "write_ipaddr": "string"
  }
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "coupon_id": 1,
    "code": "ABC123",
    "descrip": "10% off your next purchase",
    "type": "give-a-discount",
    "enabled": true,
    "write_datetime": "2021-05-25 08:23:05",
    "write_ipaddr": "172.19.0.1",
    "discount_item_id": 673
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...