Creates new coupon(s) that can be assigned to a member with the coupon-use service. This service will create the coupon request and generate the coupons.
", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "activateCoupons", "type": "boolean", "description": "When set to true all of the generated coupons will be activated", "default": false }, { "kind": "optional", "name": "useCoupons", "type": "boolean", "description": "When set to true, all generated coupons are marked as used. This requires activateCoupons to be enabled, the coupon request type to be Award, and a member identifier to be provided.
", "default": false }, { "kind": "optional", "name": "async", "type": "boolean", "description": "Submits the operation for background processing and returns a ‘202 Accepted’ response\nalong with an identifier to track the processing status.\nRequires the \"api:async-task
\" scope.", "default": false } ], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "Create coupon request object", "customType": "CouponRequest", "schema": [ { "name": "offerCode", "kind": "required", "type": "string", "description": "Code for the offer that contains the definition of this coupon. This defines the attributes available and required.", "example": "Offer12345", "maxLength": 50 }, { "name": "name", "kind": "required", "type": "string", "description": "Name of the coupon request", "maxLength": 300 }, { "name": "description", "kind": "optional", "type": "string", "description": "Description of the coupon request", "maxLength": 500 }, { "name": "expirationType", "kind": "optional", "type": "string", "description": "Expiration type for the coupon. Supported values are Exact, Never, Rolling. When Exact is set the startDate and expirationDate are required. If Rolling the expirationDayPeriod and expirationTimePeriod are required.
", "example": "Rolling", "default": "Rolling" }, { "name": "startDate", "kind": "optional", "type": "stringWhen expirationType=Exact this attribute identifies when the coupon expires.
", "format": "date" }, { "name": "expirationDayPeriod", "kind": "optional", "type": "integerWhen expirationType=Rolling this attribute identifies when the coupon expires after this many days.
", "example": 60, "format": "int32" }, { "name": "expirationTimePeriod", "kind": "optional", "type": "integerWhen expirationType=Rolling this attribute identifies when the coupon expires after this many hours in addition to the expirationDayPeriod days.
", "example": 60, "format": "int32" }, { "name": "useTypeCode", "kind": "optional", "type": "string", "description": "Coupon Use Type Code, one of Multi, Single
", "example": "Single", "default": "Single" }, { "name": "couponRequestType", "kind": "optional", "type": "string", "description": "Coupon Request Type: Award/Bulk
", "example": "Bulk", "default": "Bulk" }, { "name": "memberIdentifier", "kind": "optional", "type": "string", "description": "Awards new coupon(s) to this member, if activateCoupons is set and coupon request type is Award.
" }, { "name": "couponCount", "kind": "optional", "type": "integerValue for this attribute, validation rules are defined during offer setup.
", "example": 123, "maxLength": 50 } ] } ], "modelRef": "#/components/schemas/CouponRequest", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "See https://docs.wearephaedon.com/docs/platform-api-authentication
", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://phaedon.oktapreview.com/oauth2/auscfbbmieFBGGOzR1d7/v1/token", "scopes": { "api:custom-data:read": "Grants read access to custom data information", "api:custom-data:modify": "Grants modify access to custom data information", "api:data-codes:read": "Grants read access to data codes", "api:data-codes:modify": "Grants modify access to data codes", "api:coupon-compensation:read": "Grants read access to compensations for coupon code", "api:coupon-compensation:create": "Grants access to create compensations for coupon code", "api:coupon-compensation:modify": "Grants access to edit compensation nights for coupon code", "api:coupon-request:modify": "Grants modify access to create coupons", "api:member:search": "Grants search access to member information", "api:member:verify": "Grants verify access to member information", "api:member:merge": "Grants access to merge members", "api:member:enroll": "Grants access to enroll members", "api:member:modify": "Grants modify access to member information", "api:member:read": "Grants read access to member information", "api:member:close": "Grants access to close member account", "api:member:migrate": "Grants access to migrate member accounts", "api:member-address:read": "Grants read access to member address information", "api:member-address:modify": "Grants modify access to member address information", "api:member-alias:read": "Grants read access to member alias information", "api:member-alias:modify": "Grants modify access to member alias information", "api:member-badge:read": "Grants read access to member badge information", "api:member-badge:modify": "Grants modify access to member badge information", "api:member-bonus:add": "Grants access to add a bonus to a member", "api:member-bonus:read": "Grants read access to member bonus information", "api:member-comments:read": "Grants read access to member comments information", "api:member-comments:modify": "Grants modify access to member comments information", "api:member-communication:read": "Grants read access to member communication information", "api:member-communication:modify": "Grants modify access to member communication information", "api:member-coupon:read": "Grants read access to member coupon information", "api:member-coupon-use:cancel": "Grants access to cancel member coupon uses", "api:member-coupon:transfer": "Grants access to transfer a member coupon", "api:member-coupon-use:update": "Grants access to update member coupon uses", "api:member-currency:read": "Grants read access to member currency information", "api:member-currency:adjust": "Grants access to adjust member currency", "api:member-currency:migrate": "Grants access to migrate member currency", "api:member-currency-conversion:convert": "Grants access to convert member currency", "api:member-email:read": "Grants read access to member email information", "api:member-email:modify": "Grants modify access to member email information", "api:member-event:read": "Grants read access to member events", "api:member-event:modify": "Grants modify access to member events", "api:event-rule:read": "Grants read access to event rules", "api:event-rule:modify": "Grants access to modify event rule", "api:event-rule:admin": "Grants full admin access to event rules", "api:member-list:read": "Grants read access to member list information", "api:member-list:modify": "Grants modify access to member list information", "api:member-partner-link:read": "Grants read access to member partner link information", "api:member-partner-link:modify": "Grants modify access to member partner link information", "api:member-payment-card:read": "Grants read access to member payment card information", "api:member-payment-card:modify": "Grants modify access to member payment card information", "api:member-phone:read": "Grants read access to member phone information", "api:member-phone:modify": "Grants modify access to member phone information", "api:member-preference:read": "Grants read access to member preference information", "api:member-preference:modify": "Grants modify access to member preference information", "api:member-promotion:read": "Grants read access to member promotion information", "api:member-promotion:register": "Grants access to register a member into a promotion", "api:member-redemption:create": "Grants redeem access to member redemption information", "api:member-redemption:over-redeem": "Grants access to over redeem", "api:member-redemption:read": "Grants read access to member redemption information", "api:member-redemption:cancel": "Grants access to cancel member redemptions", "api:member-redemption:migrate": "Allows migration of member redemption information", "api:member-redemption:patch": "Grants patching access to member redemption", "api:member-tier:read": "Grants read access to member tier information", "api:member-tier:adjust": "Grants access to adjust member tiers", "api:member-tier:migrate": "Grants access to migrate member tiers", "api:member-transaction:read": "Grants read access to transaction information", "api:member-transaction:cancel": "Grants access to cancel transactions", "api:member-transaction:clone": "Grants access to clone transactions", "api:member-transfer:transfer": "Grants access to do member to member transfers", "api:preference:read": "Grants read access to preference information", "api:promotion:read": "Grants read access to promotion information", "api:tier:read": "Grant read access to tier information", "api:promotion:register": "Grants access to register a member into a promotion using token", "api:promotion-token:manage": "Grants access to generate promotion token", "api:redemption:read": "Grants read access to redemption information", "api:redemption:modify": "Grants access to modify redemption information", "api:bonus-rule:read": "Grants read access to bonus rule configuration", "api:bonus-rule:modify": "Grants access to modify bonus rule configuration", "api:bonus-rule:manage": "Grants limited admin access to bonus rule configuration", "api:bonus-rule:admin": "Grants full admin access to bonus rules", "api:promotion-rule:read": "Grants read access to promotion rule configuration", "api:promotion-rule:modify": "Grants access to modify promotion rule configuration", "api:promotion-rule:manage": "Grants limited admin access to promotion rule configuration", "api:promotion-rule:admin": "Grants full admin access to promotion rules", "api:reports:under-investigation": "Grants access to under investigation report", "api:transaction:submit": "Grants access to submit transactions", "api:transaction:migrate": "Grants access to migrate transactions", "api:user:read": "Grants access to read user information", "api:user:modify": "Grants access to create user", "api:user-task:read": "Grants read access to user tasks", "api:user-task:modify": "Grants modify access to user tasks", "api:user-role:read": "Grants read access to user roles", "api:user-role:modify": "Grants modify access to user roles", "api:compensation:read": "Grants read access to hotel summary information", "api:compensation:modify": "Grants modify access to hotel summary information", "api:member-referral:read": "Grants read access to member referral information", "api:member-referral:modify": "Grants modify access to member referral information", "api:member-referral-codes:read": "Grants read access to member referral codes", "api:member-referral-codes:create": "Grants access to create member referral codes", "api:outbound-notification:modify": "Grants access to send outbound notification", "api:outbound-notification:read": "Grants access to read outbound notification types", "api:background-task:read": "Grants read access to background task information", "api:async-task:create": "Grants access to submit operations for background processing", "api:async-task:read": "Grants read access to background processing results", "api:audit-configuration:read": "Grants read access to audit configuration information", "api:audit-configuration:modify": "Grants modify access to audit configuration information", "api:badge:read": "Grant read access to badge information", "api:broadcast-messages:read": "Grant Read access to broadcast messages", "api:expression-config:read": "Grant read access to expression builder configuration", "api:managed-entity:read": "Grant read access to managed entity data", "api:customer-satisfaction:modify": "Grants modify access to customer satisfaction metrics", "api:member-linked-account:modify": "Grant modify access to member linked account", "api:member-linked-account:read": "Grants access to read linked member accounts", "api:enroll-codes:read": "Grants access to read enroll codes", "api:contact-us:modify": "Grants access to submit Contact Us inquiry", "api:data-release:read": "Grants read access to data releases", "api:points-pool:read": "Grants read access to points pools", "api:points-pool:modify": "Grants modify access to points pools", "api:segment:read": "Grants read access to segments", "api:segment:modify": "Grants modify access to segments", "api:communication-type:read": "Grants read access to communication types", "api:communication-type:modify": "Grants modify access to communication types", "api:member-status-match:read": "Grants read access to status match eligibility and submitted images/applications", "api:member-status-match:create": "Grants access to upload status match images and submit applications" } } }, "requiredScopes": [ "api:coupon-request:modify" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Success", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Coupon[]", "schema": [ { "name": "couponId", "kind": "optional", "type": "integerCoupon Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "couponRequestId", "kind": "optional", "type": "integerOffer Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "offerTypeCode", "kind": "required", "type": "string", "description": "Offer Type Code", "example": "Discount" }, { "name": "code", "kind": "optional", "type": "string", "description": "External offer code. Provided by client during offer setup.", "example": "ALON2020" }, { "name": "name", "kind": "optional", "type": "string", "description": "Offer Name", "example": "Free night" }, { "name": "description", "kind": "optional", "type": "string", "description": "Offer Description", "example": "Award double points" }, { "name": "featureVersion", "kind": "optional", "type": "integerOffer Status Code, one of Enabled, Disabled
", "example": "Enabled" }, { "name": "startDateTime", "kind": "optional", "type": "stringIf includeOfferAttributes is true, Offer Attributes
", "modelRef": "#/components/schemas/OfferAttribute", "customType": "OfferAttribute[]", "schema": [ { "name": "offerAttributeId", "kind": "optional", "type": "integerOffer Attribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "attribute", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/Attribute", "customType": "Attribute", "schema": [ { "name": "attributeId", "kind": "optional", "type": "integerAttribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "typeCode", "kind": "required", "type": "string", "description": "Attribute Type Code, one of: Validation, Reporting
", "example": "Validation" }, { "name": "statusCode", "kind": "required", "type": "string", "description": "Attribute Status Code, one of: Enabled, Disabled
", "example": "Enabled" }, { "name": "name", "kind": "optional", "type": "string", "description": "Attribute Name", "example": "AccountNumber" }, { "name": "description", "kind": "optional", "type": "string", "description": "Attribute Description", "example": "Account Number" }, { "name": "dataTypeCode", "kind": "required", "type": "string", "description": "Attribute Data Type Code, one of: boolean, choice, date, memberAccount, multiselect, numeric, open
", "example": "open" } ] }, { "name": "defaultValue", "kind": "optional", "type": "string", "description": "Indicates what shall be used if no other value is supplied", "example": "Standard" }, { "name": "requireOnUse", "kind": "optional", "type": "boolean", "description": "Indicates if presence of attribute is required for coupon use operation", "example": true }, { "name": "requireOnHold", "kind": "optional", "type": "boolean", "description": "Indicates if presence of attribute is required for coupon hold operation", "example": true }, { "name": "includeOnResponse", "kind": "optional", "type": "boolean", "description": "If true: The system will include this Attribute and Value on Coupon Use or Validation response
", "example": false }, { "name": "attributeTypeCode", "kind": "optional", "type": "string", "description": "Attribute Type Code, one of: Validation, Reporting
", "example": "Validation" }, { "name": "operatorCode", "kind": "optional", "type": "string", "description": "Attribute operator code. Examples: EQ, NEQ, LT, LTE, GT, GTE
", "example": "EQ" }, { "name": "operand", "kind": "optional", "type": "string", "description": "Value that operator applies to", "example": "GI" }, { "name": "smartGroupId", "kind": "optional", "type": "integerBenefit configuration on the offer. Only populated when includeBenefits=true.
", "modelRef": "#/components/schemas/CouponBenefits", "customType": "CouponBenefits", "schema": [ { "name": "tierCode", "kind": "optional", "type": "string", "description": "Result tier code awarded at time of coupon use", "example": "Gold", "maxLength": 50 }, { "name": "futureTierCode", "kind": "optional", "type": "string", "description": "Future result tier code awarded at time of coupon use", "example": "Platinum", "maxLength": 50 }, { "name": "bonusCode", "kind": "optional", "type": "string", "description": "Bonus rule code awarded at time of coupon use", "example": "STAY_BONUS", "maxLength": 50 }, { "name": "redemption", "kind": "optional", "type": "object", "description": "Redemption benefit awarded at time of coupon use", "modelRef": "#/components/schemas/CouponBenefitsRedemption", "customType": "CouponBenefitsRedemption", "schema": [ { "name": "ruleCode", "kind": "optional", "type": "string", "description": "Redemption rule code awarded at time of coupon use", "example": "ITEM1", "maxLength": 50 }, { "name": "quantity", "kind": "optional", "type": "integerCoupon Status Code, one of Activated, Cancelled, Inactive, Terminated
", "example": "Activated" }, { "name": "startDate", "kind": "optional", "type": "stringCoupon Use Type Code, one of Multi, Single
", "example": "Single", "default": "Single" }, { "name": "useLimit", "kind": "optional", "type": "integerIf includeUses is true, the uses of the coupon. This is only populated after a coupon has been applied to a member
", "modelRef": "#/components/schemas/CouponUse", "customType": "CouponUse[]", "schema": [ { "name": "useDateTime", "kind": "optional", "type": "stringCoupon Use status code, one of: Released, Returned, Used
", "example": "Used" }, { "name": "channelCode", "kind": "required", "type": "string", "description": "Coupon Use channel code, one of: CallCenter, System
", "example": "System" }, { "name": "alias", "kind": "optional", "type": "string", "description": "Alias of a coupon use as unique key for a given coupon. Operationally used to check for duplicate holds." }, { "name": "useCount", "kind": "required", "type": "integerIf includeAttributes is true, Coupon Use Attributes
", "modelRef": "#/components/schemas/CouponUseAttribute", "customType": "CouponUseAttribute[]", "schema": [ { "name": "couponUseAttributeId", "kind": "optional", "type": "integerCoupon Use Attribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "attribute", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/Attribute", "customType": "Attribute", "schema": [ { "name": "attributeId", "kind": "optional", "type": "integerAttribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "typeCode", "kind": "required", "type": "string", "description": "Attribute Type Code, one of: Validation, Reporting
", "example": "Validation" }, { "name": "statusCode", "kind": "required", "type": "string", "description": "Attribute Status Code, one of: Enabled, Disabled
", "example": "Enabled" }, { "name": "name", "kind": "optional", "type": "string", "description": "Attribute Name", "example": "AccountNumber" }, { "name": "description", "kind": "optional", "type": "string", "description": "Attribute Description", "example": "Account Number" }, { "name": "dataTypeCode", "kind": "required", "type": "string", "description": "Attribute Data Type Code, one of: boolean, choice, date, memberAccount, multiselect, numeric, open
", "example": "open" } ] }, { "name": "value", "kind": "optional", "type": "string", "description": "Value associated with the attribute", "example": "Standard" } ] } ] }, { "name": "couponAttributes", "kind": "optional", "type": "array", "description": "If includeAttributes is true, Coupon Attributes
", "modelRef": "#/components/schemas/CouponAttribute", "customType": "CouponAttribute[]", "schema": [ { "name": "couponAttributeId", "kind": "optional", "type": "integerCoupon Attribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "attribute", "kind": "required", "type": "object", "description": "", "modelRef": "#/components/schemas/Attribute", "customType": "Attribute", "schema": [ { "name": "attributeId", "kind": "optional", "type": "integerAttribute Id (null on create requests)
", "example": 147258369, "format": "int64" }, { "name": "typeCode", "kind": "required", "type": "string", "description": "Attribute Type Code, one of: Validation, Reporting
", "example": "Validation" }, { "name": "statusCode", "kind": "required", "type": "string", "description": "Attribute Status Code, one of: Enabled, Disabled
", "example": "Enabled" }, { "name": "name", "kind": "optional", "type": "string", "description": "Attribute Name", "example": "AccountNumber" }, { "name": "description", "kind": "optional", "type": "string", "description": "Attribute Description", "example": "Account Number" }, { "name": "dataTypeCode", "kind": "required", "type": "string", "description": "Attribute Data Type Code, one of: boolean, choice, date, memberAccount, multiselect, numeric, open
", "example": "open" } ] }, { "name": "value", "kind": "optional", "type": "string", "description": "Value associated with the attribute", "example": "2021-12-31T12:00:00" }, { "name": "requireOnUse", "kind": "optional", "type": "boolean", "readOnly": true, "description": "When using the coupon, a value is required for the attribute
", "example": true }, { "name": "requireOnHold", "kind": "optional", "type": "boolean", "readOnly": true, "description": "When putting the coupon on hold, a value is required for the attribute
", "example": false } ] } ], "modelRef": "#/components/schemas/Coupon", "isExpanded": true } ] }, { "statusCode": "202", "description": "Accepted", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "AsyncTask", "schema": [ { "name": "asyncTaskId", "kind": "optional", "type": "integerExecution status of async task, one of: queued, processed, error
" }, { "name": "responseDate", "kind": "optional", "type": "stringName of field that violated validation constraint (optional)
" }, { "name": "message", "kind": "optional", "type": "string", "description": "Internal message describing the error" }, { "name": "messageParameters", "kind": "optional", "type": "array", "description": "Error message parameters", "example": "", "itemType": "object", "customType": "object[]", "schema": [] } ] } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "500", "description": "Internal error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "BXBSirDNYEeqzIHedfgBw", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url 'https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean' \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"offerCode\": \"Offer12345\",\n \"name\": \"\",\n \"expirationType\": \"Rolling\",\n \"useTypeCode\": \"Single\",\n \"couponRequestType\": \"Bulk\",\n \"couponCount\": 1,\n \"attributes\": [\n {\n \"name\": \"site_tier\",\n \"value\": 123\n }\n ]\n }'" }, { "id": "TP4gIhJxxcbIB5NTu8rR9", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"offerCode\": \"Offer12345\",\n \"name\": \"\",\n \"expirationType\": \"Rolling\",\n \"useTypeCode\": \"Single\",\n \"couponRequestType\": \"Bulk\",\n \"couponCount\": 1,\n \"attributes\": [\n {\n \"name\": \"site_tier\",\n \"value\": 123\n }\n ]\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "EExbOv1LT36hPGMPP_32o", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean\"\n\npayload = json.dumps({\n \"offerCode\": \"Offer12345\",\n \"name\": \"\",\n \"expirationType\": \"Rolling\",\n \"useTypeCode\": \"Single\",\n \"couponRequestType\": \"Bulk\",\n \"couponCount\": 1,\n \"attributes\": [\n {\n \"name\": \"site_tier\",\n \"value\": 123\n }\n ]\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" }, { "id": "X-dsuch7bVBGpxELuJy-y", "language": "java", "label": "Java", "code": "OkHttpClient client = new OkHttpClient().newBuilder()\n .build();\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(mediaType, \"{\\n \\\"offerCode\\\": \\\"Offer12345\\\",\\n \\\"name\\\": \\\"\\\",\\n \\\"expirationType\\\": \\\"Rolling\\\",\\n \\\"useTypeCode\\\": \\\"Single\\\",\\n \\\"couponRequestType\\\": \\\"Bulk\\\",\\n \\\"couponCount\\\": 1,\\n \\\"attributes\\\": [\\n {\\n \\\"name\\\": \\\"site_tier\\\",\\n \\\"value\\\": 123\\n }\\n ]\\n}\");\nRequest request = new Request.Builder()\n .url(\"https://api.b.preview.loyaltyservices.io/api/v3/coupon-requests?activateCoupons=boolean&useCoupons=boolean&async=boolean\")\n .method(\"POST\", body)\n .addHeader(\"accept\", \"application/json\")\n .addHeader(\"content-type\", \"application/json\")\n .build();\nResponse response = client.newCall(request).execute();" } ], "selectedLanguageId": "BXBSirDNYEeqzIHedfgBw" }, "results": { "languages": [ { "id": "1QGpIWy9ukw8czwIkNUTn", "language": "200", "code": "// Success\n[\n {\n \"couponId\": 147258369,\n \"couponRequestId\": 147258370,\n \"offer\": {\n \"offerId\": 147258369,\n \"offerTypeCode\": \"Discount\",\n \"code\": \"ALON2020\",\n \"name\": \"Free night\",\n \"description\": \"Award double points\",\n \"featureVersion\": 2,\n \"statusCode\": \"Enabled\",\n \"startDateTime\": \"\",\n \"endDateTime\": \"\",\n \"offerAttributes\": [\n {\n \"offerAttributeId\": 147258369,\n \"attribute\": {\n \"attributeId\": 147258369,\n \"typeCode\": \"Validation\",\n \"statusCode\": \"Enabled\",\n \"name\": \"AccountNumber\",\n \"description\": \"Account Number\",\n \"dataTypeCode\": \"open\"\n },\n \"defaultValue\": \"Standard\",\n \"requireOnUse\": true,\n \"requireOnHold\": true,\n \"includeOnResponse\": false,\n \"attributeTypeCode\": \"Validation\",\n \"operatorCode\": \"EQ\",\n \"operand\": \"GI\",\n \"smartGroupId\": 147258369\n }\n ],\n \"benefits\": {\n \"tierCode\": \"Gold\",\n \"futureTierCode\": \"Platinum\",\n \"bonusCode\": \"STAY_BONUS\",\n \"redemption\": {\n \"ruleCode\": \"ITEM1\",\n \"quantity\": 1\n }\n }\n },\n \"code\": \"ZPVWTAROW2OQ\",\n \"statusCode\": \"Activated\",\n \"startDate\": \"\",\n \"endDate\": \"\",\n \"useTypeCode\": \"Single\",\n \"useLimit\": 1,\n \"currentUse\": 1,\n \"couponUses\": [\n {\n \"useDateTime\": \"\",\n \"statusCode\": \"Used\",\n \"channelCode\": \"System\",\n \"alias\": \"\",\n \"useCount\": 1,\n \"couponUseAttributes\": [\n {\n \"couponUseAttributeId\": 147258369,\n \"attribute\": {\n \"attributeId\": 147258369,\n \"typeCode\": \"Validation\",\n \"statusCode\": \"Enabled\",\n \"name\": \"AccountNumber\",\n \"description\": \"Account Number\",\n \"dataTypeCode\": \"open\"\n },\n \"value\": \"Standard\"\n }\n ]\n }\n ],\n \"couponAttributes\": [\n {\n \"couponAttributeId\": 147258369,\n \"attribute\": {\n \"attributeId\": 147258369,\n \"typeCode\": \"Validation\",\n \"statusCode\": \"Enabled\",\n \"name\": \"AccountNumber\",\n \"description\": \"Account Number\",\n \"dataTypeCode\": \"open\"\n },\n \"value\": \"2021-12-31T12:00:00\",\n \"requireOnUse\": true,\n \"requireOnHold\": false\n }\n ]\n }\n]" }, { "id": "b-UY7GKbpZTDb4QlnmNPY", "language": "202", "code": "// Accepted\n{\n \"asyncTaskId\": \"\",\n \"taskTypeCode\": \"PlatformAPI\",\n \"taskCode\": \"enrollMember\",\n \"requestDate\": \"\",\n \"requestData\": {},\n \"statusCode\": \"\",\n \"responseDate\": \"\",\n \"responseData\": {},\n \"fileName\": \"\",\n \"lineNumber\": 0,\n \"fileData\": \"\"\n}" }, { "id": "gk5YcqijZjO9fw-iiuEFb", "language": "400", "code": "// Bad request\n{\n \"errors\": [\n {\n \"code\": \"\",\n \"fieldName\": \"\",\n \"message\": \"\",\n \"messageParameters\": [\n {}\n ]\n }\n ]\n}" }, { "id": "ajG1WckKwpFCUBNdgbbrs", "language": "401", "code": "// Unauthorized\n" }, { "id": "PD67gMVIdc4w189psAlWl", "language": "403", "code": "// Forbidden\n" }, { "id": "lmpCgN84QyaZsA3kkNozm", "language": "500", "code": "// Internal error\n" } ], "selectedLanguageId": "1QGpIWy9ukw8czwIkNUTn" } }, "children": [ { "text": "" } ] }