POST v3/discounts/create

Request Information

URI Parameters

None.

Body Parameters

StoreFrontDiscountCreateRequest
NameDescriptionTypeAdditional information
name

string

None.

applyTo

string

None.

type

string

None.

value

decimal number

None.

code

string

None.

startDate

date

None.

endDate

date

None.

conditionVariable

string

None.

conditionOperator

string

None.

conditionValue

decimal number

None.

isFeatured

boolean

None.

isRule

boolean

None.

columnName

string

None.

columnValue

string

None.

columnNameSecondary

string

None.

columnValueSecondary

string

None.

Request Formats

application/json, text/json

Sample:
{
  "name": "sample string 1",
  "applyTo": "sample string 2",
  "type": "sample string 3",
  "value": 4.0,
  "code": "sample string 5",
  "startDate": "2022-10-07T13:08:20.4848465-06:00",
  "endDate": "2022-10-07T13:08:20.4848465-06:00",
  "conditionVariable": "sample string 8",
  "conditionOperator": "sample string 9",
  "conditionValue": 10.0,
  "isFeatured": true,
  "isRule": true,
  "columnName": "sample string 13",
  "columnValue": "sample string 14",
  "columnNameSecondary": "sample string 15",
  "columnValueSecondary": "sample string 16"
}

application/xml, text/xml

Sample:
<StoreFrontDiscountCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <applyTo>sample string 2</applyTo>
  <code>sample string 5</code>
  <columnName>sample string 13</columnName>
  <columnNameSecondary>sample string 15</columnNameSecondary>
  <columnValue>sample string 14</columnValue>
  <columnValueSecondary>sample string 16</columnValueSecondary>
  <conditionOperator>sample string 9</conditionOperator>
  <conditionValue>10</conditionValue>
  <conditionVariable>sample string 8</conditionVariable>
  <endDate>2022-10-07T13:08:20.4848465-06:00</endDate>
  <isFeatured>true</isFeatured>
  <isRule>true</isRule>
  <name>sample string 1</name>
  <startDate>2022-10-07T13:08:20.4848465-06:00</startDate>
  <type>sample string 3</type>
  <value>4</value>
</StoreFrontDiscountCreateRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

StoreFrontDiscountResponse
NameDescriptionTypeAdditional information
apiStatus

string

None.

isApproved

boolean

None.

data

StoreFrontDiscountDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "apiStatus": "sample string 1",
  "isApproved": true,
  "data": {
    "name": "sample string 1",
    "applyTo": "sample string 2",
    "type": "sample string 3",
    "value": 4.0,
    "code": "sample string 5"
  }
}

application/xml, text/xml

Sample:
<StoreFrontDiscountResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Blumev3.Models">
  <apiStatus>sample string 1</apiStatus>
  <data>
    <applyTo>sample string 2</applyTo>
    <code>sample string 5</code>
    <name>sample string 1</name>
    <type>sample string 3</type>
    <value>4</value>
  </data>
  <isApproved>true</isApproved>
</StoreFrontDiscountResponse>