POST Marketing/LoyaltyConfiguration

LoyaltyConfiguration where a LoyaltyConfiguration

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
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:

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

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoyaltyConfiguration

Name	Description	Type	Additional information
ID		integer	None.
Created		date	None.
Modified		date	None.
Disabled	Disables all store reward programs at once	date	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.
CustomerTypes	Types of customer that can benefit from loyalty program	Collection of CustomerType	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Created": "2025-12-06T05:41:50.4354582+01:00",
  "Modified": "2025-12-06T05:41:50.4354582+01:00",
  "Disabled": "2025-12-06T05:41:50.4354582+01:00",
  "MinimumOrderAmount": 4.0,
  "MaximumOrderPoints": 5,
  "OrderAmountPercent": 6.0,
  "MinimumPointsBalance": 7,
  "MaximumPointsBalance": 8,
  "CouponsOff": true,
  "CustomerTypes": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "TaxDisplay": true,
      "TariffID": 4,
      "InvoiceRequired": true
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "TaxDisplay": true,
      "TariffID": 4,
      "InvoiceRequired": true
    }
  ]
}

application/xml, text/xml

Sample:

<LoyaltyConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Marketing">
  <CouponsOff>true</CouponsOff>
  <Created>2025-12-06T05:41:50.4354582+01:00</Created>
  <CustomerTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Customer">
    <d2p1:CustomerType>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:InvoiceRequired>true</d2p1:InvoiceRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:TariffID>4</d2p1:TariffID>
      <d2p1:TaxDisplay>true</d2p1:TaxDisplay>
    </d2p1:CustomerType>
    <d2p1:CustomerType>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:InvoiceRequired>true</d2p1:InvoiceRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:TariffID>4</d2p1:TariffID>
      <d2p1:TaxDisplay>true</d2p1:TaxDisplay>
    </d2p1:CustomerType>
  </CustomerTypes>
  <Disabled>2025-12-06T05:41:50.4354582+01:00</Disabled>
  <ID>1</ID>
  <MaximumOrderPoints>5</MaximumOrderPoints>
  <MaximumPointsBalance>8</MaximumPointsBalance>
  <MinimumOrderAmount>4</MinimumOrderAmount>
  <MinimumPointsBalance>7</MinimumPointsBalance>
  <Modified>2025-12-06T05:41:50.4354582+01:00</Modified>
  <OrderAmountPercent>6</OrderAmountPercent>
</LoyaltyConfiguration>