Get detailed information about all unassigned coupon codes. You can limit the maximum number of retrieved coupon codes and sort the result by specific criteria. To get information about all assigned and/or used coupon codes, filter by recipient ID or mailing ID.
", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "clientId", "type": "integerStarting point of the result list Default value : 0
", "format": "int32" }, { "kind": "optional", "name": "limit", "type": "integerMaximum number of retrieved coupon codes Default value : 100
", "format": "int32" }, { "kind": "optional", "name": "codeAssignment", "type": "string", "description": "The status of the coupon codes to be filtered. Possible values are: assigned, unassigned, all
", "enum": [ "ASSIGNED", "UNASSIGNED", "ALL" ] }, { "kind": "optional", "name": "mailingId", "type": "integerThe coupon codes were retrieved successfully (empty result if none was found).
", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "RestCouponCodeStreamingCollection", "schema": [ { "name": "elements", "kind": "optional", "type": "array", "description": "", "modelRef": "#/components/schemas/RestCouponCode", "customType": "RestCouponCode[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Coupon code" }, { "name": "assignedMailing", "kind": "optional", "type": "integerIf true, the code of the coupon block is assigned to a mailing
" }, { "name": "used", "kind": "optional", "type": "boolean", "description": "If true, the code of the coupon block was used
" }, { "name": "created", "kind": "optional", "type": "stringThe \"codeAssignment\" parameter is provided simultaneously with the \"mailingId\" or the \"recipientId\", or the limit parameter is invalid. Change the limit to less than 10000.
", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "The coupon block could not be found. Ensure that the required parameters such as \"couponBlockId\" are correct and the coupon block exists.", "jsonExample": "", "isExpanded": true }, { "statusCode": "409", "description": "The coupon block is not assigned to the indicated client. Ensure that \"clientId\" and \"couponBlockId\" are correct and that the \"couponBlockId\" is assigned to the indicated client.", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "3GWQZFvbIP-5MvRn_vTZx", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.campaign.episerver.net/rest/{clientId}/couponblocks/{couponBlockId}/codes \\\n --header 'accept: application/json'" }, { "id": "NT4g6yOjRWV7RRgL_MGmo", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.campaign.episerver.net/rest/{clientId}/couponblocks/{couponBlockId}/codes\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "358UgbMKvCrbFvKxZvv8W", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.campaign.episerver.net/rest/{clientId}/couponblocks/{couponBlockId}/codes\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "2cseYJ9nSMQ_2uLqY2Syx", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.campaign.episerver.net/rest/{clientId}/couponblocks/{couponBlockId}/codes\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "3GWQZFvbIP-5MvRn_vTZx" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// The coupon codes were retrieved successfully (empty result if none was found).\n{\n \"elements\": [\n {\n \"code\": \"\",\n \"assignedMailing\": \"\",\n \"assignedRecipient\": \"\",\n \"assigned\": false,\n \"used\": false,\n \"created\": \"\",\n \"modified\": \"\",\n \"links\": [\n {\n \"uriBuilder\": {},\n \"rels\": [\n \"\"\n ],\n \"rel\": \"\",\n \"type\": \"\",\n \"params\": \"\",\n \"title\": \"\",\n \"uri\": \"\"\n }\n ]\n }\n ],\n \"count\": \"\",\n \"offset\": \"\",\n \"limit\": \"\"\n}" }, { "id": "response-1-400", "language": "400", "code": "// The \"codeAssignment\" parameter is provided simultaneously with the \"mailingId\" or the \"recipientId\", or the limit parameter is invalid. Change the limit to less than 10000.\n" }, { "id": "response-2-404", "language": "404", "code": "// The coupon block could not be found. Ensure that the required parameters such as \"couponBlockId\" are correct and the coupon block exists.\n" }, { "id": "response-3-409", "language": "409", "code": "// The coupon block is not assigned to the indicated client. Ensure that \"clientId\" and \"couponBlockId\" are correct and that the \"couponBlockId\" is assigned to the indicated client.\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }