POST Marketing/Coupons

Get all the Coupons

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Filter	CouponFilter	Required
Range	AdminFilterRange	Required
Lang	string	None.
StoreID	integer	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

CouponsView

Name	Description	Type	Additional information
TotalCount		integer	None.
Coupons		Collection of Coupon	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Coupons": [
    {
      "ID": 1,
      "Disabled": "2025-12-06T09:18:50.7399261+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-06T09:18:50.7399261+01:00",
      "Expiration": "2025-12-06T09:18:50.7399261+01:00",
      "CouponableTypeID": 8,
      "CouponableEntityID": 9,
      "CustomerID": "sample string 10",
      "CustomerTypeID": 1
    },
    {
      "ID": 1,
      "Disabled": "2025-12-06T09:18:50.7399261+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-06T09:18:50.7399261+01:00",
      "Expiration": "2025-12-06T09:18:50.7399261+01:00",
      "CouponableTypeID": 8,
      "CouponableEntityID": 9,
      "CustomerID": "sample string 10",
      "CustomerTypeID": 1
    }
  ]
}

application/xml, text/xml

Sample:

<CouponsView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ShopworldApi.Admin.Models.View.Marketing">
  <Coupons>
    <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-06T09:18:50.7399261+01:00</Disabled>
      <DiscountPercent>1</DiscountPercent>
      <Expiration>2025-12-06T09:18:50.7399261+01:00</Expiration>
      <ID>1</ID>
      <MinimumOrderAmount>5</MinimumOrderAmount>
      <Name>sample string 2</Name>
      <UsageLimit>4</UsageLimit>
      <UsagePerCustomerLimit>6</UsagePerCustomerLimit>
      <ValidFrom>2025-12-06T09:18:50.7399261+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-06T09:18:50.7399261+01:00</Disabled>
      <DiscountPercent>1</DiscountPercent>
      <Expiration>2025-12-06T09:18:50.7399261+01:00</Expiration>
      <ID>1</ID>
      <MinimumOrderAmount>5</MinimumOrderAmount>
      <Name>sample string 2</Name>
      <UsageLimit>4</UsageLimit>
      <UsagePerCustomerLimit>6</UsagePerCustomerLimit>
      <ValidFrom>2025-12-06T09:18:50.7399261+01:00</ValidFrom>
    </Coupon>
  </Coupons>
  <TotalCount>1</TotalCount>
</CouponsView>