POST v1/Coupons
Documentation for 'Post'.
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
entity | Documentation for 'entity'. |
Define this parameter in the request body. |
Request body formats
application/json, text/json
Sample:
Click to beautify!
{ "name": "sample string 1", "description": "sample string 2", "applyToAllPlans": true, "couponCodes": [ { "code": "sample string 1", "remainingUsages": 1 }, { "code": "sample string 1", "remainingUsages": 1 }, { "code": "sample string 1", "remainingUsages": 1 } ], "discounts": [ 1, 2, 3 ], "plans": [ { "id": 1, "applyToAllProducts": true, "planProducts": [ 1, 2, 3 ] }, { "id": 1, "applyToAllProducts": true, "planProducts": [ 1, 2, 3 ] }, { "id": 1, "applyToAllProducts": true, "planProducts": [ 1, 2, 3 ] } ], "eligibilities": [ { "startDate": "2024-05-03T06:11:39.2065525+00:00", "endDate": "2024-05-03T06:11:39.2065525+00:00", "discounts": [ 1, 2, 3 ] }, { "startDate": "2024-05-03T06:11:39.2065525+00:00", "endDate": "2024-05-03T06:11:39.2065525+00:00", "discounts": [ 1, 2, 3 ] }, { "startDate": "2024-05-03T06:11:39.2065525+00:00", "endDate": "2024-05-03T06:11:39.2065525+00:00", "discounts": [ 1, 2, 3 ] } ], "oneTimeUse": true }
application/xml
Sample:
Click to beautify!
Sample not available.
text/xml
Sample:
Click to beautify!
Sample not available.
application/x-www-form-urlencoded
Sample:
Click to beautify!
Sample not available.
Response Information
Response body formats
application/json, text/json
Sample:
Click to beautify!
{ "discounts": [ { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" } ], "eligibilities": [ { "startDate": "2024-05-03T06:11:39.2377856+00:00", "endDate": "2024-05-03T06:11:39.2377856+00:00", "discounts": [ { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" } ] }, { "startDate": "2024-05-03T06:11:39.2377856+00:00", "endDate": "2024-05-03T06:11:39.2377856+00:00", "discounts": [ { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" } ] }, { "startDate": "2024-05-03T06:11:39.2377856+00:00", "endDate": "2024-05-03T06:11:39.2377856+00:00", "discounts": [ { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" }, { "id": 1, "uri": "sample string 2" } ] } ], "plans": [ { "applyToAllProducts": true, "planProducts": [ { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" }, { "applyToAllProducts": true, "planProducts": [ { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" }, { "applyToAllProducts": true, "planProducts": [ { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" }, { "planProductId": 1, "id": 2, "uri": "sample string 3" } ], "id": 2, "uri": "sample string 3" } ], "name": "sample string 1", "description": "sample string 2", "eligibilityStartDate": "2024-05-03T06:11:39.2377856+00:00", "eligibilityEndDate": "2024-05-03T06:11:39.2377856+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!
<CouponConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Common.Dto.Get"> <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-03T06:11:39.2377856+00:00</EligibilityEndDate> <EligibilityStartDate>2024-05-03T06:11:39.2377856+00:00</EligibilityStartDate> <Name>sample string 1</Name> <OneTimeUse>true</OneTimeUse> <Status>sample string 3</Status> <Discounts> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> </Discounts> <Eligibilities> <CouponEligibility> <Discounts> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> </Discounts> <EndDate>2024-05-03T06:11:39.2377856+00:00</EndDate> <StartDate>2024-05-03T06:11:39.2377856+00:00</StartDate> </CouponEligibility> <CouponEligibility> <Discounts> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> </Discounts> <EndDate>2024-05-03T06:11:39.2377856+00:00</EndDate> <StartDate>2024-05-03T06:11:39.2377856+00:00</StartDate> </CouponEligibility> <CouponEligibility> <Discounts> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> <BaseDto> <Id>1</Id> <Uri>sample string 2</Uri> </BaseDto> </Discounts> <EndDate>2024-05-03T06:11:39.2377856+00:00</EndDate> <StartDate>2024-05-03T06:11:39.2377856+00:00</StartDate> </CouponEligibility> </Eligibilities> <Plans> <CouponPlanConfiguration> <Id>2</Id> <Uri>sample string 3</Uri> <ApplyToAllProducts>true</ApplyToAllProducts> <PlanProducts> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> </PlanProducts> </CouponPlanConfiguration> <CouponPlanConfiguration> <Id>2</Id> <Uri>sample string 3</Uri> <ApplyToAllProducts>true</ApplyToAllProducts> <PlanProducts> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> </PlanProducts> </CouponPlanConfiguration> <CouponPlanConfiguration> <Id>2</Id> <Uri>sample string 3</Uri> <ApplyToAllProducts>true</ApplyToAllProducts> <PlanProducts> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> <CouponPlanProduct> <Id>2</Id> <Uri>sample string 3</Uri> <PlanProductId>1</PlanProductId> </CouponPlanProduct> </PlanProducts> </CouponPlanConfiguration> </Plans> </CouponConfiguration>