GET v1/Coupons

Documentation for 'Get'.

Request Information

Parameters

NameDescriptionAdditional information
queryOptions 
Documentation for 'queryOptions'.

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
Click to beautify! 
[
  {
    "name": "sample string 1",
    "description": "sample string 2",
    "eligibilityStartDate": "2024-05-03T05:28:10.3580569+00:00",
    "eligibilityEndDate": "2024-05-03T05:28:10.3580569+00:00",
    "status": "sample string 3",
    "applyToAllPlans": true,
    "oneTimeUse": true,
    "couponCodes": [
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      }
    ],
    "id": 6,
    "uri": "sample string 7"
  },
  {
    "name": "sample string 1",
    "description": "sample string 2",
    "eligibilityStartDate": "2024-05-03T05:28:10.3580569+00:00",
    "eligibilityEndDate": "2024-05-03T05:28:10.3580569+00:00",
    "status": "sample string 3",
    "applyToAllPlans": true,
    "oneTimeUse": true,
    "couponCodes": [
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      }
    ],
    "id": 6,
    "uri": "sample string 7"
  },
  {
    "name": "sample string 1",
    "description": "sample string 2",
    "eligibilityStartDate": "2024-05-03T05:28:10.3580569+00:00",
    "eligibilityEndDate": "2024-05-03T05:28:10.3580569+00:00",
    "status": "sample string 3",
    "applyToAllPlans": true,
    "oneTimeUse": true,
    "couponCodes": [
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      },
      {
        "id": 1,
        "code": "sample string 2",
        "timesUsed": 3,
        "remainingUsages": 1
      }
    ],
    "id": 6,
    "uri": "sample string 7"
  }
]

application/xml, text/xml

Sample:
Click to beautify! 
<ArrayOfCouponConfigurationSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get">
  <CouponConfigurationSummary>
    <Id>6</Id>
    <Uri>sample string 7</Uri>
    <ApplyToAllPlans>true</ApplyToAllPlans>
    <CouponCodes>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
    </CouponCodes>
    <Description>sample string 2</Description>
    <EligibilityEndDate>2024-05-03T05:28:10.3580569+00:00</EligibilityEndDate>
    <EligibilityStartDate>2024-05-03T05:28:10.3580569+00:00</EligibilityStartDate>
    <Name>sample string 1</Name>
    <OneTimeUse>true</OneTimeUse>
    <Status>sample string 3</Status>
  </CouponConfigurationSummary>
  <CouponConfigurationSummary>
    <Id>6</Id>
    <Uri>sample string 7</Uri>
    <ApplyToAllPlans>true</ApplyToAllPlans>
    <CouponCodes>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
    </CouponCodes>
    <Description>sample string 2</Description>
    <EligibilityEndDate>2024-05-03T05:28:10.3580569+00:00</EligibilityEndDate>
    <EligibilityStartDate>2024-05-03T05:28:10.3580569+00:00</EligibilityStartDate>
    <Name>sample string 1</Name>
    <OneTimeUse>true</OneTimeUse>
    <Status>sample string 3</Status>
  </CouponConfigurationSummary>
  <CouponConfigurationSummary>
    <Id>6</Id>
    <Uri>sample string 7</Uri>
    <ApplyToAllPlans>true</ApplyToAllPlans>
    <CouponCodes>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
      <CouponCode>
        <Code>sample string 2</Code>
        <Id>1</Id>
        <RemainingUsages>1</RemainingUsages>
        <TimesUsed>3</TimesUsed>
      </CouponCode>
    </CouponCodes>
    <Description>sample string 2</Description>
    <EligibilityEndDate>2024-05-03T05:28:10.3580569+00:00</EligibilityEndDate>
    <EligibilityStartDate>2024-05-03T05:28:10.3580569+00:00</EligibilityStartDate>
    <Name>sample string 1</Name>
    <OneTimeUse>true</OneTimeUse>
    <Status>sample string 3</Status>
  </CouponConfigurationSummary>
</ArrayOfCouponConfigurationSummary>