PUT Marketing/ModifyCoupon

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ID		integer	None.
Disabled		date	None.
Name	Name for the discount	string	Required
Code	Code for the coupon	string	Required String length: inclusive between 0 and 50
Amount	Fixed amount that will be discounted from the order ItemsBase	decimal number	None.
DiscountPercent	Percentage that will be discounted from the order ItemsBase	decimal number	Range: inclusive between 0 and 1
UsageLimit	Maximum number of uses	integer	None.
UsagePerCustomerLimit	Maximum number of uses per customer	integer	None.
MinimumOrderAmount	The minimum required order amount of CouponableEntity to apply this coupon	decimal number	None.
MaximumOrderAmount	The maximum order amount to apply this coupon (Normally used when DiscountRate is in place for Orders)	decimal number	None.
CouponsOff	Excludes other coupons	boolean	None.
ValidFrom	Validity start date	date	None.
Expiration	Validity end date	date	None.
CouponableTypeID	Defines the set of Amounts this coupon applies to: Variation.Amount (by Variation, Product, Classification, Provider or the whole Store ) or the Order.Amount	integer	None.
CouponableEntityID	ID of Entity of Type defined by CouponableType	integer	None.
CustomerID		string	String length: inclusive between 0 and 128
CustomerTypeID		integer	None.
Lang		string	None.
StoreID		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "Disabled": "2025-12-06T05:42:11.5526785+01:00",
  "Name": "sample string 2",
  "Code": "sample string 3",
  "Amount": 1.0,
  "DiscountPercent": 1.0,
  "UsageLimit": 4,
  "UsagePerCustomerLimit": 5,
  "MinimumOrderAmount": 6.0,
  "MaximumOrderAmount": 1.0,
  "CouponsOff": true,
  "ValidFrom": "2025-12-06T05:42:11.5526785+01:00",
  "Expiration": "2025-12-06T05:42:11.5526785+01:00",
  "CouponableTypeID": 9,
  "CouponableEntityID": 10,
  "CustomerID": "sample string 11",
  "CustomerTypeID": 1,
  "Lang": "sample string 12",
  "StoreID": 13
}

application/xml, text/xml

Sample:

<CouponBinding xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Binding.Marketing">
  <Lang xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">sample string 12</Lang>
  <StoreID xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Base">13</StoreID>
  <Amount>1</Amount>
  <Code>sample string 3</Code>
  <CouponableEntityID>10</CouponableEntityID>
  <CouponableTypeID>9</CouponableTypeID>
  <CouponsOff>true</CouponsOff>
  <CustomerID>sample string 11</CustomerID>
  <CustomerTypeID>1</CustomerTypeID>
  <Disabled>2025-12-06T05:42:11.5526785+01:00</Disabled>
  <DiscountPercent>1</DiscountPercent>
  <Expiration>2025-12-06T05:42:11.5526785+01:00</Expiration>
  <ID>1</ID>
  <MaximumOrderAmount>1</MaximumOrderAmount>
  <MinimumOrderAmount>6</MinimumOrderAmount>
  <Name>sample string 2</Name>
  <UsageLimit>4</UsageLimit>
  <UsagePerCustomerLimit>5</UsagePerCustomerLimit>
  <ValidFrom>2025-12-06T05:42:11.5526785+01:00</ValidFrom>
</CouponBinding>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:

application/xml, text/xml

Sample:

<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>