{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"ee901c59-1aad-419d-8f23-da83fb760dcd","name":"Barcode API 2.0","description":"## [Coniq APIs Home](https://documenter.getpostman.com/view/4063684/RWaDWrYa) | [Platform API Home](https://documenter.getpostman.com/view/4580793/RWEgqyXv)\n\n# 1\\. Overview\n\nThis API allows clients to generate and retrieve barcodes programatically. Barcodes are not directly accessible through the platform user interface but represent the link between a Customer and an Offer that can be redeemed. Barcodes are typically generated on the submission of a sign-up form or when sending a Communication.\n\n# 2\\. General\n\nRefer to the main [Platform API 2.0](https://documenter.getpostman.com/view/4580793/RWEgqyXv) documentation for information about accessing the API including identification, authorization, security, requests, responses, versioning and testing.\n\n### Endpoints\n\nThere are two API endpoints available corresponding to two separate environments. The endpoint for the production environment is the endpoint that should be used for live integrations.\n\n[https://api.coniq.com/](https://api.coniq.com/)\n\nA sandbox environment is also available and can be used for development, testing and integration. The data is updated periodically based on the production environment. The same API key can be used in both environments.\n\n[https://api-stage.coniq.com/](https://api-stage.coniq.com/)\n\n## Version\n\nThese Customer API methods are available in version 2.0 and require the appropriate x-api-version header.\n\nx-api-version: 2.0\n\n# 3\\. Resource\n\n#### Barcode\n\nThe following fields are present on a Barcode resource. The fields marked as required must be included when creating a new offer. The fields marked as generated are managed by the system and cannot be modified. The fields marked as optional may omitted and may not be returned in the response.\n\n| Field | Optional | Type | Description |\n| --- | --- | --- | --- |\n| barcode_number | generated | string | the number represented in the barcode |\n| offer_id | required | integer | the id of the offer that the barcode is for; this can either be a specific offer or a loyalty program |\n| customer_id | required | integer | the id of the customer that the barcode was issued to |\n| channel | required | string | the channel that the barcode is distributed (PAPER, MAIL, SMS, MOBILE, ECOMMERCE) |\n| tracking_code | optional | string | a client supplied identified that can be used to track multiple barcodes sent through the same channel |\n| image_url | generated | string | url to an image representing the barcode |\n| active | generated | boolean | indicates if the barcode is active for loyalty programs that require activation |\n| expiry_date | generated | date | the date that the barcode expires if present in the barcode; this is determined by the offer settings when the barcode is generated |\n| created_datetime_utc | generated | datetime | the datetime that the barcode was generated |\n\n# 4\\. Methods\n\n| Resource | Method | URI | Description |\n| --- | --- | --- | --- |\n| barcode | GET | /barcode | Returns a list of barcodes matching the specified criteria |\n| barcode | POST | /barcode | Generates a barcode for an offer and customer |\n| barcode | POST | /barcode/batch | Generates up to 200 barcodes at one time |","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"4580793","collectionId":"ee901c59-1aad-419d-8f23-da83fb760dcd","publishedId":"RWEjnwt9","public":true,"publicUrl":"https://documenter-api.postman.tech/view/4580793/RWEjnwt9","privateUrl":"https://go.postman.co/documentation/4580793-ee901c59-1aad-419d-8f23-da83fb760dcd","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"documentationLayout":"classic-double-column","version":"8.10.0","publishDate":"2018-10-26T12:13:06.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[{"name":"Prod","id":"e5cbf78f-8d3a-401c-866b-21b0e7cceef5","owner":"4063684","values":[{"key":"platform-url","value":"https://platform.coniq.com","enabled":true},{"key":"api-url","value":"https://api.coniq.com","enabled":true},{"key":"platform-stage-url","value":"https://platform-stage.coniq.com","enabled":true},{"key":"api-stage-url","value":"https://api-stage.coniq.com","enabled":true},{"key":"platform-prod-url","value":"https://platform.coniq.com","enabled":true},{"key":"api-prod-url","value":"https://api.coniq.com","enabled":true},{"key":"signup-url","value":"https://poweredby.coniq.com","enabled":true},{"key":"signup-stage-url","value":"https://poweredby-stage.coniq.com","enabled":true},{"key":"handset-stage-url","value":"https://api-pre.get2d.com","enabled":true},{"key":"handset-url","value":"https://api.get2d.com","enabled":true},{"key":"app-level-token","value":"MGQzMTA3ZTg0OTllOWI1MDQyN2ZmNjI4YzM5MmM4Yjc2ZWMyMDI1MWQ3NWUyMWNmY2NmNDc5YTk4YjZhOTAwYQ","enabled":true},{"key":"customer-access-token","value":"","enabled":true,"type":"any"},{"key":"customer-refresh-token","value":"","enabled":true,"type":"any"},{"key":"customer-bearer-token","value":"","enabled":true,"type":"any"}],"published":true}],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/768118b36f06c94b0306958b980558e6915839447e859fe16906e29d683976f0","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"},{"label":"Prod","value":"4063684-e5cbf78f-8d3a-401c-866b-21b0e7cceef5"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/RWEjnwt9"}