POST Marketing/GetPromotion

Request Information

URI Parameters

None.

Body Parameters

GetPromotionRequest
NameDescriptionTypeAdditional information
ID

integer

Required

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:
<GetPromotionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Marketing">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">sample string 2</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.Common.Base">3</StoreID>
  <ID>1</ID>
</GetPromotionRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Promotion
NameDescriptionTypeAdditional information
Slug

string

None.

Name

string

None.

Description

string

None.

CouponsOff

the promotion excludes use of coupons

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Slug": "sample string 1",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CouponsOff": true
}

application/xml, text/xml

Sample:
<Promotion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Marketing">
  <CouponsOff>true</CouponsOff>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <Slug>sample string 1</Slug>
</Promotion>