POST Marketing/LoyaltyConfiguration

Request Information

URI Parameters

None.

Body Parameters

GetLoyaltyConfigurationRequest
NameDescriptionTypeAdditional information
ID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ID": 1
}

application/xml, text/xml

Sample:
<GetLoyaltyConfigurationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.SysAdmin.Models.View.Marketing">
  <ID>1</ID>
</GetLoyaltyConfigurationRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoyaltyConfiguration
NameDescriptionTypeAdditional information
ID

integer

None.

Created

date

None.

Modified

date

None.

Disabled

date

None.

MinimumOrderAmount

decimal number

None.

MaximumOrderPoints

integer

None.

OrderAmountPercent

decimal number

Range: inclusive between 0 and 1

MinimumPointsBalance

integer

None.

MaximumPointsBalance

integer

None.

CouponsOff

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": 1,
  "Created": "2025-12-11T06:07:39.4328173+01:00",
  "Modified": "2025-12-11T06:07:39.4328173+01:00",
  "Disabled": "2025-12-11T06:07:39.4328173+01:00",
  "MinimumOrderAmount": 4.0,
  "MaximumOrderPoints": 5,
  "OrderAmountPercent": 6.0,
  "MinimumPointsBalance": 7,
  "MaximumPointsBalance": 8,
  "CouponsOff": true
}

application/xml, text/xml

Sample:
<LoyaltyConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.SysAdmin.Models.View.Marketing">
  <CouponsOff>true</CouponsOff>
  <Created>2025-12-11T06:07:39.4328173+01:00</Created>
  <Disabled>2025-12-11T06:07:39.4328173+01:00</Disabled>
  <ID>1</ID>
  <MaximumOrderPoints>5</MaximumOrderPoints>
  <MaximumPointsBalance>8</MaximumPointsBalance>
  <MinimumOrderAmount>4</MinimumOrderAmount>
  <MinimumPointsBalance>7</MinimumPointsBalance>
  <Modified>2025-12-11T06:07:39.4328173+01:00</Modified>
  <OrderAmountPercent>6</OrderAmountPercent>
</LoyaltyConfiguration>