POST Marketing/LoyaltyConfiguration

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional 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.Web.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

LoyaltyConfiguration

Name	Description	Type	Additional information
ID		integer	None.
MinimumOrderAmount	Minimum order amount to be able to spend points	decimal number	None.
MaximumOrderPoints	Minimum order points that can be spent by order. Used if greater than 0	integer	None.
OrderAmountPercent	Amount available for paying at checkout by points, %. Used if greater than 0	decimal number	Range: inclusive between 0 and 1
MinimumPointsBalance	Minimum reward points balance to be available to redeem	integer	None.
MaximumPointsBalance	Max points balance that can be accumulated by a Customer. Used if greater than 0,	integer	None.
CouponsOff	Excludes coupons	boolean	None.
ExchangeRates	Points to order amount conversion rule	Collection of ExchangeRate	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "MinimumOrderAmount": 2.0,
  "MaximumOrderPoints": 3,
  "OrderAmountPercent": 4.0,
  "MinimumPointsBalance": 5,
  "MaximumPointsBalance": 6,
  "CouponsOff": true,
  "ExchangeRates": [
    {
      "Points": 1,
      "Amount": 2.0
    },
    {
      "Points": 1,
      "Amount": 2.0
    }
  ]
}

application/xml, text/xml

Sample:

<LoyaltyConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Web.Models.View.Marketing">
  <CouponsOff>true</CouponsOff>
  <ExchangeRates>
    <ExchangeRate>
      <Amount>2</Amount>
      <Points>1</Points>
    </ExchangeRate>
    <ExchangeRate>
      <Amount>2</Amount>
      <Points>1</Points>
    </ExchangeRate>
  </ExchangeRates>
  <ID>1</ID>
  <MaximumOrderPoints>3</MaximumOrderPoints>
  <MaximumPointsBalance>6</MaximumPointsBalance>
  <MinimumOrderAmount>2</MinimumOrderAmount>
  <MinimumPointsBalance>5</MinimumPointsBalance>
  <OrderAmountPercent>4</OrderAmountPercent>
</LoyaltyConfiguration>