POST Customers/Coupons

Request Information

URI Parameters

None.

Body Parameters

CustomerRequest

Name	Type	Additional information
ID	string	Required String length: inclusive between 0 and 128
Lang	string	None.
StoreID	integer	None.

Name

Description

Type

Additional information

string

Required

String length: inclusive between 0 and 128

Lang

string

None.

StoreID

integer

None.

Request Formats

application/json, text/json

Sample:

{
  "ID": "sample string 1",
  "Lang": "sample string 2",
  "StoreID": 3
}

application/xml, text/xml

Sample:

<CustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.Common.Customer">
  <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>sample string 1</ID>
</CustomerRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Coupon

Name	Description	Type	Additional information
ID		integer	None.
Disabled		date	None.
Name		string	None.
Code		string	Required String length: inclusive between 0 and 50
Amount		decimal number	None.
DiscountPercent		decimal number	Range: inclusive between 0 and 1
UsageLimit		integer	None.
MinimumOrderAmount	The minimum required order amount of CouponableEntity to apply this coupon	decimal number	None.
UsagePerCustomerLimit		integer	None.
ValidFrom		date	None.
Expiration		date	None.
CouponableTypeID		integer	None.
CouponableEntityID	ID of Entity of Type defined by CouponableType	integer	None.
CustomerID		string	None.
CustomerTypeID		integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Disabled": "2025-12-06T05:41:49.7941737+01:00",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Amount": 1.0,
    "DiscountPercent": 1.0,
    "UsageLimit": 4,
    "MinimumOrderAmount": 5.0,
    "UsagePerCustomerLimit": 6,
    "ValidFrom": "2025-12-06T05:41:49.7941737+01:00",
    "Expiration": "2025-12-06T05:41:49.7941737+01:00",
    "CouponableTypeID": 8,
    "CouponableEntityID": 9,
    "CustomerID": "sample string 10",
    "CustomerTypeID": 1
  },
  {
    "ID": 1,
    "Disabled": "2025-12-06T05:41:49.7941737+01:00",
    "Name": "sample string 2",
    "Code": "sample string 3",
    "Amount": 1.0,
    "DiscountPercent": 1.0,
    "UsageLimit": 4,
    "MinimumOrderAmount": 5.0,
    "UsagePerCustomerLimit": 6,
    "ValidFrom": "2025-12-06T05:41:49.7941737+01:00",
    "Expiration": "2025-12-06T05:41:49.7941737+01:00",
    "CouponableTypeID": 8,
    "CouponableEntityID": 9,
    "CustomerID": "sample string 10",
    "CustomerTypeID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfCoupon xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Marketing">
  <Coupon>
    <Amount>1</Amount>
    <Code>sample string 3</Code>
    <CouponableEntityID>9</CouponableEntityID>
    <CouponableTypeID>8</CouponableTypeID>
    <CustomerID>sample string 10</CustomerID>
    <CustomerTypeID>1</CustomerTypeID>
    <Disabled>2025-12-06T05:41:49.7941737+01:00</Disabled>
    <DiscountPercent>1</DiscountPercent>
    <Expiration>2025-12-06T05:41:49.7941737+01:00</Expiration>
    <ID>1</ID>
    <MinimumOrderAmount>5</MinimumOrderAmount>
    <Name>sample string 2</Name>
    <UsageLimit>4</UsageLimit>
    <UsagePerCustomerLimit>6</UsagePerCustomerLimit>
    <ValidFrom>2025-12-06T05:41:49.7941737+01:00</ValidFrom>
  </Coupon>
  <Coupon>
    <Amount>1</Amount>
    <Code>sample string 3</Code>
    <CouponableEntityID>9</CouponableEntityID>
    <CouponableTypeID>8</CouponableTypeID>
    <CustomerID>sample string 10</CustomerID>
    <CustomerTypeID>1</CustomerTypeID>
    <Disabled>2025-12-06T05:41:49.7941737+01:00</Disabled>
    <DiscountPercent>1</DiscountPercent>
    <Expiration>2025-12-06T05:41:49.7941737+01:00</Expiration>
    <ID>1</ID>
    <MinimumOrderAmount>5</MinimumOrderAmount>
    <Name>sample string 2</Name>
    <UsageLimit>4</UsageLimit>
    <UsagePerCustomerLimit>6</UsagePerCustomerLimit>
    <ValidFrom>2025-12-06T05:41:49.7941737+01:00</ValidFrom>
  </Coupon>
</ArrayOfCoupon>