POST api/BigCommerce/AddCoupon

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
name	string	None.
type	string	None.
amount	string	None.
min_purchase	string	None.
enabled	boolean	None.
code	string	None.
applies_to	BCCouponAppliesTo	None.
max_uses	integer	None.
max_uses_per_customer	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "name": "sample string 1",
  "type": "sample string 2",
  "amount": "sample string 3",
  "min_purchase": "sample string 4",
  "enabled": true,
  "code": "sample string 6",
  "applies_to": {
    "entity": "sample string 1",
    "ids": [
      1,
      2
    ]
  },
  "max_uses": 7,
  "max_uses_per_customer": 8
}

application/xml, text/xml

Sample:

<BCCoupon xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <name>sample string 1</name>
  <type>sample string 2</type>
  <amount>sample string 3</amount>
  <min_purchase>sample string 4</min_purchase>
  <enabled>true</enabled>
  <code>sample string 6</code>
  <applies_to>
    <entity>sample string 1</entity>
    <ids>
      <int>1</int>
      <int>2</int>
    </ids>
  </applies_to>
  <max_uses>7</max_uses>
  <max_uses_per_customer>8</max_uses_per_customer>
</BCCoupon>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.