POST api/v1/AddSalesPromotion

Request Information

URI Parameters

None.

Body Parameters

AddSalesPromotionRequest
NameDescriptionTypeAdditional information
SaleName

string

None.

Note

string

None.

StartDate

date

None.

EndDate

date

None.

SKU

integer

None.

CountType

integer

None.

Quantity

integer

None.

DiscountValue

decimal number

None.

BogoBuy

integer

None.

BogoGet

integer

None.

BogoDiscType

integer

None.

BogoDiscountValue

decimal number

None.

Request Formats

application/json, text/json

Sample:
{
  "SaleName": "sample string 1",
  "Note": "sample string 2",
  "StartDate": "2026-05-23T13:46:36.389422-04:00",
  "EndDate": "2026-05-23T13:46:36.389422-04:00",
  "SKU": 5,
  "CountType": 6,
  "Quantity": 1,
  "DiscountValue": 1.0,
  "BogoBuy": 1,
  "BogoGet": 1,
  "BogoDiscType": 1,
  "BogoDiscountValue": 1.0
}

application/xml, text/xml

Sample:
<AddSalesPromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GPOS.DataService.Models">
  <BogoBuy>1</BogoBuy>
  <BogoDiscType>1</BogoDiscType>
  <BogoDiscountValue>1</BogoDiscountValue>
  <BogoGet>1</BogoGet>
  <CountType>6</CountType>
  <DiscountValue>1</DiscountValue>
  <EndDate>2026-05-23T13:46:36.389422-04:00</EndDate>
  <Note>sample string 2</Note>
  <Quantity>1</Quantity>
  <SKU>5</SKU>
  <SaleName>sample string 1</SaleName>
  <StartDate>2026-05-23T13:46:36.389422-04:00</StartDate>
</AddSalesPromotionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiReturnStatus
NameDescriptionTypeAdditional information
Result

boolean

None.

Status

integer

None.

Msg

string

None.

ID

string

None.

Data

Object

None.

ExtraData

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": true,
  "Status": 2,
  "Msg": "sample string 3",
  "ID": "sample string 4",
  "Data": {},
  "ExtraData": {}
}

application/xml, text/xml

Sample:
<ApiReturnStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GPOS.DataService.Models">
  <Data />
  <ExtraData />
  <ID>sample string 4</ID>
  <Msg>sample string 3</Msg>
  <Result>true</Result>
  <Status>2</Status>
</ApiReturnStatus>