POST Stats/UsedCoupons

Request Information

URI Parameters

None.

Body Parameters

BaseRequest
NameDescriptionTypeAdditional information
Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

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

application/xml, text/xml

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetUsedCouponsResponse
NameDescriptionTypeAdditional information
Coupons

Collection of UsedCoupons

None.

Response Formats

application/json, text/json

Sample:
{
  "Coupons": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "TimesUsed": 3,
      "AggregateAmount": 4.1
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "TimesUsed": 3,
      "AggregateAmount": 4.1
    }
  ]
}

application/xml, text/xml

Sample:
<GetUsedCouponsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Stats">
  <Coupons>
    <UsedCoupons>
      <AggregateAmount>4.1</AggregateAmount>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <TimesUsed>3</TimesUsed>
    </UsedCoupons>
    <UsedCoupons>
      <AggregateAmount>4.1</AggregateAmount>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <TimesUsed>3</TimesUsed>
    </UsedCoupons>
  </Coupons>
</GetUsedCouponsResponse>