{"_id":"595ba3bb9ec1a2001512ab73","type":"basic","category":"595ba3bb9ec1a2001512ab6b","createdAt":"2016-01-20T12:34:58.042Z","githubsync":"","project":"569f7ef06c5c930d007e22bd","title":"Intro","body":"**Glownet API** is designed for our partners to directly integrate with Glownet systems to automate and enhance the event experience and avoid manual data transfers and suboptimal waiting experience for customers. \n\nWe look forward to support you as a Glownet official partner!","hidden":false,"order":0,"sync_unique":"","updates":["56b326c4b008aa1900ab1653","56b3271ce373380d0066d965"],"user":"569f7028359efe0d006a71e1","__v":12,"link_external":false,"link_url":"","parentDoc":null,"slug":"getting-started","version":"595ba3bb9ec1a2001512ab8f","api":{"settings":"","url":"","apiSetting":null,"auth":"required","params":[],"results":{"codes":[]}},"excerpt":"","isReference":false,"updatedAt":"2019-09-24T13:37:31.116Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Intro
{"_id":"595ba3bb9ec1a2001512ab87","next":{"description":"","pages":[]},"parentDoc":null,"user":"569f9ac2daf2d417000c72d2","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6b","isReference":false,"link_url":"","link_external":false,"updates":[],"api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get"},"hidden":false,"type":"basic","createdAt":"2016-04-21T15:47:03.453Z","githubsync":"","slug":"how-to-get-started","order":1,"project":"569f7ef06c5c930d007e22bd","sync_unique":"","title":"How to get started","__v":7,"body":"**1. Get sandbox access**\nCreate an account here https://sandbox.glownet.com/admins/users/new\n\n**2. Practice with sandbox**\nRun your code against Glownet Sandbox server as long as you need to get everything working smooth!\n\n**3. Provide feedback / ask questions**\nFeel free to email us at api@glownet.com with questions as you go!\n\nPlease, tell us your integration use cases for the API and what enhancements and features will make it easier for you! We are constantly evolving our codebase and your suggestions might be implemented soon.\n\n**4. Become an official integration partner**\nIn order for your integration to work with Glownet Production systems for a live event, you should sign up as an official integration partner. Please talk to your Glownet contact or email us at api@glownet.com to sign up!\n\nIf you have signed up as a Glownet integration partner we will keep you updated as we release future versions of this API.","excerpt":"","updatedAt":"2019-09-24T13:37:31.117Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
How to get started
{"_id":"595ba3bb9ec1a2001512ab82","version":"595ba3bb9ec1a2001512ab8f","link_external":false,"link_url":"","parentDoc":null,"updates":[],"title":"Authentication","body":"As API user in the system, you need to add an HTTP Header in all your requests with key **Authorization** and value **Token token=<*access_token*>** \n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/8bb3730-Captura_de_pantalla_2019-09-24_a_las_12.40.30.png\",\n \"Captura de pantalla 2019-09-24 a las 12.40.30.png\",\n 1782,\n 594,\n \"#f8f8f8\"\n ]\n }\n ]\n}\n[/block]\nYou can find your user API *access_token* on your profile page in our Admin Panel.\n[block:image]\n{\n \"images\": [\n {\n \"image\": [\n \"https://files.readme.io/c40e68d-Captura_de_pantalla_2019-09-24_a_las_12.42.34.png\",\n \"Captura de pantalla 2019-09-24 a las 12.42.34.png\",\n 2876,\n 866,\n \"#dfc8c9\"\n ]\n }\n ]\n}\n[/block]","createdAt":"2016-02-16T09:30:36.703Z","hidden":false,"order":2,"sync_unique":"","user":"55b7428b31bccb190081bec5","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","apiSetting":null,"auth":"required","method":"get"},"category":"595ba3bb9ec1a2001512ab6b","excerpt":"How to authenticate to Glownet's API","project":"569f7ef06c5c930d007e22bd","type":"basic","__v":11,"githubsync":"","isReference":false,"slug":"authentication","next":{"pages":[],"description":""},"updatedAt":"2019-09-24T13:37:31.117Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Authentication
How to authenticate to Glownet's API
{"_id":"595ba3bb9ec1a2001512ab89","excerpt":"","order":3,"sync_unique":"","title":"Integration Guidance","version":"595ba3bb9ec1a2001512ab8f","__v":2,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","apiSetting":null,"auth":"required","params":[]},"next":{"pages":[],"description":""},"parentDoc":null,"project":"569f7ef06c5c930d007e22bd","slug":"integration-approaches","type":"basic","updates":[],"body":"Here is a number of integration approaches you can use for the Glownet API for Ticketing and Accreditation partners\n\n\n## Real time Integration\nIn this case your system is using Glownet API to post new tickets as they are being sold / issued.\n\n**Recommended minimum**\n- Configure the Glownet API authentication for the event at hand\n- Each time a new *ticket type* is created / edited, notify the Glownet API and store the returned ticket_type_id value\n- Each time a ticket is sold / issued, send it to Glownet API\n*we highly recommend to use asynchronous processing using a queue with job processing so that notification of Glownet API and its latency does not affect or slow down your customer experience\n\n\n**Further automation you might want to add**\n- Each time a ticket is cancelled, blacklist it via Glownet API so that it cannot be used\n- Add Glownet API credentials configuration to your admin panel so that all of your events can benefit from the integration without custom code\n\n\n\n## Regular / Once a day upload\n\nIn this case you regularly run a scheduled script to post the updates to the Glownet system.\n\n**Recommended steps for the script**\n- Authenticate with a given event\n- Post/update the ticket types and receive the ticket_type_id in relation to your system ticket types\n- Post all the tickets that were not yet submitted in the past\n- Mark the tickets that were sent as submitted in your system / config table\n\nIn this scenario we recommend to use the /tickets/bulk_upload API so that you can submit all tickets as one JSON request rather than make a separate API call for each ticket.","createdAt":"2016-05-04T15:01:36.911Z","user":"569f9ac2daf2d417000c72d2","category":"595ba3bb9ec1a2001512ab6b","githubsync":"","isReference":false,"link_external":false,"link_url":"","hidden":false,"updatedAt":"2019-09-24T13:37:31.118Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Integration Guidance
{"_id":"5ad4c016428a450003b75992","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6b","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-04-16T15:24:06.972Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":4,"body":"By default, Glownet places a rate limit on API calls for all apps. The default limit is 7000 calls per minute.\n\nIf your application requires a rate limit higher than 7,000, please email api@glownet.com with your client key and include details on why it is necessary for your application to make a higher number of API calls.\n\nFor security and integrity purposes (ours and yours) Glownet will not remove the rate limit for any application.","excerpt":"","slug":"rate-limit","type":"basic","title":"Rate Limit","__v":0,"parentDoc":null,"updatedAt":"2019-09-24T13:37:48.424Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Rate Limit
{"_id":"595ba3bb9ec1a2001512ab8c","link_external":false,"order":5,"slug":"ticketing-api","version":"595ba3bb9ec1a2001512ab8f","__v":0,"createdAt":"2017-01-20T13:20:40.240Z","isReference":false,"type":"basic","parentDoc":null,"title":"Ticketing API","updates":[],"user":"569f9ac2daf2d417000c72d2","category":"595ba3bb9ec1a2001512ab6b","link_url":"","body":"The first version of the API is oriented for our **Ticketing partners**. It allows a partner to submit new ticket purchases / accreditations done in their systems to Glownet.\n\n## Experiences for guests enabled by the integration \n* Purchase a ticket from the ticketing company and immediately login to the festival Customer Portal provided by Glownet to make a pre-event online topup and personalise the experience\n* Purchase a ticket from the ticketing company on the day of the event and enter through the gates a few seconds later\n* Receive a guest list QR code accreditation email that was just created by the festival manager in the festival's ticketing system and enter directly through the gates a few seconds later","excerpt":"","githubsync":"","hidden":false,"next":{"description":"","pages":[]},"project":"569f7ef06c5c930d007e22bd","api":{"url":"","apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"sync_unique":"","updatedAt":"2019-09-24T13:37:31.119Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Ticketing API
{"_id":"59f6fc7027b9410024d0d6b1","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6b","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-30T10:18:24.199Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":6,"body":"Beside the ticketing API there is more resources for you to use:\n* Tags management\n* Orders\n* Customers and their actions\n* Products\n* Stations\n* Companies\n* Refunds\n\nPlease check http://api.glownet.com/v2/reference for more information!","excerpt":"","slug":"other-apis","type":"basic","title":"Other APIs","__v":0,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.119Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Other APIs
{"_id":"595ba3bb9ec1a2001512ab88","createdAt":"2016-05-04T14:22:11.352Z","githubsync":"","hidden":false,"next":{"description":"","pages":[]},"slug":"ticketing-integration","sync_unique":"","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"category":"595ba3bb9ec1a2001512ab6b","excerpt":"","order":7,"parentDoc":null,"title":"Integration Timing","type":"basic","user":"569f9ac2daf2d417000c72d2","__v":7,"isReference":false,"link_external":false,"updates":[],"body":"Tickets can be submitted to Glownet API once / in regular intervals or in real time.\n\n## Availability of benefits depending on integration type\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Benefits\",\n \"h-1\": \"Once / Once a day\",\n \"h-2\": \"Every 1-5 minutes\",\n \"h-3\": \"Real Time\",\n \"0-0\": \"reduce the workload of passing around CSV / Excel files with ticketing data\",\n \"0-1\": \"YES\",\n \"0-2\": \"YES\",\n \"0-3\": \"YES\",\n \"1-0\": \"remove the risk of human error while moving the ticketing data manually between the systems\",\n \"1-1\": \"YES\",\n \"1-2\": \"YES\",\n \"1-3\": \"YES\",\n \"2-0\": \"remove security risk of moving the ticketing data manually between the systems\",\n \"2-1\": \"YES\",\n \"2-3\": \"YES\",\n \"2-2\": \"YES\",\n \"3-0\": \"offer online topups via Glownet Portal\",\n \"3-1\": \"**NO** \",\n \"3-2\": \"YES\",\n \"3-3\": \"YES\",\n \"4-0\": \"never stop selling tickets online during the event\",\n \"4-1\": \"**Limited***\",\n \"4-2\": \"YES\",\n \"4-3\": \"YES\"\n },\n \"cols\": 4,\n \"rows\": 5\n}\n[/block]\n*Only possible if the upload is done once a day and tickets on sale are only for the future days","link_url":"","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.120Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Integration Timing
{"_id":"595ba3bb9ec1a2001512ab8e","__v":0,"link_external":false,"order":8,"updates":[],"api":{"auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","apiSetting":null},"body":"## What happens if I submit the same exact ticket more than once?\nGlownet system will ignore duplicate uploads based on already existing barcode number within the event. So there is no risk to corrupt the info if you do that.\n\nHowever you must avoid sending a 1000s of tickets over and over again every 5 minutes for the purpose of managing the performance of your integration.\n\n\n## Can I submit new tickets sold every 30 minutes and offer online topups?\nNot during the period when online topups are open. Because customers will often proceed to purchase the online topup after they receive the ticket and check the cashless instructions of the event. We recommend uploading new tickets not less frequently than every 5 min if online topups are offered.\n\n\n## Is there any difference between POST /tickets and POST /tickets/bulk_upload?\nThe only difference is that the latter allows you to submit several tickets as a part of one request instead of submitting them one by one. Both API endpoints work exactly the same in all other aspects. And are processed asynchronously in near real time by the Glownet system.\n\n\n## What time does a newly submitted ticket take before appearing in the Glownet system?\nGlownet API asynchronously processes new tickets submissions as they happen. Typically a new ticket will be available on the Glownet system within a few seconds after submission. However during rare very high load periods, this might be delayed to a few minutes.\n\nOnce the ticket is in the Glownet system it becomes available for all Glownet online Check-in devices for scanning on entry. Within several minutes, an offline backup copy is also saved on all devices to protect the gates operation from temporary network failures.","category":"595ba3bb9ec1a2001512ab6b","parentDoc":null,"project":"569f7ef06c5c930d007e22bd","sync_unique":"","title":"Frequent questions","version":"595ba3bb9ec1a2001512ab8f","createdAt":"2017-01-20T13:29:55.879Z","githubsync":"","hidden":false,"link_url":"","next":{"pages":[],"description":""},"slug":"frequent-questions","type":"basic","excerpt":"","isReference":false,"user":"569f9ac2daf2d417000c72d2","updatedAt":"2019-09-24T13:37:31.120Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
Frequent questions
{"_id":"595cfa00d4bc0f0033d1e650","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595cf6c4175e75003de3ecb6","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T14:38:56.608Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n [\n {\n \"id\": 1,\n \"name\": \"Main\",\n \"mode\": \"permanent\"\n },\n {\n \"id\": 2,\n \"name\": \"VIP\",\n \"mode\": \"permanent\"\n },\n {\n \"id\": 3,\n \"name\": \"Free Drink\",\n \"mode\": \"counter\"\n },\n {\n \"id\": 4,\n \"name\": \"Día Viernes\",\n \"mode\": \"permanent\"\n },\n {\n \"id\": 5,\n \"name\": \"Noche Viernes\",\n \"mode\": \"permanent\"\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d725f94c4fd2001489e8232","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d725f94c4fd2001489e8231","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/accesses","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all accesses of an event","slug":"accesses","type":"get","title":"/accesses","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.121Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/accesses
Get all accesses of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595cfec41375bd0049129c74","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595cf6c4175e75003de3ecb6","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T14:59:16.238Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n\t\"id\": 6,\n\t\"name\": \"Friday-13\",\n\t\"mode\": \"counter\"\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Access id","default":"","type":"int","name":"id"}],"url":"/:event_id/accesses/:id","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":1,"body":"","excerpt":"Get an access of an event","slug":"accessesid","type":"get","title":"/accesses/:id","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.121Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/accesses/:id
Get an access of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595cfd6849658c001b1ada47","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595cf6c4175e75003de3ecb6","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T14:53:28.328Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n\t\"id\": 6,\n\t\"name\": \"Friday-13\",\n\t\"mode\": \"counter\"\n}","name":""}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"access\": {\n \"name\": \"Friday-13\",\n \t\"mode\": \"counter\"\n }\n}"}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9c25a9d3d0500120fd7b4","ref":"access","in":"body","required":true,"desc":"","default":"","type":"object","name":"access"}],"url":"/:event_id/accesses","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":2,"body":"","excerpt":"Create a new access","slug":"accesses-1","type":"post","title":"/accesses","__v":8,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.122Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/accesses
Create a new access
Path Params
event_id:
integer
Event id
Body Params
access:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595d069149658c001b1adaa5","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595cf6c4175e75003de3ecb6","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:32:33.030Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 6,\n\t\"name\": \"VIP\",\n\t\"mode\": \"permanent_strict\"\n}","name":""}]},"examples":{"codes":[{"code":"{\n\t\"access\": {\n \"name\": \"VIP\",\n \t\"mode\": \"permanent_strict\" \n }\n}","language":"json"}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Access id","default":"","type":"int","name":"id"},{"_id":"5aa9c28ad4b08700126b34d1","ref":"access","in":"body","required":true,"desc":"","default":"","type":"object","name":"access"}],"url":"/:event_id/accesses/:id","method":"patch","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":3,"body":"","excerpt":"Modify an access of an event","slug":"accessesid-1","type":"patch","title":"/accesses/:id","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.122Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/accesses/:id
Modify an access of an event
Path Params
event_id:
integer
Event id
id:
integer
Access id
Body Params
access:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595d0735a677f100154f908a","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595cf6c4175e75003de3ecb6","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:35:17.310Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"","language":"json","status":200}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Access id","default":"","type":"int","name":"id"}],"url":"/:event_id/accesses/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete an access of an event","slug":"accessesid-3","type":"delete","title":"/accesses/:id","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.123Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/accesses/:id
Delete an access of an event
Path Params
event_id:
integer
Event id
id:
integer
Access id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"5c80d8d40c62f200142aa6b0","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.123Z","createdAt":"2019-03-07T08:39:48.257Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"total\": 234,\n \"active_operators\": 34,\n \"active_customers\": 200\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5d0752a8884659002a087b15","ref":"","in":"query","required":false,"desc":"","default":"","type":"array_int","name":"stations"}],"url":"/:event_id/analytics/activations","method":"get"},"isReference":true,"order":0,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsactivations","type":"get","title":"/analytics/activations","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/activations
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5baa71cb65e49500034cc27d","version":"595ba3bb9ec1a2001512ab8f","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-25T17:35:07.907Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 60.0,\n \"2019-03-02\": 80.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Gateways filter","default":"","type":"array_string","name":"gateways"},{"_id":"5c90d9f63487c7004b6a1f85","ref":"","in":"query","required":false,"desc":"Redeemed filter, accepts true or false","default":"","type":"boolean","name":"redeemed"}],"url":"/:event_id/analytics/credit/topups/online","method":"get"},"isReference":true,"order":1,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticstopupsonline","type":"get","title":"/analytics/credit/topups/online","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.124Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/topups/online
Path Params
event_id:
integer0
Event id
Query Params
gateways:
array of strings
Gateways filter
redeemed:
boolean
Redeemed filter, accepts true or false
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5baa71ef65e49500034cc27f","version":"595ba3bb9ec1a2001512ab8f","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-09-25T17:35:43.062Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"2019-03-01\": 60.0\n}","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"bad_request\"\n}","name":""}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/topups/onsite","method":"get"},"isReference":true,"order":2,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsmoneymoney_online_orders_base_total","type":"get","title":"/analytics/credit/topups/onsite","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.124Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/topups/onsite
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80008f67a4aa0215dc5db3","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.124Z","createdAt":"2019-03-06T17:17:03.157Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/fees/gtag_deposit","method":"get"},"isReference":true,"order":3,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsfeesgtag_deposit","type":"get","title":"/analytics/credit/fees/gtag_deposit","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/fees/gtag_deposit
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c8000c063a8ae02646e6679","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.125Z","createdAt":"2019-03-06T17:17:52.916Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/fees/gtag_return","method":"get"},"isReference":true,"order":4,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsfeesgtag_return","type":"get","title":"/analytics/credit/fees/gtag_return","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/fees/gtag_return
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c8000de1621790275f69e13","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.125Z","createdAt":"2019-03-06T17:18:22.230Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/fees/initial","method":"get"},"isReference":true,"order":5,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsfeesinitial","type":"get","title":"/analytics/credit/fees/initial","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/fees/initial
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c8000eee0329f029f5c4b0d","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.126Z","createdAt":"2019-03-06T17:18:39.017Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/fees/topup","method":"get"},"isReference":true,"order":6,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsfeestopup","type":"get","title":"/analytics/credit/fees/topup","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/fees/topup
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80011f8555150043fc9944","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.126Z","createdAt":"2019-03-06T17:19:27.556Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/fees/refund","method":"get"},"isReference":true,"order":7,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsfeesrefund","type":"get","title":"/analytics/credit/fees/refund","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/fees/refund
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c8001418555150043fc9974","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.127Z","createdAt":"2019-03-06T17:20:01.029Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/sales/product","method":"get"},"isReference":true,"order":8,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticssalesproduct","type":"get","title":"/analytics/credit/sales/product","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/sales/product
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c800160de27f9002cee1ffd","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.127Z","createdAt":"2019-03-06T17:20:32.078Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/sales/tip","method":"get"},"isReference":true,"order":9,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticssalestip","type":"get","title":"/analytics/credit/sales/tip","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/sales/tip
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80017e5444f0001fbe6dea","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.128Z","createdAt":"2019-03-06T17:21:02.581Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/sales/other_amount","method":"get"},"isReference":true,"order":10,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticssalesother_amount","type":"get","title":"/analytics/credit/sales/other_amount","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/sales/other_amount
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c8001e560ee8f002d424687","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.128Z","createdAt":"2019-03-06T17:22:45.876Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Gateways filter","default":"","type":"array_string","name":"gateways"}],"url":"/:event_id/analytics/credit/refunds/online","method":"get"},"isReference":true,"order":11,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsrefundsonline","type":"get","title":"/analytics/credit/refunds/online","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/refunds/online
Path Params
event_id:
integer0
Event id
Query Params
gateways:
array of strings
Gateways filter
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c800205d7e095005c657f55","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.128Z","createdAt":"2019-03-06T17:23:17.383Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 10.0,\n \"2019-03-02\": 15.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Credit type filter by id","default":"","type":"array_int","name":"credits"}],"url":"/:event_id/analytics/credit/refunds/onsite","method":"get"},"isReference":true,"order":12,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"analyticsrefundsonsite","type":"get","title":"/analytics/credit/refunds/onsite","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/credit/refunds/onsite
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
credits:
array of integers
Credit type filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80e567175ad600245789b6","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.129Z","createdAt":"2019-03-07T09:33:27.280Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 60.0,\n \"2019-03-02\": 80.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Gateways filter","default":"","type":"array_string","name":"gateways"}],"url":"/:event_id/analytics/money/topups/online","method":"get"},"isReference":true,"order":13,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"glowlyticsmoneytopupsonline","type":"get","title":"/analytics/money/topups/online","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/money/topups/online
Path Params
event_id:
integer0
Event id
Query Params
gateways:
array of strings
Gateways filter
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80e5c7c9db04001a59bb3d","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.129Z","createdAt":"2019-03-07T09:35:03.239Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"2019-03-01\": 60.0\n}","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"bad_request\"\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Payment methods filter ['cash', 'card']","default":"","type":"array_string","name":"payment_methods"}],"url":"/:event_id/analytics/money/topups/onsite","method":"get"},"isReference":true,"order":14,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"glowlyticsmoneytopupsonsite","type":"get","title":"/analytics/money/topups/onsite","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/money/topups/onsite
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
payment_methods:
array of strings
Payment methods filter ['cash', 'card']
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80e5e02dd69100430e5515","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.130Z","createdAt":"2019-03-07T09:35:28.810Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"2019-03-01\": 60.0,\n \"2019-03-02\": 80.0\n}","language":"json","status":200},{"name":"","code":"{\n \"error\": \"bad_request\"\n}","language":"json","status":400}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Gateways filter","default":"","type":"array_string","name":"gateways"}],"url":"/:event_id/analytics/money/refunds/online","method":"get"},"isReference":true,"order":15,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"glowlyticsmoneyrefundsonline","type":"get","title":"/analytics/money/refunds/online","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/money/refunds/online
Path Params
event_id:
integer0
Event id
Query Params
gateways:
array of strings
Gateways filter
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5c80e5f10c62f200142ab32d","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.130Z","createdAt":"2019-03-07T09:35:45.264Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"2019-03-01\": 60.0\n}","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"bad_request\"\n}","name":""}]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"},{"_id":"5c7fff830c3e9f0063a01bb3","ref":"","in":"query","required":false,"desc":"Payment methods filter ['cash', 'card']","default":"","type":"array_string","name":"payment_methods"}],"url":"/:event_id/analytics/money/refunds/onsite","method":"get"},"isReference":true,"order":16,"body":"[block:api-header]\n{}\n[/block]","excerpt":"","slug":"glowlyticsmoneyrefundsonsite","type":"get","title":"/analytics/money/refunds/onsite","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/money/refunds/onsite
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
payment_methods:
array of strings
Payment methods filter ['cash', 'card']
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5cf7c74678509d0062ecc9d3","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.131Z","createdAt":"2019-06-05T13:44:38.290Z","project":"569f7ef06c5c930d007e22bd","category":"5baa1b62c3a0550003ae32f1","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"2019-03-01\": 60.0\n}","name":""},{"status":400,"language":"json","code":"{\n \"error\": \"bad_request\"\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"auth":"required","params":[{"_id":"5baa6db8c3a0550003ae3ea0","ref":"","in":"path","required":false,"desc":"Event id","default":"0","type":"int","name":"event_id"},{"_id":"5baa6d38a4b30d0003fcc902","ref":"","in":"query","required":false,"desc":"Stations filter by id","default":"","type":"array_int","name":"stations"}],"url":"/:event_id/analytics/money/sales/product","method":"get"},"isReference":true,"order":17,"body":"[block:api-header]\n{}\n[/block]","excerpt":"*Only for Money Direct Sales","slug":"analyticsmoneysales","type":"get","title":"/analytics/money/sales/product","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/analytics/money/sales/product
*Only for Money Direct Sales
Path Params
event_id:
integer0
Event id
Query Params
stations:
array of integers
Stations filter by id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d762d7674dc010127fdc2e8","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.131Z","createdAt":"2019-09-09T10:46:14.882Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d762d428fce800020118974","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 1,\n \"name\": \"CRD\",\n \"value\": \"1.0\",\n \"position\": 1,\n \"spending_order\": 1,\n \"max_balance\": 600,\n \"symbol\": \"C\"\n },\n {\n \"id\": 2,\n \"name\": \"Virtual\",\n \"value\": \"1.0\",\n \"position\": 2,\n \"spending_order\": 2,\n \"max_balance\": 300,\n \"symbol\": \"VC\"\n },\n {\n \"id\": 83,\n \"name\": \"Tok\",\n \"value\": \"1.0\",\n \"position\": 3,\n \"spending_order\": 3,\n \"max_balance\": 300,\n \"symbol\": \"T\"\n }\n]","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"5aa9561fc953730056b50b52","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d72607a47864d0050232575","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d72607a47864d0050232574","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/currencies","method":"get"},"isReference":true,"order":0,"body":"Retrieves a list of all customers for a specific event. Customers can be anonymous or registered and may or may not have name and email.\n\nResponse headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all customers of an event","slug":"currencies","type":"get","title":"/currencies","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/currencies
Get all customers of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d762e20c4b2b50034ccc1e5","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.131Z","createdAt":"2019-09-09T10:49:04.067Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d762d428fce800020118974","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","settings":"","results":{"codes":[{"language":"json","code":"{\n \"id\": 83,\n \"name\": \"Tok\",\n \"value\": \"1.0\",\n \"position\": 3,\n \"spending_order\": 3,\n \"max_balance\": 300,\n \"symbol\": \"T\"\n}","name":"","status":200}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cd6fba677f100154f8eb1","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cd6fba677f100154f8eb0","ref":"","in":"path","required":false,"desc":"Currency id","default":"","type":"int","name":"id"}],"url":"/:event_id/currencies/:id","method":"get"},"isReference":true,"order":1,"body":"","excerpt":"Get a customer of an event","slug":"currenciesid","type":"get","title":"/currencies/:id","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/currencies/:id
Get a customer of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d7631d6761ec9001e660a21","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.132Z","createdAt":"2019-09-09T11:04:54.674Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d762d428fce800020118974","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"code":"{\n\t\"currency\": {\n\t \"name\": \"Token\",\n \"max_balance\": 500,\n \"symbol\": \"TK\"\n \t}\n}","language":"json"}]},"results":{"codes":[{"status":200,"name":"","code":"{\n \"id\": 83,\n \"name\": \"Token\",\n \"value\": \"1.0\",\n \"position\": 3,\n \"spending_order\": 3,\n \"max_balance\": 500,\n \"symbol\": \"TK\"\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"5aa9cd559d3d0500120fd966","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9cd559d3d0500120fd965","ref":"currency","in":"body","required":true,"desc":"","default":"","type":"object","name":"currency"},{"_id":"5c065e2db7d9c4018ef69702","ref":"","in":"path","required":false,"desc":"Currency id","default":"","type":"int","name":"id"}],"url":"/:event_id/currencies/:id","method":"patch"},"isReference":true,"order":2,"body":"","excerpt":"Modify a customer of an event","slug":"currenciesid-1","type":"patch","title":"/currencies/:id","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/currencies/:id
Modify a customer of an event
Path Params
event_id:
integer
Event id
id:
integer
Currency id
Body Params
currency:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d7632731381d2006ab6981f","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.132Z","createdAt":"2019-09-09T11:07:31.811Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d762d428fce800020118974","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"text","code":""}]},"results":{"codes":[{"language":"json","code":"","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"595e4daac6fd260015d25eec","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595e4daac6fd260015d25eeb","ref":"","in":"path","required":false,"desc":"Currency id","default":"","type":"int","name":"id"}],"url":"/:event_id/currencies/:id","method":"delete"},"isReference":true,"order":3,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once the event is launched.","excerpt":"Delete a customer of an event","slug":"currenciesid-2","type":"delete","title":"/currencies/:id","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/currencies/:id
Delete a customer of an event
Path Params
event_id:
integer
Event id
id:
integer
Currency id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595ccbdc01467d00152626ae","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:22:04.140Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 666,\n \"first_name\": \"Vicentest\",\n \"last_name\": \"Test\",\n \"email\": \"test@test.com\",\n \"anonymous\": false\n }\n]","name":"","status":200}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"5aa9561fc953730056b50b52","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d72607a47864d0050232575","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d72607a47864d0050232574","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/customers","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":0,"body":"Retrieves a list of all customers for a specific event. Customers can be anonymous or registered and may or may not have name and email.\n\nResponse headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all customers of an event","slug":"customers","type":"get","title":"/customers","__v":17,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.133Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/customers
Get all customers of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ccce63ae8480033536046","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:26:30.544Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"results":{"codes":[{"language":"json","code":"{\n \"id\": 11111,\n \"first_name\": \"Miguel\",\n \"last_name\": \"Alvarez\",\n \"email\": \"fakemail1@glownet.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"70.0\",\n \"global_money\": \"71.0\",\n \"locale\": \"en\",\n \"anonymous\": false\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"595cd6fba677f100154f8eb1","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cd6fba677f100154f8eb0","ref":"","in":"path","required":false,"desc":"Customer id","default":"","type":"int","name":"id"}],"url":"/:event_id/customers/:id","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":1,"body":"","excerpt":"Get a customer of an event","slug":"customersid","type":"get","title":"/customers/:id","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.133Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/customers/:id
Get a customer of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ccd0e3ae8480033536047","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:27:10.801Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":null,"language":"json","code":"{\n \"customer\": {\n \"first_name\": \"Jhon\",\n \"last_name\": \"Doe\",\n \"email\": \"test@test.com\",\n \"password\": \"s3cur3p455w0rd\",\n \"phone\": \"512 2301 440\",\n \"birthdate\": \"1999-05-05\",\n \"postcode\": \"28012\",\n \"country\": \"ES\",\n \"gender\": \"male\",\n \"family:id\": 3\n }\n}"}]},"results":{"codes":[{"status":201,"name":"","code":"{\n \"id\": 610166,\n \"first_name\": \"Jhon\",\n \"last_name\": \"Doe\",\n \"email\": \"test@test.com\",\n \"phone\": \"512 2301 440\",\n \"birthdate\": \"1999-05-05\",\n \"postcode\": \"28012\",\n \"address\": null,\n \"city\": null,\n \"country\": \"ES\",\n \"gender\": \"male\",\n \"virtual_money\": \"0.0\",\n \"money\": \"100.0\",\n \"locale\": \"en\",\n \"family:id\": 3\n \"anonymous\": false,\n \"refundable\": true,\n \"gtags\": [],\n \"tickets\": [],\n \"orders\": []\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"5a3beb51c4608b0026a58089","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa967a1c953730056b50df7","ref":"customer","in":"body","required":false,"desc":"","default":"","type":"object","name":"customer"}],"url":"/:event_id/customers","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":2,"body":"Creates a customer for the event specified. \n\nIf password is not supplied, a random one is generated for this customer, enabling it to log into the portal","excerpt":"Create a customer of an event","slug":"customers-1","type":"post","title":"/customers","__v":22,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.133Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers
Create a customer of an event
Path Params
event_id:
integer
Event id
Body Params
customer:
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595ccdcc9509ad0033f04420","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:30:20.103Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"name":"","code":"{\n \"id\": 92465,\n \"first_name\": \"Miguel\",\n \"last_name\": \"Alvarez\",\n \"email\": \"whatever@gmail.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"family:id\": 3,\n \"global_refundable_money\": \"0.0\",\n \"global_money\": \"0.0\",\n \"locale\": \"en\",\n \"anonymous\": false\n}","language":"json"}]},"examples":{"codes":[{"code":"{\n\t\"customer\": {\n\t \"first_name\": \"Miguel\",\n\t \"last_name\": \"Alvarez\",\n\t \"email\": \"m.a@test.com\",\n \"family:id\": 3\n \t}\n}","language":"json"}]},"auth":"required","params":[{"_id":"5aa9cd559d3d0500120fd966","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9cd559d3d0500120fd965","ref":"customer","in":"body","required":true,"desc":"","default":"","type":"object","name":"customer"},{"_id":"5c065e2db7d9c4018ef69702","ref":"","in":"path","required":false,"desc":"Customer id","default":"","type":"int","name":"id"}],"url":"/:event_id/customers/:id","method":"patch","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":3,"body":"","excerpt":"Modify a customer of an event","slug":"customersid-1","type":"patch","title":"/customers/:id","__v":15,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.134Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/customers/:id
Modify a customer of an event
Path Params
event_id:
integer
Event id
id:
integer
Customer id
Body Params
customer:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595ccdf39c084700293811a5","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:30:59.945Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"","name":"","status":200}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595e4daac6fd260015d25eec","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595e4daac6fd260015d25eeb","ref":"","in":"path","required":false,"desc":"Customer id","default":"","type":"int","name":"id"}],"url":"/:event_id/customers/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once the event is launched.","excerpt":"Delete a customer of an event","slug":"customersid-2","type":"delete","title":"/customers/:id","__v":12,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.134Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/customers/:id
Delete a customer of an event
Path Params
event_id:
integer
Event id
id:
integer
Customer id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595cfe3701467d001526273c","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T14:56:55.357Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"Credit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id (or email)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1299cdd697002bb65a47","ref":"","in":"body","required":false,"desc":"Send email to customer","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9ca6e9d3d0500120fd8d9","ref":"","in":"body","required":false,"desc":"Amount paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9ca6e9d3d0500120fd8d8","ref":"","in":"body","required":false,"desc":"Amount paid by customer as fee","default":"0.00","type":"float","name":"money_fee"},{"_id":"5c80d0d20c62f200142aa0a6","ref":"","in":"body","required":false,"desc":"a description of the order, free use","default":"","type":"string","name":"description"}],"url":"/:event_id/customers/:id/topup","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":5,"body":"","excerpt":"Create a topup for a customer","slug":"customersidtopup-1","type":"post","title":"/customers/:id/topup","__v":14,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.135Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/topup
Create a topup for a customer
Path Params
event_id:
integer
Event id
id:
integer
Customer id (or email)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer
money_base:
float0.00
Amount paid by customer in currency
money_fee:
float0.00
Amount paid by customer as fee
description:
string
a description of the order, free use
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59ed2e5fa585e90032deb84e","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-22T23:48:47.733Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"VirtualCredit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id (or email)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1363c4fa5b0049f3516f","ref":"","in":"body","required":false,"desc":"Send email to customer about operation","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9cab1cf3a8a00128068fd","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9cab1cf3a8a00128068fc","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_fee"},{"_id":"5c80d0de0c62f200142aa0bc","ref":"","in":"body","required":false,"desc":"a description of the order, free use","default":"","type":"string","name":"description"}],"url":"/:event_id/customers/:id/virtual_topup","method":"post"},"isReference":true,"order":6,"body":"","excerpt":"Create a virtual topup for a customer","slug":"customersidvirtual_topup","type":"post","title":"/customers/:id/virtual_topup","__v":15,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.135Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/virtual_topup
Create a virtual topup for a customer
Path Params
event_id:
integer
Event id
id:
integer
Customer id (or email)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer about operation
money_base:
float0.00
Money paid by customer in currency
money_fee:
float0.00
Money paid by customer in currency
description:
string
a description of the order, free use
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5ca741033212800014d844f0","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.136Z","createdAt":"2019-04-05T11:50:27.337Z","project":"569f7ef06c5c930d007e22bd","category":"595ccbac175e75003de3eb18","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n \"items\": [\n \t{\"item_id\": 23593, \"quantity\": 2 },\n \t{\"item_id\": 23546, \"quantity\": 100 }\n \t],\n \"money_base\": 30,\n \"money_fee\": 30,\n \"description\": \"foobar\",\n \"gateway\": \"paypal\",\n \"send_email\": true\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 940479,\n \"customer_id\": 3006425,\n \"status\": \"completed\",\n \"description\": \"foobar\",\n \"completed_at\": \"2019-04-05T13:40:05.892+02:00\",\n \"gateway\": \"paypal\",\n \"money_base\": \"30.0\",\n \"money_fee\": \"30.0\",\n \"order_items\": [\n {\n \"id\": 1015500,\n \"amount\": \"2.0\",\n \"redeemed\": false,\n \"counter\": 1,\n \"catalog_item_id\": 23593,\n \"catalog_item_type\": \"Access\",\n \"credits\": \"0.0\"\n },\n {\n \"id\": 1015501,\n \"amount\": \"100.0\",\n \"redeemed\": false,\n \"counter\": 2,\n \"catalog_item_id\": 23546,\n \"catalog_item_type\": \"Credit\",\n \"credits\": \"100.0\"\n }\n ]\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id (or email)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"order_items","in":"body","required":true,"desc":"Items to be added to customer","default":"","type":"array_object","name":"items"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1363c4fa5b0049f3516f","ref":"","in":"body","required":false,"desc":"Send email to customer about operation","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9cab1cf3a8a00128068fd","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9cab1cf3a8a00128068fc","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_fee"},{"_id":"5c80d0de0c62f200142aa0bc","ref":"","in":"body","required":false,"desc":"a description of the order, free use","default":"","type":"string","name":"description"}],"url":"/:event_id/customers/:id/create_order","method":"post"},"isReference":true,"order":7,"body":"","excerpt":"Create a virtual topup for a customer","slug":"customersidcreate_order","type":"post","title":"/customers/:id/create_order","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/create_order
Create a virtual topup for a customer
Path Params
event_id:
integer
Event id
id:
integer
Customer id (or email)
Body Params
items:
required
array of objects
Items to be added to customer
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer about operation
money_base:
float0.00
Money paid by customer in currency
money_fee:
float0.00
Money paid by customer in currency
description:
string
a description of the order, free use
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59b2807e431821001ab1aed6","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-08T11:35:26.715Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 92331,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"nosenose@nose.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"30.0\",\n \"global_money\": \"30.0\",\n \"locale\": \"en\",\n \"anonymous\": false,\n \"gtags\": [\n {\n \"id\": 1189827,\n \"tag_uid\": \"89889898989812\",\n \"banned\": true,\n \"format\": \"wristband\",\n \"active\": true,\n \"credits\": \"0.0\",\n \"refundable_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_refundable_balance\": \"0.0\",\n \"redeemed\": false\n }\n ],\n \"tickets\": [],\n \"orders\": [\n {\n \"id\": 100494,\n \"status\": \"completed\",\n \"total\": \"30.0\",\n \"completed_at\": \"2017-08-16T12:10:08.014+02:00\",\n \"gateway\": \"paypal\",\n \"customer_id\": 92491\n },\n {\n \"id\": 100493,\n \"status\": \"refunded\",\n \"total\": \"-30.0\",\n \"completed_at\": \"2017-08-16T11:57:38.811+02:00\",\n \"gateway\": \"bank_account\",\n \"customer_id\": 92491\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"595cc384a677f100154f8e15","ref":"","in":"path","required":false,"desc":"Gtag tag_uid (or id)","default":"","type":"int","name":"tag_uid"}],"url":"/:event_id/customers/:id/ban","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":8,"body":"","excerpt":"Ban a gtag of an event","slug":"customersidban","type":"post","title":"/customers/:id/ban","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.136Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/ban
Ban a gtag of an event
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
tag_uid:
integer
Gtag tag_uid (or id)
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59b280ad190d360010721751","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-08T11:36:13.421Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 92331,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"nosenose@nose.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"30.0\",\n \"global_money\": \"30.0\",\n \"locale\": \"en\",\n \"anonymous\": false,\n \"gtags\": [\n {\n \"id\": 1189827,\n \"tag_uid\": \"89889898989812\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"credits\": \"0.0\",\n \"refundable_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_refundable_balance\": \"0.0\",\n \"redeemed\": false\n }\n ],\n \"tickets\": [],\n \"orders\": [\n {\n \"id\": 100494,\n \"status\": \"completed\",\n \"total\": \"30.0\",\n \"completed_at\": \"2017-08-16T12:10:08.014+02:00\",\n \"gateway\": \"paypal\",\n \"customer_id\": 92491\n },\n {\n \"id\": 100493,\n \"status\": \"refunded\",\n \"total\": \"-30.0\",\n \"completed_at\": \"2017-08-16T11:57:38.811+02:00\",\n \"gateway\": \"bank_account\",\n \"customer_id\": 92491\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"595cc384a677f100154f8e15","ref":"","in":"path","required":false,"desc":"Gtag tag_uid (or id)","default":"","type":"int","name":"tag_uid"}],"url":"/:event_id/customers/:id/unban","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":9,"body":"","excerpt":"Unban a gtag of an event","slug":"customersidunban","type":"post","title":"/customers/:id/unban","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.136Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/unban
Unban a gtag of an event
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
tag_uid:
integer
Gtag tag_uid (or id)
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5aa9592f2a1896004ba7901d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-14T17:17:35.803Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 104560,\n \"customer_id\": 666,\n \"status\": \"started\",\n \"fields\": {},\n \"credit_base\": \"10.0\",\n \"credit_fee\": \"0.0\",\n \"money_base\": \"10.0\",\n \"money_fee\": \"0.0\"\n }","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n \t\"gateway\": \"paypal\",\n \t\"send_email\": true\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id (or email)","default":"","type":"mixed","name":"id"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to make refund","default":"","type":"string","name":"gateway"},{"_id":"5a8c1299cdd697002bb65a47","ref":"","in":"body","required":false,"desc":"Send email to customer","default":"false","type":"boolean","name":"send_email"}],"url":"/:event_id/customers/:id/refund","method":"post"},"isReference":true,"order":10,"body":"","excerpt":"Create a topup of an event","slug":"customersidrefund","type":"post","title":"/customers/:id/refund","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.137Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/refund
Create a topup of an event
Path Params
event_id:
integer
Event id
id:
mixed
Customer id (or email)
Body Params
gateway:
string
Payment gateway used to make refund
send_email:
booleanfalse
Send email to customer
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cce1a9c084700293811a6","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:31:38.846Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 11111,\n \"amount\": \"34.0\",\n \"status\": \"completed\",\n \"fee\": \"2.0\",\n \"field_a\": \"017729\",\n \"field_b\": \"540097364\",\n \"customer\": {\n \"id\": 22222,\n \"first_name\": \"Fran\",\n \"last_name\": \"Moya\",\n \"email\": \"idontknowman@gmail.com\",\n \"anonymous\": false\n }\n },\n {\n \"id\": 11222,\n \"amount\": \"10.0\",\n \"status\": \"completed\",\n \"fee\": \"2.0\",\n \"field_a\": \"017729\",\n \"field_b\": \"540097364\",\n \"customer\": {\n \"id\": 22222,\n \"first_name\": \"Fran\",\n \"last_name\": \"Moya\",\n \"email\": \"idontknowman@gmail.com\",\n \"anonymous\": false\n }\n }\n]","name":"","status":200}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cf9d83d48460033328673","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cf9d83d48460033328672","ref":"","in":"path","required":false,"desc":"Customer id","default":"","type":"int","name":"id"}],"url":"/:event_id/customers/:id/refunds","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":11,"body":"","excerpt":"Get all refunds of a customer of an event","slug":"customersidrefunds","type":"get","title":"/customers/:id/refunds","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.137Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/customers/:id/refunds
Get all refunds of a customer of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59b683f049ae5b002ebc2dd1","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-11T12:39:12.226Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 85634,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"150.0\",\n \"global_money\": \"200.0\",\n \"locale\": \"en\",\n \"anonymous\": true,\n \"gtags\": [\n {\n \"id\": 1234567,\n \"tag_uid\": \"12345671234568\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"credits\": \"50.0\",\n \"refundable_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_refundable_balance\": \"0.0\",\n \"redeemed\": false\n }\n ],\n \"tickets\": [\n {\n \"id\": 123456,\n \"code\": \"111122225555\",\n \"redeemed\": false,\n \"banned\": false,\n \"purchaser_first_name\": null,\n \"purchaser_last_name\": null,\n \"purchaser_email\": null\n }\n ],\n \"orders\": [\n {\n \"id\": 345678,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:59.922+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n },\n {\n \"id\": 987654,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:36.719+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"code\": \"111122225555\"\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id or email","default":"","type":"int","name":"id"},{"_id":"59b68791bc195b003ca7827a","ref":"","in":"body","required":true,"desc":"Ticket code","default":"","type":"string","name":"code"}],"url":"/:event_id/customers/:id/assign_ticket","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":12,"body":"","excerpt":"Assign a ticket to an existing customer","slug":"customersidassign_ticket","type":"post","title":"/customers/:id/assign_ticket","__v":11,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.138Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/assign_ticket
Assign a ticket to an existing customer
Path Params
event_id:
integer
Event id
id:
integer
Customer id or email
Body Params
code:
required
string
Ticket code
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5af2fbd2e8b2950003f6ea75","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-09T13:46:58.165Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"json","code":"{\n\t\"tag_uid\": \"111122225555\"\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 85634,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"150.0\",\n \"global_money\": \"200.0\",\n \"locale\": \"en\",\n \"anonymous\": true,\n \"gtags\": [\n {\n \"id\": 1234567,\n \"tag_uid\": \"111122225555\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"credits\": \"50.0\",\n \"refundable_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_refundable_balance\": \"0.0\",\n \"redeemed\": false\n }\n ],\n \"tickets\": [\n {\n \"id\": 123456,\n \"code\": \"JHSDGKJHSDGFUDY\",\n \"redeemed\": false,\n \"banned\": false,\n \"purchaser_first_name\": null,\n \"purchaser_last_name\": null,\n \"purchaser_email\": null\n }\n ],\n \"orders\": [\n {\n \"id\": 345678,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:59.922+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n },\n {\n \"id\": 987654,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:36.719+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Customer id or email","default":"","type":"int","name":"id"},{"_id":"59b68791bc195b003ca7827a","ref":"","in":"body","required":true,"desc":"Gtag UID","default":"","type":"string","name":"tag_uid"}],"url":"/:event_id/customers/:id/assign_gtag","method":"post"},"isReference":true,"order":13,"body":"","excerpt":"Assign a ticket to an existing customer","slug":"customersidassign_gtag","type":"post","title":"/customers/:id/assign_gtag","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.138Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/assign_gtag
Assign a ticket to an existing customer
Path Params
event_id:
integer
Event id
id:
integer
Customer id or email
Body Params
tag_uid:
required
string
Gtag UID
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59b858bf0ca59e003243b6bf","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-12T21:59:27.643Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n\t\"new_tag_uid\": \"12345671234568\"\n}","language":"json"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 85634,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"global_refundable_money\": \"150.0\",\n \"global_money\": \"200.0\",\n \"locale\": \"en\",\n \"anonymous\": true,\n \"gtags\": [\n {\n \"id\": 1234567,\n \"tag_uid\": \"12345671234568\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"credits\": \"50.0\",\n \"refundable_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_refundable_balance\": \"0.0\",\n \"redeemed\": false\n }\n ],\n \"tickets\": [\n {\n \"id\": 123456,\n \"code\": \"111122225555\",\n \"redeemed\": false,\n \"banned\": false,\n \"purchaser_first_name\": null,\n \"purchaser_last_name\": null,\n \"purchaser_email\": null\n }\n ],\n \"orders\": [\n {\n \"id\": 345678,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:59.922+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n },\n {\n \"id\": 987654,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-09-11T14:29:36.719+02:00\",\n \"gateway\": null,\n \"customer_id\": 92492\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"595cc384a677f100154f8e15","ref":"","in":"path","required":false,"desc":"Gtag tag_uid (or id)","default":"","type":"int","name":"tag_uid"},{"_id":"59b68791bc195b003ca7827a","ref":"","in":"body","required":true,"desc":"","default":"","type":"string","name":"new_tag_uid"}],"url":"/:event_id/customers/:id/gtag_replacement","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":14,"body":"","excerpt":"Unban a gtag of an event","slug":"customersidgtag_replacement","type":"post","title":"/customers/:id/gtag_replacement","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.139Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/:id/gtag_replacement
Unban a gtag of an event
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
tag_uid:
integer
Gtag tag_uid (or id)
Body Params
new_tag_uid:
required
string
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5ab29691a2051c007a8ece9d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ccbac175e75003de3eb18","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-21T17:29:53.422Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","settings":"","results":{"codes":[{"language":"json","code":"[\n {\n\t\t\"event_id\": 317,\n\t\t\"action\": \"sale\",\n\t\t\"description\": \"sale\",\n\t\t\"operation_id\": 21172,\n\t\t\"source\": \"onsite\",\n\t\t\"date\": \"2018-03-21T13:31:16.000+01:00\",\n\t\t\"line_counter\": 1,\n\t\t\"gtag_counter\": 9,\n\t\t\"device_id\": 5356,\n\t\t\"station_id\": 10658,\n\t\t\"customer_id\": 974684,\n\t\t\"customer_gtag_id\": 1993812,\n\t\t\"operator_id\": 974685,\n\t\t\"operator_gtag_id\": 1993813,\n\t\t\"credential_type\": null,\n\t\t\"credential_id\": null,\n\t\t\"ticket_type_id\": null,\n\t\t\"product_id\": null,\n\t\t\"order_id\": null,\n\t\t\"catalog_item_id\": null,\n\t\t\"catalog_item_type\": null,\n\t\t\"sale_item_quantity\": null,\n\t\t\"sale_item_unit_price\": null,\n\t\t\"sale_item_total_price\": null,\n\t\t\"standard_unit_price\": null,\n\t\t\"standard_total_price\": null,\n\t\t\"payment_method\": null,\n\t\t\"monetary_quantity\": null,\n\t\t\"monetary_unit_price\": null,\n\t\t\"monetary_total_price\": null,\n\t\t\"credit_type\": \"CatalogItem\",\n\t\t\"credit_id\": 849,\n\t\t\"credit_name\": \"Virtual\",\n\t\t\"credit_amount\": \"15.0\",\n\t\t\"final_balance\": \"25.0\",\n\t\t\"message\": null,\n\t\t\"priority\": null,\n\t\t\"user_flag_value\": null,\n\t\t\"access_direction\": null\n }\n]","name":"","status":200}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cd6fba677f100154f8eb1","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cd6fba677f100154f8eb0","ref":"","in":"path","required":false,"desc":"Customer id","default":"","type":"int","name":"customer_id"}],"url":"/:event_id/customers/:customer_id/pokes","method":"get"},"isReference":true,"order":15,"body":"","excerpt":"Get pokes for a customer","slug":"customersidpokes","type":"get","title":"/customers/:id/pokes","__v":3,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.139Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/customers/:id/pokes
Get pokes for a customer
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d72407aeaaf41003479636b","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.140Z","createdAt":"2019-09-06T11:18:18.860Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"595ccbac175e75003de3eb18","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 1,\n \"first_name\": \"Vicentest\",\n \"last_name\": \"Test\",\n \"email\": \"test@test.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": false,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 563,\n \"tag_uid\": \"12445678912345\",\n \"banned\": false,\n \"redeemed\": false,\n \"active\": true,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"customer_id\": 1,\n \"ticket_type_id\": null\n }\n ],\n \"tickets\": [],\n \"orders\": []\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"https://sandbox.glownet.com/api/v2/events/1/customers/search?email=test@test.com","language":"text"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d72407aeaaf41003479636c","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"email"}],"url":"/:event_id/customers/search","method":"post"},"isReference":true,"order":16,"body":"","excerpt":"Search a customer by email","slug":"customerssearch","type":"post","title":"/customers/search","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/customers/search
Search a customer by email
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9d1e6fc00f0001204301c","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9d187fc00f0001204301a","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:52:38.176Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"595ba3bb9ec1a2001512ab72","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 666,\n \"name\": \"osmell festival\",\n \"slug\": \"osmell-festival\",\n \"logo\": \"/assets/glownet-event-logo.png\",\n \"background\": \"/assets/background-default.jpg\",\n \"currency\": \"EUR\",\n \"state\": \"created\",\n \"open_topups\": true,\n \"open_refunds\": true,\n \"every_topup_fee\": null,\n \"onsite_initial_topup_fee\": null,\n \"online_initial_topup_fee\": null,\n \"gtag_deposit_fee\": null,\n \"refund_fee\": null,\n \"maximum_gtag_balance\": 300,\n \"credit\": {\n \"id\": 666,\n \"name\": \"CRD\",\n \"value\": \"1.0\",\n \"currency\": \"EUR\",\n \"currency_symbol\": \"€\",\n \"credit_symbol\": \"C\"\n }\n\t}\n]","name":"","status":200}]},"settings":"","auth":"required","params":[],"url":"/events","method":"get"},"isReference":true,"order":0,"body":"Retrieves a list of all customers for a specific event. Customers can be anonymous or registered and may or may not have name and email.","excerpt":"Get a list of all events","slug":"events","type":"get","title":"/events","__v":0,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.140Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/events
Get a list of all events
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5aa9d200fc00f0001204301d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9d187fc00f0001204301a","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:53:04.801Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"{\n \"id\": 666,\n \"name\": \"osmell festival\",\n \"slug\": \"osmell-festival\",\n \"logo\": \"/assets/glownet-event-logo.png\",\n \"background\": \"/assets/background-default.jpg\",\n \"currency\": \"EUR\",\n \"state\": \"created\",\n \"open_topups\": true,\n \"open_refunds\": true,\n \"every_topup_fee\": null,\n \"onsite_initial_topup_fee\": null,\n \"online_initial_topup_fee\": null,\n \"gtag_deposit_fee\": null,\n \"refund_fee\": null,\n \"maximum_gtag_balance\": 300,\n \t \"event_serie\": null,\n \"credit\": {\n \"id\": 666,\n \"name\": \"CRD\",\n \"value\": \"1.0\",\n \"currency\": \"EUR\",\n \"currency_symbol\": \"€\",\n \"credit_symbol\": \"C\"\n }\n}","name":"","status":200}]},"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"5aa9d226fc00f0001204301e","ref":"","in":"path","required":false,"desc":"Id of event","default":"","type":"int","name":"id"}],"url":"/:id","method":"get"},"isReference":true,"order":1,"body":"Retrieves a list of all customers for a specific event. Customers can be anonymous or registered and may or may not have name and email.","excerpt":"Get details of one event","slug":"eventsid","type":"get","title":"/events/:id","__v":20,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.140Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/events/:id
Get details of one event
Path Params
id:
integer
Id of event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5af46546caa1c80003f5c8b6","version":"595ba3bb9ec1a2001512ab8f","project":"569f7ef06c5c930d007e22bd","category":"5aa9d187fc00f0001204301a","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-10T15:29:10.449Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"595ba3bb9ec1a2001512ab72","examples":{"codes":[{"code":"{\n \"event\": {\n \"maximum_gtag_balance\": 450,\n \"every_topup_fee\": 450,\n \"onsite_initial_topup_fee\": 450,\n \"online_initial_topup_fee\": 450, \n \"gtag_deposit_fee\": 450,\n \"refund_fee\": 450\n }\n}","language":"json"}]},"results":{"codes":[{"language":"json","code":"{\n \"id\": 666,\n \"name\": \"osmell festival\",\n \"slug\": \"osmell-festival\",\n \"logo\": \"/assets/glownet-event-logo.png\",\n \"background\": \"/assets/background-default.jpg\",\n \"currency\": \"EUR\",\n \"state\": \"created\",\n \"open_topups\": true,\n \"open_refunds\": true,\n \"every_topup_fee\": 450,\n \"onsite_initial_topup_fee\": 450,\n \"online_initial_topup_fee\": 450,\n \"gtag_deposit_fee\": 450,\n \"refund_fee\": 450,\n \"maximum_gtag_balance\": 450,\n\t \"event_serie\": null,\n \"credit\": {\n \"id\": 666,\n \"name\": \"CRD\",\n \"value\": \"1.0\",\n \"currency\": \"EUR\",\n \"currency_symbol\": \"€\",\n \"credit_symbol\": \"C\"\n }\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"5aa9d226fc00f0001204301e","ref":"","in":"path","required":false,"desc":"Id of event","default":"","type":"int","name":"id"},{"_id":"5af46546caa1c80003f5c8b7","ref":"event","in":"body","required":false,"desc":"","default":"","type":"object","name":"event"}],"url":"/events/:id","method":"patch"},"isReference":true,"order":2,"body":"Retrieves a list of all customers for a specific event. Customers can be anonymous or registered and may or may not have name and email.","excerpt":"Update details of one event","slug":"eventsid-1","type":"patch","title":"/events/:id","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.141Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/events/:id
Update details of one event
Path Params
id:
integer
Id of event
Body Params
event:
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d5be05e31032300684945c2","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.141Z","createdAt":"2019-08-20T11:58:22.802Z","project":"569f7ef06c5c930d007e22bd","category":"5d5be01f33015d003ba0f909","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","settings":"","results":{"codes":[{"code":"[\n {\n \"id\": 3,\n \"owner_id\": null,\n \"tracking_reference\": \"457c42359912b74d09a23ce28d2c751b\",\n \"shipping_order_uid\": \"A456456\",\n \"shipping_first_name\": \"Arya\",\n \"shipping_last_name\": \"Stark\",\n \"shipping_company\": null,\n \"shipping_email\": \"arya@stark.com\",\n \"shipping_phone\": \"66666666666\",\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": false,\n \"customers\": []\n },\n {\n \"id\": 2,\n \"owner_id\": null,\n \"tracking_reference\": \"3c0ad2fbb4aa38c926ccf2b54c2ea99b\",\n \"shipping_order_uid\": \"A234355\",\n \"shipping_first_name\": \"Jon\",\n \"shipping_last_name\": \"Snow\",\n \"shipping_company\": null,\n \"shipping_email\": \"jon@snow.com\",\n \"shipping_phone\": \"666123456\",\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": false,\n \"customers\": []\n },\n {\n \"id\": 1,\n \"owner_id\": null,\n \"tracking_reference\": \"jdbhf6sdtfdusy\",\n \"shipping_order_uid\": \"jdbhf6sdtfdusy\",\n \"shipping_first_name\": \"andres\",\n \"shipping_last_name\": null,\n \"shipping_company\": null,\n \"shipping_email\": null,\n \"shipping_phone\": null,\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": true,\n \"customers\": [\n {\n \"id\": 569,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": true,\n \"refundable\": true,\n \"family_id\": 1,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 561,\n \"event_id\": 1,\n \"tag_uid\": \"040FB5DA794C80\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"virtual_credits\": \"0.0\",\n \"credits\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"customer_id\": 569,\n \"created_at\": \"2019-06-11T17:03:58.172+02:00\",\n \"updated_at\": \"2019-06-11T17:04:07.762+02:00\",\n \"redeemed\": false,\n \"ticket_type_id\": null,\n \"balances\": {},\n \"complete\": true,\n \"consistent\": true,\n \"operator\": false,\n \"tokens\": {},\n \"final_tokens_balance\": {},\n \"autostage\": \"no\"\n }\n ],\n \"tickets\": [],\n \"orders\": []\n }\n ]\n }\n]","name":"","status":200,"language":"json"}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"595ce995175e75003de3ec25","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d725f403d2d43006e11249d","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d725f403d2d43006e11249c","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/families","method":"get"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all families of an event. To use this endpoint, family accounts must be enable on event settings.","slug":"families","type":"get","title":"/families","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/families
Get all families of an event. To use this endpoint, family accounts must be enable on event settings.
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d5be08f0c74ae001e8e2943","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.142Z","createdAt":"2019-08-20T11:59:11.900Z","project":"569f7ef06c5c930d007e22bd","category":"5d5be01f33015d003ba0f909","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","settings":"","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 1,\n \"owner_id\": null,\n \"tracking_reference\": \"jdbhf6sdtfdusy\",\n \"shipping_order_uid\": \"jdbhf6sdtfdusy\",\n \"shipping_first_name\": \"andres\",\n \"shipping_last_name\": null,\n \"shipping_company\": null,\n \"shipping_email\": null,\n \"shipping_phone\": null,\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": true,\n \"customers\": [\n {\n \"id\": 569,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": true,\n \"refundable\": true,\n \"family_id\": 1,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 561,\n \"event_id\": 1,\n \"tag_uid\": \"040FB5DA794C80\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"virtual_credits\": \"0.0\",\n \"credits\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"customer_id\": 569,\n \"created_at\": \"2019-06-11T17:03:58.172+02:00\",\n \"updated_at\": \"2019-06-11T17:04:07.762+02:00\",\n \"redeemed\": false,\n \"ticket_type_id\": null,\n \"balances\": {},\n \"complete\": true,\n \"consistent\": true,\n \"operator\": false,\n \"tokens\": {},\n \"final_tokens_balance\": {},\n \"autostage\": \"no\"\n }\n ],\n \"tickets\": [],\n \"orders\": []\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595ce9caa677f100154f8f69","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595ceccc01467d001526270d","ref":"","in":"path","required":false,"desc":"Family id","default":"","type":"int","name":"id"}],"url":"/:event_id/families/:id","method":"get"},"isReference":true,"order":1,"body":"","excerpt":"Get a family of an event. To use this endpoint, family accounts must be enable on event settings.","slug":"familiesid","type":"get","title":"/families/:id","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/families/:id
Get a family of an event. To use this endpoint, family accounts must be enable on event settings.
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d5be0c6c2bde10059dcf6e2","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.142Z","createdAt":"2019-08-20T12:00:06.376Z","project":"569f7ef06c5c930d007e22bd","category":"5d5be01f33015d003ba0f909","user":"55b7428b31bccb190081bec5","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 4,\n \"owner_id\": 12311,\n \"tracking_reference\": \"457c42359912b74d09a23ce28d2c751a\",\n \"shipping_order_uid\": \"A456458\",\n \"shipping_first_name\": \"Arya\",\n \"shipping_last_name\": \"Stark\",\n \"shipping_company\": null,\n \"shipping_email\": \"arya@starks.com\",\n \"shipping_phone\": \"66666666666\",\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": false,\n \"customers\": [\n {\n \"id\": 234231,\n \"first_name\": \"Vicentest\",\n \"last_name\": \"Test\",\n \"email\": \"test@test.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": false,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": true,\n \"gtags\": [],\n \"tickets\": [],\n \"orders\": []\n },\n {\n \"id\": 234233,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": true,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 1,\n \"event_id\": 1,\n \"tag_uid\": \"AAAAAAAAAAAAAA\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"virtual_credits\": \"0.0\",\n \"credits\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"customer_id\": 3,\n \"created_at\": \"2019-05-08T16:19:16.722+02:00\",\n \"updated_at\": \"2019-05-08T16:19:16.733+02:00\",\n \"redeemed\": false,\n \"ticket_type_id\": null,\n \"balances\": {},\n \"complete\": true,\n \"consistent\": true,\n \"operator\": false,\n \"tokens\": {},\n \"final_tokens_balance\": {},\n \"autostage\": \"no\"\n }\n ],\n \"tickets\": [],\n \"orders\": []\n },\n {\n \"id\": 234246,\n \"first_name\": \"Staffer\",\n \"last_name\": \"Test\",\n \"email\": \"staffer_test@test.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"84\": 0,\n \"85\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": false,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": false,\n \"gtags\": [],\n \"tickets\": [],\n \"orders\": []\n }\n ]\n}","name":""}]},"examples":{"codes":[{"code":"{\n \"family\": {\n \"owner_id\": 12311,\n \"tracking_reference\": \"457c42359912b74d09a23ce28d2c751b\",\n \"shipping_order_uid\": \"A456456\",\n \"shipping_first_name\": \"Arya\",\n \"shipping_last_name\": \"Stark\",\n \"shipping_company\": null,\n \"shipping_email\": \"arya@starks.com\",\n \"shipping_phone\": \"66666666666\",\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": false,\n \"delivered\": false,\n \"customer_ids\": [234231, 234233, 234246]\n }\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"595ce9caa677f100154f8f69","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9c0b1cf3a8a0012806884","ref":"family","in":"body","required":false,"desc":"","default":"","type":"object","name":"family"},{"_id":"5d6f71f3c5d73700e25c8aa3","ref":"","in":"body","required":false,"desc":"Required if shipping_email is not sent","default":"","type":"int","name":"owner_id"},{"_id":"5d6f71f3c5d73700e25c8aa2","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"tracking_reference"},{"_id":"5d6f71f3c5d73700e25c8aa1","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_first_name"},{"_id":"5d6f71f3c5d73700e25c8aa0","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_last_name"},{"_id":"5d6f71f3c5d73700e25c8a9f","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_company"},{"_id":"5d6f71f3c5d73700e25c8a9e","ref":"","in":"body","required":false,"desc":"Required if owner_id is not sent. This field is not unique per event given the fact that the same email could purchase for different families with different adresses. Never same family different addresses.","default":"","type":"string","name":"shipping_email"},{"_id":"5d6f71f3c5d73700e25c8a9d","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_phone"},{"_id":"5d6f71f3c5d73700e25c8a9c","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_address1"},{"_id":"5d6f71f3c5d73700e25c8a9b","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_address2"},{"_id":"5d6f71f3c5d73700e25c8a9a","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_address3"},{"_id":"5d6f71f3c5d73700e25c8a99","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_city"},{"_id":"5d6f71f3c5d73700e25c8a98","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_province"},{"_id":"5d6f71f3c5d73700e25c8a97","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_postal_code"},{"_id":"5d6f71f3c5d73700e25c8a96","ref":"","in":"body","required":false,"desc":"","default":"","type":"string","name":"shipping_country"},{"_id":"5d6f71f3c5d73700e25c8a95","ref":"","in":"body","required":false,"desc":"","default":"false","type":"boolean","name":"sent"},{"_id":"5d6f71f3c5d73700e25c8a94","ref":"","in":"body","required":false,"desc":"","default":"false","type":"boolean","name":"delivered"},{"_id":"5d6f71f3c5d73700e25c8a93","ref":"","in":"body","required":false,"desc":"Existing customers ids to add to the family. Can be added later.","default":"","type":"array_int","name":"customer_ids"}],"url":"/:event_id/families","method":"post"},"isReference":true,"order":2,"body":"","excerpt":"Create a new family on a event. To use this endpoint, family accounts must be enable on event settings.","slug":"families-1","type":"post","title":"/families","__v":9,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/families
Create a new family on a event. To use this endpoint, family accounts must be enable on event settings.
Path Params
event_id:
integer
Event id
Body Params
family:
object
owner_id:
integer
Required if shipping_email is not sent
tracking_reference:
string
shipping_first_name:
string
shipping_last_name:
string
shipping_company:
string
shipping_email:
string
Required if owner_id is not sent. This field is not unique per event given the fact that the same email could purchase for different families with different adresses. Never same family different addresses.
shipping_phone:
string
shipping_address1:
string
shipping_address2:
string
shipping_address3:
string
shipping_city:
string
shipping_province:
string
shipping_postal_code:
string
shipping_country:
string
sent:
booleanfalse
delivered:
booleanfalse
customer_ids:
array of integers
Existing customers ids to add to the family. Can be added later.
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d5be10d33015d003ba0f921","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.143Z","createdAt":"2019-08-20T12:01:17.552Z","project":"569f7ef06c5c930d007e22bd","category":"5d5be01f33015d003ba0f909","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"code":"{\n \"family\": {\n \"sent\": true,\n \"customer_ids\": [1, 3]\n }\n}","language":"json"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 4,\n \"owner_id\": 1,\n \"tracking_reference\": \"457c42359912b74d09a23ce28d2c751a\",\n \"shipping_order_uid\": \"A456458\",\n \"shipping_first_name\": \"Arya\",\n \"shipping_last_name\": \"Stark\",\n \"shipping_company\": null,\n \"shipping_email\": \"arya@starks.com\",\n \"shipping_phone\": \"66666666666\",\n \"shipping_address1\": null,\n \"shipping_address2\": null,\n \"shipping_address3\": null,\n \"shipping_city\": null,\n \"shipping_province\": null,\n \"shipping_postal_code\": null,\n \"shipping_country\": null,\n \"sent\": true,\n \"delivered\": false,\n \"customers\": [\n {\n \"id\": 3,\n \"first_name\": null,\n \"last_name\": null,\n \"email\": null,\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": true,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 1,\n \"event_id\": 1,\n \"tag_uid\": \"AAAAAAAAAAAAAA\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"virtual_credits\": \"0.0\",\n \"credits\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"customer_id\": 3,\n \"created_at\": \"2019-05-08T16:19:16.722+02:00\",\n \"updated_at\": \"2019-05-08T16:19:16.733+02:00\",\n \"redeemed\": false,\n \"ticket_type_id\": null,\n \"balances\": {},\n \"complete\": true,\n \"consistent\": true,\n \"operator\": false,\n \"tokens\": {},\n \"final_tokens_balance\": {},\n \"autostage\": \"no\"\n }\n ],\n \"tickets\": [],\n \"orders\": []\n },\n {\n \"id\": 1,\n \"first_name\": \"Vicentest\",\n \"last_name\": \"Test\",\n \"email\": \"test@test.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": false,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": true,\n \"gtags\": [],\n \"tickets\": [],\n \"orders\": []\n }\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"5aa9c0db80b15d0012096002","ref":"family","in":"body","required":true,"desc":"","default":"","type":"object","name":"family"},{"_id":"5c07a9c062cadb000d5ff68b","ref":"","in":"path","required":false,"desc":"Id of Event","default":"","type":"int","name":"event_id"},{"_id":"5c07a9d1f78b8501573a5475","ref":"","in":"path","required":false,"desc":"Family ID","default":"","type":"int","name":"id"}],"url":"/:event_id/families/:id","method":"patch"},"isReference":true,"order":3,"body":"","excerpt":"Modify a family of an event. To use this endpoint, family accounts must be enable on event settings.","slug":"familiesid-1","type":"patch","title":"/families/:id","__v":4,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/families/:id
Modify a family of an event. To use this endpoint, family accounts must be enable on event settings.
Path Params
event_id:
integer
Id of Event
id:
integer
Family ID
Body Params
family:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d5be136cb856101b808afbb","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.143Z","createdAt":"2019-08-20T12:01:58.121Z","project":"569f7ef06c5c930d007e22bd","category":"5d5be01f33015d003ba0f909","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"code":"","name":"","status":200,"language":"json"}]},"settings":"","auth":"required","params":[{"_id":"595ce995175e75003de3ec25","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cee2449658c001b1ad9ec","ref":"","in":"path","required":false,"desc":"Family ID","default":"","type":"int","name":"id"}],"url":"/:event_id/families/:id","method":"delete"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a family on an event. To use this endpoint, family accounts must be enable on event settings.","slug":"familiesid-2","type":"delete","title":"/families/:id","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/families/:id
Delete a family on an event. To use this endpoint, family accounts must be enable on event settings.
Path Params
event_id:
integer
Event id
id:
integer
Family ID
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595ba3bb9ec1a2001512ab83","version":"595ba3bb9ec1a2001512ab8f","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d725f0bbe80c80012730bda","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d725f0bbe80c80012730bd9","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 1111111,\n \"tag_uid\": \"04BA444A114D80\",\n \"banned\": false,\n \"redeemed\": false,\n \"active\": true,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"customer_id\": null,\n \"ticket_type_id\": null\n },\n {\n \"id\": 2222222,\n \"tag_uid\": \"041CC54A114D80\",\n \"banned\": false,\n \"redeemed\": false,\n \"active\": true,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"customer_id\": null,\n \"ticket_type_id\": null\n },\n {\n \"id\": 3333333,\n \"tag_uid\": \"0420B622EB4B80\",\n \"banned\": false,\n \"redeemed\": false,\n \"active\": true,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"customer_id\": null,\n \"ticket_type_id\": null\n }\n]","name":"","status":200}]},"settings":"","url":"/:event_id/gtags","apiSetting":"59f6ff2927b9410024d0d6fb"},"excerpt":"Get all gtags of an event","githubsync":"","isReference":true,"project":"569f7ef06c5c930d007e22bd","sync_unique":"","__v":12,"hidden":false,"link_external":false,"title":"/gtags","user":"5ba9ee7c64b8c60003f1d903","body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","category":"595ba3bb9ec1a2001512ab70","createdAt":"2016-02-16T10:40:06.774Z","slug":"get-gtags","link_url":"","order":0,"parentDoc":null,"type":"get","updates":[],"next":{"description":"","pages":[]},"updatedAt":"2019-09-24T13:37:31.144Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/gtags
Get all gtags of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ba3bb9ec1a2001512ab84","excerpt":"Get a gtag of an event","link_external":false,"slug":"get-gtags-id","title":"/gtags/:id","user":"59a5ad0f27cc70002fcb1063","__v":11,"link_url":"","sync_unique":"","version":"595ba3bb9ec1a2001512ab8f","createdAt":"2016-02-16T10:41:49.360Z","githubsync":"","hidden":false,"isReference":true,"order":1,"parentDoc":null,"project":"569f7ef06c5c930d007e22bd","type":"get","api":{"method":"get","params":[{"_id":"595bbac8ed4095001bbc0b74","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595bbac8ed4095001bbc0b73","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"234567890\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": null,\n\t\"ticket_type_id\": null\n}","name":""}]},"settings":"","url":"/:event_id/gtags/:id","auth":"required","examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb"},"body":"","category":"595ba3bb9ec1a2001512ab70","updates":[],"next":{"pages":[],"description":""},"updatedAt":"2019-09-24T13:37:31.144Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/gtags/:id
Get a gtag of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ba3bb9ec1a2001512ab85","title":"/gtags","type":"post","updates":[],"version":"595ba3bb9ec1a2001512ab8f","api":{"results":{"codes":[{"name":"","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","language":"json","status":201}]},"settings":"","url":"/:event_id/gtags","auth":"required","examples":{"codes":[{"code":"{\n\t\"gtag\": {\n \t\t\"tag_uid\": \"12345671234567\",\n \t\"customer_id\": 666\n \t}\n}","language":"json"}]},"method":"post","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa969daccf534000f60568b","ref":"gtag","in":"body","required":false,"desc":"","default":"","type":"object","name":"gtag"}],"apiSetting":"59f6ff2927b9410024d0d6fb"},"category":"595ba3bb9ec1a2001512ab70","githubsync":"","link_url":"","order":2,"slug":"post-gtags","sync_unique":"","body":"","editedParams2":true,"hidden":false,"isReference":true,"link_external":false,"parentDoc":null,"createdAt":"2016-02-16T10:43:29.384Z","editedParams":true,"excerpt":"Create a gtag of an event","project":"569f7ef06c5c930d007e22bd","user":"59a5ad0f27cc70002fcb1063","__v":14,"next":{"description":"","pages":[]},"updatedAt":"2019-09-24T13:37:31.144Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags
Create a gtag of an event
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cb4b5a677f100154f8de1","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T09:43:17.210Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"gtag\": {\n \t\t\"tag_uid\": \"12345671234567\",\n \t\"customer_id\": 666\n \t}\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"5aa96aadb28af00057fe3145","ref":"gtag","in":"body","required":false,"desc":"","default":"","type":"object","name":"gtag"}],"url":"/:event_id/gtags/:id","method":"patch","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":3,"body":"","excerpt":"Modify a gtag of an event","slug":"gtagsid","type":"patch","title":"/gtags/:id","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.145Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/gtags/:id
Modify a gtag of an event
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
Body Params
gtag:
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cc7624ab7ec003d6ea9eb","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:02:58.084Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"","results":{"codes":[{"name":"","code":"","language":"json","status":200}]},"auth":"required","params":[{"_id":"595bbac8ed4095001bbc0b74","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595bbac8ed4095001bbc0b73","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"}],"url":"/:event_id/gtags/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a gtag from an event","slug":"gtagsid-1","type":"delete","title":"/gtags/:id","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.145Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/gtags/:id
Delete a gtag from an event
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"5aa9cb22cf3a8a00128068ff","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:23:46.117Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"Credit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1299cdd697002bb65a47","ref":"","in":"body","required":false,"desc":"Send email to customer","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9ca6e9d3d0500120fd8d9","ref":"","in":"body","required":false,"desc":"Amount paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9ca6e9d3d0500120fd8d8","ref":"","in":"body","required":false,"desc":"Amount paid by customer as fee","default":"0.00","type":"float","name":"money_fee"}],"url":"/:event_id/gtags/:id/topup","method":"post"},"isReference":true,"order":5,"body":"","excerpt":"Create a topup for a gtag","slug":"gtagsidtopup","type":"post","title":"/gtags/:id/topup","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.146Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/:id/topup
Create a topup for a gtag
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer
money_base:
float0.00
Amount paid by customer in currency
money_fee:
float0.00
Amount paid by customer as fee
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9cb4e9d3d0500120fd93a","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:24:30.503Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"VirtualCredit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1363c4fa5b0049f3516f","ref":"","in":"body","required":false,"desc":"Send email to customer about operation","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9cab1cf3a8a00128068fd","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9cab1cf3a8a00128068fc","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_fee"}],"url":"/:event_id/gtags/:id/virtual_topup","method":"post"},"isReference":true,"order":6,"body":"","excerpt":"Create a virtual topup for a gtag","slug":"gtagsidvirtual_topup","type":"post","title":"/gtags/:id/virtual_topup","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.146Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/:id/virtual_topup
Create a virtual topup for a gtag
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer about operation
money_base:
float0.00
Money paid by customer in currency
money_fee:
float0.00
Money paid by customer in currency
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59b26703431821001ab19bc7","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-08T09:46:43.295Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"}],"url":"/:event_id/gtags/:id/ban","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":7,"body":"","excerpt":"Ban a gtag of an event","slug":"gtagsidban","type":"post","title":"/gtags/:id/ban","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.147Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/:id/ban
Ban a gtag of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59b27d493bca9c001059ab65","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-08T11:21:45.664Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"}],"url":"/:event_id/gtags/:id/unban","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":8,"body":"","excerpt":"Unban a gtag of an event","slug":"gtagsidunban","type":"post","title":"/gtags/:id/unban","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.147Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/:id/unban
Unban a gtag of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59b81850a2d5550038e2419f","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-12T17:24:32.479Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 2022311,\n \"tag_uid\": \"FFFFFFFFFF\",\n \"format\": \"wristband\",\n \"banned\": false,\n \"active\": true,\n \"redeemed\": false,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"ticket_type\": null,\n \"customer\": null\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"new_tag_uid\": \"FFFFFFFFFF\"\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Gtag id (or tag_uid)","default":"","type":"int","name":"id"},{"_id":"59b81850a2d5550038e241a0","ref":"","in":"body","required":true,"desc":"New tag uid of the gtag","default":"","type":"string","name":"new_tag_uid"}],"url":"/:event_id/gtags/:id/replace","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":9,"body":"New gtag did will be created if not present in event","excerpt":"Replaces a customers gtag for another","slug":"gtagsidreplace","type":"post","title":"/gtags/:id/replace","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.147Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/:id/replace
Replaces a customers gtag for another
Path Params
event_id:
integer
Event id
id:
integer
Gtag id (or tag_uid)
Body Params
new_tag_uid:
required
string
New tag uid of the gtag
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5ab296f5a2051c007a8ecea1","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab70","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-21T17:31:33.043Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"text","code":""}]},"results":{"codes":[{"language":"json","code":"[\n {\n\t\t\"event_id\": 317,\n\t\t\"action\": \"sale\",\n\t\t\"description\": \"sale\",\n\t\t\"operation_id\": 21172,\n\t\t\"source\": \"onsite\",\n\t\t\"date\": \"2018-03-21T13:31:16.000+01:00\",\n\t\t\"line_counter\": 1,\n\t\t\"gtag_counter\": 9,\n\t\t\"device_id\": 5356,\n\t\t\"station_id\": 10658,\n\t\t\"customer_id\": 974684,\n\t\t\"customer_gtag_id\": 1993812,\n\t\t\"operator_id\": 974685,\n\t\t\"operator_gtag_id\": 1993813,\n\t\t\"credential_type\": null,\n\t\t\"credential_id\": null,\n\t\t\"ticket_type_id\": null,\n\t\t\"product_id\": null,\n\t\t\"order_id\": null,\n\t\t\"catalog_item_id\": null,\n\t\t\"catalog_item_type\": null,\n\t\t\"sale_item_quantity\": null,\n\t\t\"sale_item_unit_price\": null,\n\t\t\"sale_item_total_price\": null,\n\t\t\"standard_unit_price\": null,\n\t\t\"standard_total_price\": null,\n\t\t\"payment_method\": null,\n\t\t\"monetary_quantity\": null,\n\t\t\"monetary_unit_price\": null,\n\t\t\"monetary_total_price\": null,\n\t\t\"credit_type\": \"CatalogItem\",\n\t\t\"credit_id\": 849,\n\t\t\"credit_name\": \"Virtual\",\n\t\t\"credit_amount\": \"15.0\",\n\t\t\"final_balance\": \"25.0\",\n\t\t\"message\": null,\n\t\t\"priority\": null,\n\t\t\"user_flag_value\": null,\n\t\t\"access_direction\": null\n }\n]","name":"","status":200}]},"settings":"","apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cd6fba677f100154f8eb1","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cd6fba677f100154f8eb0","ref":"","in":"path","required":false,"desc":"Gtag id","default":"","type":"int","name":"gtag_id"}],"url":"/:event_id/gtags/:gtag_id/pokes","method":"get"},"isReference":true,"order":10,"body":"","excerpt":"Get pokes for a gtag","slug":"gtagsidpokes","type":"get","title":"/gtags/:id/pokes","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.148Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/gtags/:id/pokes
Get pokes for a gtag
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d723f32e2ba0900338329ea","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.148Z","createdAt":"2019-09-06T11:12:50.176Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"595ba3bb9ec1a2001512ab70","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"text","code":"https://sandbox.glownet.com/api/v2/events/1/gtags/search?tag_uid=12445678912345"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 563,\n \"tag_uid\": \"12445678912345\",\n \"format\": \"wristband\",\n \"banned\": false,\n \"active\": true,\n \"redeemed\": false,\n \"consistent\": true,\n \"credits\": \"0.0\",\n \"virtual_credits\": \"0.0\",\n \"tokens\": {},\n \"final_balance\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_tokens_balance\": {},\n \"ticket_type\": null,\n \"customer\": {\n \"id\": 1,\n \"first_name\": \"Vicentest\",\n \"last_name\": \"Test\",\n \"email\": \"test@test.com\",\n \"phone\": null,\n \"birthdate\": null,\n \"postcode\": null,\n \"address\": null,\n \"city\": null,\n \"country\": null,\n \"gender\": null,\n \"virtual_money\": \"0.0\",\n \"money\": \"0.0\",\n \"global_refundable_money\": \"0.0\",\n \"balances\": {\n \"1\": 0,\n \"2\": 0,\n \"83\": 0\n },\n \"locale\": \"en\",\n \"anonymous\": false,\n \"refundable\": true,\n \"family_id\": 4,\n \"family_owner\": false,\n \"gtags\": [\n {\n \"id\": 563,\n \"event_id\": 1,\n \"tag_uid\": \"12445678912345\",\n \"banned\": false,\n \"format\": \"wristband\",\n \"active\": true,\n \"virtual_credits\": \"0.0\",\n \"credits\": \"0.0\",\n \"final_virtual_balance\": \"0.0\",\n \"final_balance\": \"0.0\",\n \"customer_id\": 1,\n \"created_at\": \"2019-08-29T12:52:59.615+02:00\",\n \"updated_at\": \"2019-08-29T12:52:59.615+02:00\",\n \"redeemed\": false,\n \"ticket_type_id\": null,\n \"balances\": {},\n \"complete\": true,\n \"consistent\": true,\n \"operator\": false,\n \"tokens\": {},\n \"final_tokens_balance\": {},\n \"autostage\": \"no\"\n }\n ],\n \"tickets\": [],\n \"orders\": []\n }\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d723f32e2ba0900338329eb","ref":"","in":"query","required":false,"desc":"Gtag's tag_uid","default":"","type":"string","name":"tag_uid"}],"url":"/:event_id/gtags/search","method":"post"},"isReference":true,"order":11,"body":"","excerpt":"Searcha gtag by tag_uid","slug":"gtagssearch","type":"post","title":"/gtags/search","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/gtags/search
Searcha gtag by tag_uid
Path Params
event_id:
integer
Event id
Query Params
tag_uid:
string
Gtag's tag_uid
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cab8001467d001526260c","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595caa30175e75003de3ea5f","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T09:04:00.091Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n [\n {\n \"id\": 2,\n \"status\": \"completed\",\n \"total\": \"50.0\",\n \"completed_at\": \"2017-07-05T10:50:42.708+02:00\",\n \"gateway\": \"bank_account\",\n \"customer_id\": 73600,\n \"order_items\": [\n {\n \"id\": 5,\n \"amount\": \"50.0\",\n \"total\": \"50.0\",\n \"redeemed\": false,\n \"counter\": 2\n }\n ]\n },\n {\n \"id\": 3,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-07-05T10:27:55.954+02:00\",\n \"gateway\": null,\n \"customer_id\": 73600,\n \"order_items\": []\n },\n {\n \"id\": 4,\n \"status\": \"completed\",\n \"total\": 0,\n \"completed_at\": \"2017-07-05T10:27:40.177+02:00\",\n \"gateway\": null,\n \"customer_id\": 73600,\n \"order_items\": []\n },\n ]\n}","name":""}]},"auth":"required","params":[{"_id":"595cab8001467d001526260d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d7260598c02280069b7d4aa","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d7260598c02280069b7d4a9","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/orders","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all orders of an event","slug":"testinput-1","type":"get","title":"/orders","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.149Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/orders
Get all orders of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595cc4819c0847002938115b","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595caa30175e75003de3ea5f","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T10:50:41.437Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 3,\n\t\"status\": \"completed\",\n\t\"total\": \"30.0\",\n\t\"completed_at\": \"2017-05-09T13:10:24.650+02:00\",\n\t\"gateway\": \"stripe\",\n\t\"customer_id\": 2,\n\t\"order_items\": [\n \t{\n\t\t\t\"id\": 50,\n\t\t\t\"amount\": \"30.0\",\n\t\t\t\"total\": \"30.0\",\n\t\t\t\"redeemed\": false,\n\t\t\t\"counter\": 1\n\t\t}\n\t]\n}","name":""}]},"auth":"required","params":[{"_id":"595cab8001467d001526260d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cce789d4fd400519acfe5","ref":"","in":"path","required":false,"desc":"Order id","default":"","type":"int","name":"id"}],"url":"/:event_id/orders/:id","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":1,"body":"","excerpt":"Return an order.","slug":"ordersnew","type":"get","title":"/orders/:id","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.149Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/orders/:id
Return an order.
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595cc87f3095af003d4d3ef9","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595caa30175e75003de3ea5f","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:07:43.979Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"event_id\": 1,\n \"id\": 79680,\n \"customer_id\": 73582,\n \"status\": \"completed\",\n \"completed_at\": \"2017-05-09T13:10:24.650+02:00\",\n \"gateway\": \"bank_account\",\n \"refund_data\": {}\n}","name":""}]},"examples":{"codes":[{"code":"{\n \"order\": {\n \"gateway\": \"bank_account\"\n }\n}","language":"json"}]},"auth":"required","params":[{"_id":"595cab8001467d001526260d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cce6d9509ad0033f04423","ref":"","in":"path","required":false,"desc":"Order id","default":"","type":"int","name":"id"},{"_id":"5aa9c8cad4b08700126b34e6","ref":"","in":"body","required":true,"desc":"","default":"","type":"object","name":"order"}],"url":"/:event_id/orders/:id","method":"patch","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":2,"body":"","excerpt":"Modify an order","slug":"ordersid","type":"patch","title":"/orders/:id","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.150Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/orders/:id
Modify an order
Path Params
event_id:
integer
Event id
id:
integer
Order id
Body Params
order:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cce153095af003d4d3f3d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595caa30175e75003de3ea5f","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:31:33.173Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"","language":"json","status":200}]},"examples":{"codes":[{"code":"","language":"json"}]},"auth":"required","params":[{"_id":"595cab8001467d001526260d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cce533095af003d4d3f3e","ref":"","in":"path","required":false,"desc":"Order id","default":"","type":"int","name":"id"}],"url":"/:event_id/orders/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":3,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete an order","slug":"ordersid-2","type":"delete","title":"/orders/:id","__v":11,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.150Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/orders/:id
Delete an order
Path Params
event_id:
integer
Event id
id:
integer
Order id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595cce9f9c084700293811a7","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595caa30175e75003de3ea5f","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T11:33:51.683Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n \"order\": {\n \"payment_data\": \"{}\",\n \"gateway\": \"stripe\"\n },\n \"send_email\": true\n}","language":"json"}]},"results":{"codes":[{"name":"","code":"{\n \"event_id\": 1,\n \"id\": 79680,\n \"status\": \"completed\",\n \"gateway\": \"stripe\",\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"595cab8001467d001526260d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cce533095af003d4d3f3e","ref":"","in":"path","required":false,"desc":"Order id","default":"","type":"int","name":"id"},{"_id":"5a8c1245cdd697002bb65a24","ref":"","in":"body","required":false,"desc":"Send customer an email of this change","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9c92d80b15d00120960cf","ref":"order","in":"body","required":false,"desc":"","default":"","type":"object","name":"order"}],"url":"/:event_id/orders/:id/complete","method":"put","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"","excerpt":"Marks order as complete, can send email if necessary. This is mandatory for order redemption","slug":"ordersidcomplete","type":"put","title":"/orders/:id/complete","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.151Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
put/orders/:id/complete
Marks order as complete, can send email if necessary. This is mandatory for order redemption
Path Params
event_id:
integer
Event id
id:
integer
Order id
Body Params
send_email:
booleanfalse
Send customer an email of this change
order:
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d76388d7cfc9c00406d51ba","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.151Z","createdAt":"2019-09-09T11:33:33.571Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d76372a7cfc9c00406d5187","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 893,\n \"name\": \"50 sta + 15 virtual\",\n \"catalog_items\": [\n {\n \"id\": 837,\n \"type\": \"Credit\",\n \"name\": \"CRD\",\n \"amount\": 50\n },\n {\n \"id\": 838,\n \"type\": \"VirtualCredit\",\n \"name\": \"Virtual\",\n \"amount\": 15\n }\n ],\n \"hidden\": false\n },\n {\n \"id\": 892,\n \"name\": \"Day + Night + VIP\",\n \"catalog_items\": [\n {\n \"id\": 882,\n \"type\": \"Access\",\n \"name\": \"Day\",\n \"amount\": 1\n },\n {\n \"id\": 883,\n \"type\": \"Access\",\n \"name\": \"Night\",\n \"amount\": 1\n },\n {\n \"id\": 884,\n \"type\": \"Access\",\n \"name\": \"VIP\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n },\n {\n \"id\": 891,\n \"name\": \"Day + Camping\",\n \"catalog_items\": [\n {\n \"id\": 882,\n \"type\": \"Access\",\n \"name\": \"Day\",\n \"amount\": 1\n },\n {\n \"id\": 885,\n \"type\": \"Access\",\n \"name\": \"Camping\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n },\n {\n \"id\": 890,\n \"name\": \"Night + VIP\",\n \"catalog_items\": [\n {\n \"id\": 883,\n \"type\": \"Access\",\n \"name\": \"Night\",\n \"amount\": 1\n },\n {\n \"id\": 884,\n \"type\": \"Access\",\n \"name\": \"VIP\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n },\n {\n \"id\": 889,\n \"name\": \"Day + VIP\",\n \"catalog_items\": [\n {\n \"id\": 882,\n \"type\": \"Access\",\n \"name\": \"Day\",\n \"amount\": 1\n },\n {\n \"id\": 884,\n \"type\": \"Access\",\n \"name\": \"VIP\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n },\n {\n \"id\": 888,\n \"name\": \"Day + Night\",\n \"catalog_items\": [\n {\n \"id\": 882,\n \"type\": \"Access\",\n \"name\": \"Day\",\n \"amount\": 1\n },\n {\n \"id\": 883,\n \"type\": \"Access\",\n \"name\": \"Night\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n }\n]","name":"","status":200}]},"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"5aa953502a1896004ba78f70","ref":"","in":"path","required":false,"desc":"ID or slug of event","default":"","type":"mixed","name":"event_id"},{"_id":"5d725ee047c96700358d7160","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"page"},{"_id":"5d725ee047c96700358d715f","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"per_page"}],"url":"/:event_id/packs","method":"get"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all refunds of an event","slug":"packs","type":"get","title":"/packs","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/packs
Get all refunds of an event
Path Params
event_id:
mixed
ID or slug of event
Query Params
page:
integer100
per_page:
integer1
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d7639c2ab429f00cb46a131","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.151Z","createdAt":"2019-09-09T11:38:42.525Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d76372a7cfc9c00406d5187","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"{\n \"id\": 890,\n \"name\": \"Night + VIP\",\n \"catalog_items\": [\n {\n \"id\": 883,\n \"type\": \"Access\",\n \"name\": \"Night\",\n \"amount\": 1\n },\n {\n \"id\": 884,\n \"type\": \"Access\",\n \"name\": \"VIP\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n}","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccc56ae30e6c00300cf267","ref":"","in":"path","required":false,"desc":"Pack id","default":"","type":"int","name":"id"}],"url":"/:event_id/packs/:id","method":"get"},"isReference":true,"order":1,"body":"","excerpt":"Get a refund of an event","slug":"packsid","type":"get","title":"/packs/:id","__v":2,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/packs/:id
Get a refund of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d7651f9a0e41300111c4565","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.152Z","createdAt":"2019-09-09T13:22:01.773Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d76372a7cfc9c00406d5187","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"id\": 890,\n \"name\": \"VIP Night\",\n \"catalog_items\": [\n {\n \"id\": 883,\n \"type\": \"Access\",\n \"name\": \"Night\",\n \"amount\": 1\n },\n {\n \"id\": 884,\n \"type\": \"Access\",\n \"name\": \"VIP\",\n \"amount\": 1\n }\n ],\n \"hidden\": false\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"{\n\t\"pack\": {\n \t\"name\": \"VIP Night\"\n }\n}","language":"json"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccfe4e33dd99001a597d42","ref":"","in":"path","required":false,"desc":"Pack id","default":"","type":"int","name":"id"}],"url":"/:event_id/packs/:id","method":"patch"},"isReference":true,"order":2,"body":"","excerpt":"Modify a refund of an event","slug":"packsid-1","type":"patch","title":"/packs/:id","__v":3,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/packs/:id
Modify a refund of an event
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d765239e36809002bd102c2","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.152Z","createdAt":"2019-09-09T13:23:05.728Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"5d76372a7cfc9c00406d5187","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"","name":"","status":200}]},"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccc56ae30e6c00300cf267","ref":"","in":"path","required":false,"desc":"Pack id","default":"","type":"int","name":"id"}],"url":"/:event_id/packs/:id","method":"delete"},"isReference":true,"order":3,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a refund of an event","slug":"packsid-2","type":"delete","title":"/packs/:id","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/packs/:id
Delete a refund of an event
Path Params
event_id:
integer
Event id
id:
integer
Pack id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"59ccc452f42f220026f970bd","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T09:43:46.968Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 104560,\n \"customer_id\": 1017849,\n \"status\": \"started\",\n \"fields\": {},\n \"credit_base\": \"10.0\",\n \"credit_fee\": \"0.0\",\n \"money_base\": \"10.0\",\n \"money_fee\": \"0.0\"\n },\n {\n \"id\": 104561,\n \"customer_id\": 1017850,\n \"status\": \"started\",\n \"fields\": {},\n \"credit_base\": \"10.0\",\n \"credit_fee\": \"5.0\",\n \"money_base\": \"10.0\",\n \"money_fee\": \"5.0\"\n }\n]","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"5aa953502a1896004ba78f70","ref":"","in":"path","required":false,"desc":"ID or slug of event","default":"","type":"mixed","name":"event_id"},{"_id":"5d725ee047c96700358d7160","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"page"},{"_id":"5d725ee047c96700358d715f","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"per_page"}],"url":"/:event_id/refunds","method":"get"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all refunds of an event","slug":"refunds","type":"get","title":"/refunds","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.153Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/refunds
Get all refunds of an event
Path Params
event_id:
mixed
ID or slug of event
Query Params
page:
integer100
per_page:
integer1
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59ccc569e30e6c00300cf266","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T09:48:25.997Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"{\n \"id\": 19984,\n \"amount\": \"5.0\",\n \"status\": \"started\",\n \"fee\": \"0.0\",\n \"field_a\": null,\n \"field_b\": null,\n \"customer_id\": 32657\n}","name":"","status":200}]},"examples":{"codes":[]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccc56ae30e6c00300cf267","ref":"","in":"path","required":false,"desc":"Refund id","default":"","type":"int","name":"id"}],"url":"/:event_id/refunds/:id","method":"get"},"isReference":true,"order":1,"body":"","excerpt":"Get a refund of an event","slug":"refundsid","type":"get","title":"/refunds/:id","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.153Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/refunds/:id
Get a refund of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"59ccd10c002c4b0032092e8c","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T10:38:04.923Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 999,\n \"customer_id\": 666,\n \"status\": \"started\",\n \"fields\": {},\n \"credit_base\": \"8.0\",\n \"credit_fee\": \"2.0\",\n \"money_base\": \"8.0\",\n \"money_fee\": \"2.0\"\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"refund\": {\n\t\t\"customer_id\": 666,\n\t\t\"credit_fee\": 2,\n\t\t\"credit_base\": 8,\n\t\t\"gateway\": \"paypal\"\n\t}\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa95237b28af00057fe0c15","ref":"refund","in":"body","required":false,"desc":"","default":"","type":"object","name":"refund"}],"url":"/:event_id/refunds","method":"post"},"isReference":true,"order":2,"body":"","excerpt":"Create a new refund of an event","slug":"refunds-1","type":"post","title":"/refunds","__v":11,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.154Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/refunds
Create a new refund of an event
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59ccfdfb899eb00010ef1ebc","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T13:49:47.774Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n\t\"refund\": {\n \t\"amount\": 50\n }\n}","language":"json"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n \"id\": 35775,\n \"amount\": \"50.0\",\n \"status\": null,\n \"fee\": \"0.0\",\n \"field_a\": null,\n \"field_b\": null,\n \"customer_id\": 73566\n}","language":"json","status":200}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595e12b1c6fd260015d25d75","ref":"","in":"body","required":false,"desc":"Refund amount","default":"","type":"float","name":"refund[amount]"},{"_id":"59ccfc04ec17e800269fb3f7","ref":"","in":"body","required":false,"desc":"Refund status","default":"","type":"string","name":"refund[status]"},{"_id":"59ccfc04ec17e800269fb3f6","ref":"","in":"body","required":false,"desc":"Refund fee","default":"","type":"float","name":"refund[fee]"},{"_id":"59ccfc04ec17e800269fb3f5","ref":"","in":"body","required":false,"desc":"Bank account","default":"","type":"string","name":"refund[field_a]"},{"_id":"59ccfc04ec17e800269fb3f4","ref":"","in":"body","required":false,"desc":"Bank account","default":"","type":"string","name":"refund[field_b]"},{"_id":"59ccfc04ec17e800269fb3f3","ref":"","in":"body","required":false,"desc":"Customer id","default":"","type":"int","name":"refund[customer_id]"},{"_id":"59ccfc04ec17e800269fb3f2","ref":"","in":"body","required":false,"desc":"Gateway","default":"","type":"string","name":"refund[gateway]"},{"_id":"59ccfe4e33dd99001a597d42","ref":"","in":"path","required":false,"desc":"Refund id","default":"","type":"int","name":"id"}],"url":"/:event_id/refunds/:id","method":"patch"},"isReference":true,"order":3,"body":"","excerpt":"Modify a refund of an event","slug":"refunds-2","type":"patch","title":"/refunds/:id","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.154Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/refunds/:id
Modify a refund of an event
Path Params
event_id:
integer
Event id
id:
integer
Refund id
Body Params
refund[amount]:
float
Refund amount
refund[status]:
string
Refund status
refund[fee]:
float
Refund fee
refund[field_a]:
string
Bank account
refund[field_b]:
string
Bank account
refund[customer_id]:
integer
Customer id
refund[gateway]:
string
Gateway
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59ccff46fba443003c769375","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T13:55:18.156Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccc56ae30e6c00300cf267","ref":"","in":"path","required":false,"desc":"Refund id","default":"","type":"int","name":"id"}],"url":"/:event_id/refunds/:id","method":"delete"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a refund of an event","slug":"refundsid-1","type":"delete","title":"/refunds/:id","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.155Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/refunds/:id
Delete a refund of an event
Path Params
event_id:
integer
Event id
id:
integer
Refund id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"59cd017e33dd99001a597d9d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-28T14:04:46.573Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n \t\"gateway\": \"paypal\",\n\t\"send_email\": true\n}"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n \"id\": 104563,\n \"customer_id\": 666,\n \"status\": \"completed\",\n \"fields\": {},\n \"credit_base\": \"197.0\",\n \"credit_fee\": \"3.0\",\n \"money_base\": \"394.0\",\n \"money_fee\": \"6.0\"\n}","language":"json","status":200}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccfe4e33dd99001a597d42","ref":"","in":"path","required":false,"desc":"Refund id","default":"","type":"int","name":"id"},{"_id":"5a8c0ff9f4146e00449cee78","ref":"","in":"body","required":false,"desc":"Send email to customer from Glownet about refund","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa96d74ccf534000f6056e9","ref":"","in":"body","required":false,"desc":"payment gateway used for refund","default":"other","type":"string","name":"gateway"}],"url":"/:event_id/refunds/:id/complete","method":"put"},"isReference":true,"order":5,"body":"","excerpt":"Marks refund as complete, can send email if necessary. This is mandatory for order redemption","slug":"refundsidcomplete","type":"put","title":"/refunds/:id/complete","__v":15,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.155Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
put/refunds/:id/complete
Marks refund as complete, can send email if necessary. This is mandatory for order redemption
Path Params
event_id:
integer
Event id
id:
integer
Refund id
Body Params
send_email:
booleanfalse
Send email to customer from Glownet about refund
gateway:
stringother
payment gateway used for refund
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5a8c1096cdd697002bb659fd","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"59ccc3fb6a44e80026bfefc6","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-02-20T12:12:06.215Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"id\": 104563,\n \"customer_id\": 666,\n \"status\": \"cancelled\",\n \"fields\": {},\n \"credit_base\": \"197.0\",\n \"credit_fee\": \"3.0\",\n \"money_base\": \"394.0\",\n \"money_fee\": \"6.0\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"{\n\t\"send_email\": true\n}","language":"json"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59ccfe4e33dd99001a597d42","ref":"","in":"path","required":false,"desc":"Refund id","default":"","type":"int","name":"id"},{"_id":"5a8c0ff9f4146e00449cee78","ref":"","in":"body","required":false,"desc":"","default":"false","type":"boolean","name":"send_email"}],"url":"/:event_id/refunds/:id/cancel","method":"put"},"isReference":true,"order":6,"body":"","excerpt":"Marks refund as cancelled, can send email if necessary","slug":"refundsidcancel","type":"put","title":"/refunds/:id/cancel","__v":8,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.156Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
put/refunds/:id/cancel
Marks refund as cancelled, can send email if necessary
Path Params
event_id:
integer
Event id
id:
integer
Refund id
Body Params
send_email:
booleanfalse
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9c3a6fc00f00012042e75","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T00:51:50.658Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 10966,\n \"name\": \"BAR 1\",\n \"group\": \"monetary\",\n \"location\": \"\",\n \"category\": \"bar\",\n \"reporting_category\": null,\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false,\n \"products\": [\n {\n \"id\": 61090,\n \"name\": \"Product 1\",\n \"description\": null,\n \"is_alcohol\": true,\n \"vat\": 0,\n \"price\": 1,\n \"position\": 1\n },\n {\n \"id\": 61091,\n \"name\": \"Product 2\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 2,\n \"position\": 2\n }\n ]\n }\n]","name":"","status":200}]},"settings":"","auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d725f5decc92202565fc502","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d725f5decc92202565fc501","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"url":"/:event_id/stations","method":"get"},"isReference":true,"order":0,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","excerpt":"Get all stations of an event","slug":"stations","type":"get","title":"/stations","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.156Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/stations
Get all stations of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5aa9c466cf3a8a00128068cb","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T00:55:02.461Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"name":"","code":"{\n \"id\": 10966,\n \"name\": \"BAR 1\",\n \"group\": \"monetary\",\n \"location\": \"\",\n \"category\": \"bar\",\n \"reporting_category\": null,\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false,\n \"credits_sold\": \"73742.5\",\n \"virtual_credits_sold\": \"48.0\",\n \"products\": [\n {\n \"id\": 61090,\n \"name\": \"Product 1\",\n \"description\": null,\n \"is_alcohol\": true,\n \"vat\": 0,\n \"price\": 1,\n \"position\": 1,\n \t\"credits_sold\": \"0.0\",\n \"virtual_credits_sold\": \"0.0\",\n \"quantity_sold\": 0\n },\n {\n \"id\": 61091,\n \"name\": \"Product 2\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 2,\n \"position\": 2,\n \t\"credits_sold\": \"0.0\",\n \"virtual_credits_sold\": \"0.0\",\n \"quantity_sold\": 0\n }\n ]\n}","language":"json","status":200}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"id"}],"url":"/:event_id/stations/:id","method":"get"},"isReference":true,"order":1,"body":"","excerpt":"Get station of an event","slug":"stationsid","type":"get","title":"/stations/:id","__v":10,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.157Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/stations/:id
Get station of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5aa9c526cf3a8a00128068cd","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"5ba9ee7c64b8c60003f1d903","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T00:58:14.625Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"json","code":"{\n \"name\": \"BAR 1\",\n \"location\": \"\",\n \"category\": 'bar',\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 10966,\n \"name\": \"BAR 1\",\n \"group\": \"monetary\",\n \"location\": \"\",\n \"category\": \"bar\",\n \"reporting_category\": null,\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false\n}","name":""}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9c25a9d3d0500120fd7b4","ref":"access","in":"body","required":true,"desc":"","default":"","type":"object","name":"station"}],"url":"/:event_id/stations","method":"post"},"isReference":true,"order":2,"body":"","excerpt":"Create a new station","slug":"stations-1","type":"post","title":"/stations","__v":8,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.157Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/stations
Create a new station
Path Params
event_id:
integer
Event id
Body Params
station:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9c568cf3a8a00128068ce","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T00:59:20.367Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"code":"{\n \"id\": 10966,\n \"name\": \"BAR 1\",\n \"group\": \"monetary\",\n \"location\": \"\",\n \"category\": \"bar\",\n \"reporting_category\": null,\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false\n}","language":"json"}]},"results":{"codes":[{"name":"","code":"{\n \"id\": 10966,\n \"name\": \"BAR 1\",\n \"group\": \"monetary\",\n \"location\": \"\",\n \"category\": \"bar\",\n \"reporting_category\": null,\n \"address\": null,\n \"registration_num\": null,\n \"official_name\": null,\n \"hidden\": false,\n \"products\": [\n {\n \"id\": 61090,\n \"name\": \"Product 1\",\n \"description\": null,\n \"is_alcohol\": true,\n \"vat\": 0,\n \"price\": 1,\n \"position\": 1\n },\n {\n \"id\": 61091,\n \"name\": \"Product 2\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 2,\n \"position\": 2\n }\n ]\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"id"},{"_id":"5aa9c28ad4b08700126b34d1","ref":"station","in":"body","required":true,"desc":"","default":"","type":"object","name":"station"}],"url":"/:event_id/stations/:id","method":"patch"},"isReference":true,"order":3,"body":"","excerpt":"Modify a station of an event","slug":"stationsid-1","type":"patch","title":"/stations/:id","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.158Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/stations/:id
Modify a station of an event
Path Params
event_id:
integer
Event id
id:
integer
Station id
Body Params
station:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9c590cf3a8a00128068cf","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"569fb4e041766e0d00b28bdd","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:00:00.445Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"","language":"json","status":200}]},"auth":"required","params":[{"_id":"595cfa00d4bc0f0033d1e651","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cfec41375bd0049129c75","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"id"}],"url":"/:event_id/stations/:id","method":"delete"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete station from an event","slug":"stationsid-2","type":"delete","title":"/stations/:id","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.158Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/stations/:id
Delete station from an event
Path Params
event_id:
integer
Event id
id:
integer
Station id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595d09f7d4bc0f0033d1e66f","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:47:03.748Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"language":"json","code":"[\n {\n \"id\": 18763,\n \"name\": \"Long Drink\",\n \"description\": \"\",\n \"is_alcohol\": true,\n \"vat\": 21,\n \"price\": 10,\n \"position\": 1\n },\n {\n \"id\": 18764,\n \"name\": \"Beer\",\n \"description\": null,\n \"is_alcohol\": true,\n \"vat\": 21,\n \"price\": 5,\n \"position\": 2\n },\n {\n \"id\": 18765,\n \"name\": \"Shots\",\n \"description\": null,\n \"is_alcohol\": true,\n \"vat\": 21,\n \"price\": 4,\n \"position\": 3\n }\n]","name":"","status":200}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"595bbb598b75a4003f1b5785","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59bbd77f63d94300101c6673","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"station_id"}],"url":"/:event_id/stations/:station_id/products","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":5,"body":"","excerpt":"Get all products of an station","slug":"products","type":"get","title":"/stations/:station_id/products","__v":6,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.159Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/stations/:station_id/products
Get all products of an station
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595d0a111375bd0049129ce7","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:47:29.681Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 19439,\n \"name\": \"Red Bull XXL\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 3,\n \"position\": 18\n}","name":""}]},"auth":"required","params":[{"_id":"595bbac8ed4095001bbc0b74","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59bbd8c563d94300101c669b","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"station_id"},{"_id":"595bbac8ed4095001bbc0b73","ref":"","in":"path","required":false,"desc":"Product id","default":"","type":"int","name":"id"}],"url":"/:event_id/stations/:station_id/products/:id","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":6,"body":"","excerpt":"Get a product of a station","slug":"productsid","type":"get","title":"/stations/:station_id/products/:id","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.159Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/stations/:station_id/products/:id
Get a product of a station
Path Params
event_id:
integer
Event id
station_id:
integer
Station id
id:
integer
Product id
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595d0a0291f29200158114ba","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:47:14.270Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"Event within tokens","code":"{\n\t\"product\": {\n \"name\": \"Red Bull XXL\",\n \"prices\": {\n \t\"{credit_id}\": {\n \"price\": 3\n },\n \t \t\"{token_id}\": {\n \"price\": 3\n }\n\t\t}\n }\n}","language":"json"},{"name":"Event without tokens","language":"json","code":"{\n\t\"product\": {\n \"name\": \"Red Bull XXL\",\n \"price\": 3\n }\n}"}]},"settings":"","results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 19439,\n \"name\": \"Red Bull XXL\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 3,\n \"position\": 18\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59bbd872c4f8e900301b726e","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"station_id"},{"_id":"5aa9c6c580b15d001209606a","ref":"product","in":"body","required":true,"desc":"","default":"","type":"object","name":"product"}],"url":"/:event_id/stations/:station_id/products","method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":7,"body":"","excerpt":"Create a new product for a station","slug":"products-1","type":"post","title":"/stations/:station_id/products","__v":12,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.160Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/stations/:station_id/products
Create a new product for a station
Path Params
event_id:
integer
Event id
station_id:
integer
Station id
Body Params
product:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"59bbd942c7d95f0026eb045d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-09-15T13:44:34.913Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 19439,\n \"name\": \"Red Bull XXXL\",\n \"description\": null,\n \"is_alcohol\": false,\n \"vat\": 0,\n \"price\": 4,\n \"position\": 18\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"product\": {\n \"name\": \"Red Bull XXXL\",\n \"price\": 4\n }\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59bbd872c4f8e900301b726e","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"station_id"},{"_id":"59bbd97b63d94300101c669d","ref":"","in":"path","required":false,"desc":"Product id","default":"","type":"int","name":"id"},{"_id":"5aa9c7349d3d0500120fd87e","ref":"product","in":"body","required":true,"desc":"","default":"","type":"object","name":"product"}],"url":"/:event_id/stations/:station_id/products/:id","method":"patch","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":8,"body":"","excerpt":"Create a new product of an event","slug":"productsid-1","type":"patch","title":"/stations/:station_id/products/:id","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.160Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/stations/:station_id/products/:id
Create a new product of an event
Path Params
event_id:
integer
Event id
station_id:
integer
Station id
id:
integer
Product id
Body Params
product:
required
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595d0a3878dc10005d3f1731","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"5aa9c391fc00f00012042e54","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T15:48:08.158Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"text","code":""}]},"settings":"","examples":{"codes":[]},"auth":"required","params":[{"_id":"595bbac8ed4095001bbc0b74","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"59bbd91bc7d95f0026eb045c","ref":"","in":"path","required":false,"desc":"Station id","default":"","type":"int","name":"station_id"},{"_id":"595bbac8ed4095001bbc0b73","ref":"","in":"path","required":false,"desc":"Product id","default":"","type":"int","name":"id"}],"url":"/:event_id/stations/:station_id/products/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":9,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a product of an station","slug":"productsid-3","type":"delete","title":"/stations/:station_id/products/:id","__v":8,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.161Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/stations/:station_id/products/:id
Delete a product of an station
Path Params
event_id:
integer
Event id
station_id:
integer
Station id
id:
integer
Product id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"595ba3bb9ec1a2001512ab74","api":{"url":"/:event_id/tickets","auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"595ba7075b9c8d005117b7ac","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d7260f633bb6e002d3a24ed","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d7260f633bb6e002d3a24ec","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"results":{"codes":[{"status":200,"language":"json","code":"[\n {\n \"id\": 1530691,\n \"code\": \"3F266FEF0DD33E54B1F360013A393420\",\n \"redeemed\": false,\n \"banned\": false,\n \"customer_id\": 666,\n \"ticket_type_id\": 46022\n }\n]","name":""}]},"settings":"","apiSetting":"59f6ff2927b9410024d0d6fb"},"hidden":false,"isReference":true,"order":0,"project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","createdAt":"2016-01-20T12:42:16.527Z","link_url":"","type":"get","user":"5ba9ee7c64b8c60003f1d903","category":"595ba3bb9ec1a2001512ab6c","excerpt":"Get all tickets of an event","slug":"get-tickets","updates":[],"__v":15,"body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page) paginate json","githubsync":"","link_external":false,"parentDoc":null,"sync_unique":"","title":"/tickets","next":{"description":"","pages":[]},"updatedAt":"2019-09-24T13:37:31.161Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/tickets
Get all tickets of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ba3bb9ec1a2001512ab75","excerpt":"Get ticket of an event","title":"/tickets/:id","parentDoc":null,"__v":11,"api":{"examples":{"codes":[]},"method":"get","params":[{"_id":"595c9567047835003dc4432d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"569f821c6c5c930d007e22c7","ref":"","in":"path","required":false,"desc":"Ticket id or code","default":"","type":"int","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 1530691,\n \"code\": \"3F266FEF0DD33E54B1\",\n \"redeemed\": false,\n \"banned\": false,\n \t\"purchaser_first_name\": \"John\",\n\t\t\"purchaser_last_name\": \"Doe\",\n\t\t\"purchaser_email\": \"john@doe.com\",\n \"ticket_type_id\": 5,\n \"customer_id\": 1\n}","name":""}]},"settings":"","url":"/:event_id/tickets/:id","auth":"required","apiSetting":"59f6ff2927b9410024d0d6fb"},"githubsync":"","hidden":false,"isReference":true,"order":1,"project":"569f7ef06c5c930d007e22bd","type":"get","version":"595ba3bb9ec1a2001512ab8f","body":"","category":"595ba3bb9ec1a2001512ab6c","link_external":false,"link_url":"","sync_unique":"","createdAt":"2016-01-20T12:48:28.783Z","editedParams":true,"editedParams2":true,"slug":"get-tickets-id","updates":[],"user":"59a5ad0f27cc70002fcb1063","next":{"pages":[],"description":""},"updatedAt":"2019-09-24T13:37:31.162Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/tickets/:id
Get ticket of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ba3bb9ec1a2001512ab76","updates":[],"link_url":"","next":{"description":"","pages":[]},"parentDoc":null,"link_external":false,"__v":15,"editedParams":true,"isReference":true,"hidden":false,"order":2,"project":"569f7ef06c5c930d007e22bd","slug":"post-tickets","sync_unique":"","api":{"params":[{"_id":"595badb078252e00417253b8","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5aa9711eb28af00057fe53c1","ref":"ticket","in":"body","required":false,"desc":"","default":"","type":"object","name":"ticket"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 1530691,\n \"code\": \"3F266FEF0DD33E54B1\",\n \"redeemed\": false,\n \"banned\": false,\n \t\"purchaser_first_name\": \"John\",\n\t\t\"purchaser_last_name\": \"Doe\",\n\t\t\"purchaser_email\": \"john@doe.com\",\n \"ticket_type_id\": 5,\n \"customer_id\": 1\n}","name":""}]},"settings":"","url":"/:event_id/tickets","auth":"required","examples":{"codes":[{"code":"{\n\t\"ticket\": {\n\t\t\"code\": \"3F266FEF0DD33E54B1\",\n\t\t\"purchaser_first_name\": \"John\",\n\t\t\"purchaser_last_name\": \"Doe\",\n\t\t\"purchaser_email\": \"john@doe.com\",\n\t\t\"ticket_type_id\": 5,\n\t\t\"customer_id\": 1\n\t}\n}","language":"json"}]},"method":"post","apiSetting":"59f6ff2927b9410024d0d6fb"},"category":"595ba3bb9ec1a2001512ab6c","githubsync":"","user":"59a5ad0f27cc70002fcb1063","editedParams2":true,"excerpt":"Create a new ticket","title":"/tickets","type":"post","version":"595ba3bb9ec1a2001512ab8f","body":"","createdAt":"2016-01-20T12:50:24.019Z","updatedAt":"2019-09-24T13:37:31.162Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets
Create a new ticket
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595ba3bb9ec1a2001512ab77","createdAt":"2016-01-20T12:52:38.938Z","editedParams2":true,"order":3,"slug":"patch-tickets","excerpt":"Modify a ticket of an event","githubsync":"","hidden":false,"isReference":true,"version":"595ba3bb9ec1a2001512ab8f","api":{"results":{"codes":[{"code":"{\n\t\"ticket\": {\n\t\t\"code\": \"3F266FEF0DD33E54B1\",\n\t\t\"purchaser_first_name\": \"John\",\n\t\t\"purchaser_last_name\": \"Doe\",\n\t\t\"purchaser_email\": \"john@doe.com\",\n\t\t\"ticket_type_id\": 5,\n\t\t\"customer_id\": 1\n\t}\n}","language":"json","status":200,"name":""}]},"settings":"","url":"/:event_id/tickets/:id","auth":"required","examples":{"codes":[{"language":"json","code":"{\n\t\"ticket\": {\n\t\t\"code\": \"3F266FEF0DD33E54B1\",\n\t\t\"purchaser_first_name\": \"John\",\n\t\t\"purchaser_last_name\": \"Doe\",\n\t\t\"purchaser_email\": \"john@doe.com\",\n\t\t\"ticket_type_id\": 5,\n\t\t\"customer_id\": 1\n\t}\n}"}]},"method":"patch","params":[{"_id":"595c9d2649658c001b1ad86f","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595c9d2649658c001b1ad86e","ref":"","in":"path","required":false,"desc":"Ticket id or code","default":"","type":"int","name":"id"},{"_id":"5aa9719accf534000f6057a4","ref":"ticket","in":"body","required":false,"desc":"","default":"","type":"object","name":"ticket"}],"apiSetting":"59f6ff2927b9410024d0d6fb"},"title":"/tickets/:id","type":"patch","updates":[],"body":"","category":"595ba3bb9ec1a2001512ab6c","editedParams":true,"link_external":false,"link_url":"","parentDoc":null,"project":"569f7ef06c5c930d007e22bd","sync_unique":"","__v":23,"user":"59a5ad0f27cc70002fcb1063","next":{"pages":[],"description":""},"updatedAt":"2019-09-24T13:37:31.163Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/tickets/:id
Modify a ticket of an event
Path Params
event_id:
integer
Event id
id:
integer
Ticket id or code
Body Params
ticket:
object
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595c9cf549658c001b1ad86b","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T08:01:57.773Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":""}]},"results":{"codes":[{"code":"","language":"json","status":200}]},"auth":"required","params":[{"_id":"595c9cf549658c001b1ad86d","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595c9cf549658c001b1ad86c","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"id"}],"url":"/:event_id/tickets/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a ticket of an event","slug":"testinput","type":"delete","title":"/tickets/:id","__v":11,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.163Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/tickets/:id
Delete a ticket of an event
Path Params
event_id:
integer
Event id
id:
integer
Event id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"5aa9cb67d4b08700126b351d","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:24:55.191Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"Credit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Ticket id (or code)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1299cdd697002bb65a47","ref":"","in":"body","required":false,"desc":"Send email to customer","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9ca6e9d3d0500120fd8d9","ref":"","in":"body","required":false,"desc":"Amount paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9ca6e9d3d0500120fd8d8","ref":"","in":"body","required":false,"desc":"Amount paid by customer as fee","default":"0.00","type":"float","name":"money_fee"}],"url":"/:event_id/tickets/:id/topup","method":"post"},"isReference":true,"order":5,"body":"","excerpt":"Create a topup for a ticket","slug":"ticketsidtopup","type":"post","title":"/tickets/:id/topup","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.164Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/:id/topup
Create a topup for a ticket
Path Params
event_id:
integer
Event id
id:
integer
Ticket id (or code)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer
money_base:
float0.00
Amount paid by customer in currency
money_fee:
float0.00
Amount paid by customer as fee
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9cb7cd4b08700126b351e","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:25:16.558Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": null,\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"10.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"VirtualCredit\",\n \"credits\": \"50.0\"\n }\n ]\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Ticket id (or code)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1363c4fa5b0049f3516f","ref":"","in":"body","required":false,"desc":"Send email to customer about operation","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9cab1cf3a8a00128068fd","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9cab1cf3a8a00128068fc","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_fee"}],"url":"/:event_id/tickets/:id/virtual_topup","method":"post"},"isReference":true,"order":6,"body":"","excerpt":"Create a virtual topup for a ticket","slug":"ticketsidvirtual_topup","type":"post","title":"/tickets/:id/virtual_topup","__v":5,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.164Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/:id/virtual_topup
Create a virtual topup for a ticket
Path Params
event_id:
integer
Event id
id:
integer
Ticket id (or code)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer about operation
money_base:
float0.00
Money paid by customer in currency
money_fee:
float0.00
Money paid by customer in currency
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5d6ceb722338c600277e82da","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.165Z","createdAt":"2019-09-02T10:14:10.148Z","project":"569f7ef06c5c930d007e22bd","user":"5c0a5d58d6680101885d0d25","category":"595ba3bb9ec1a2001512ab6c","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"gateway\": \"paypal\",\n \"token_id\": 8569,\n\t\"credits\": 50,\n\t\"send_email\": true,\n\t\"money_base\": 30,\n\t\"money_fee\": 2\n}"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 401621,\n \"customer_id\": 1017849,\n \"status\": \"completed\",\n \"description\": null,\n \"completed_at\": \"2018-03-15T02:20:16.182+01:00\",\n \"gateway\": \"paypal\",\n \"money_base\": \"30.0\",\n \"money_fee\": \"2.0\",\n \"order_items\": [\n {\n \"id\": 404138,\n \"amount\": \"50.0\",\n \"redeemed\": false,\n \"counter\": 3,\n \"catalog_item_id\": 8569,\n \"catalog_item_type\": \"Token\",\n \"credits\": \"0.0\"\n }\n ]\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Ticket id (or code)","default":"","type":"int","name":"id"},{"_id":"595cc5c83ae8480033535fe0","ref":"","in":"body","required":true,"desc":"Credits to be topped up","default":"","type":"float","name":"credits"},{"_id":"595cc5c83ae8480033535fe1","ref":"","in":"body","required":false,"desc":"Payment gateway used to pay for credits","default":"","type":"string","name":"gateway"},{"_id":"5a8c1363c4fa5b0049f3516f","ref":"","in":"body","required":false,"desc":"Send email to customer about operation","default":"false","type":"boolean","name":"send_email"},{"_id":"5aa9cab1cf3a8a00128068fd","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_base"},{"_id":"5aa9cab1cf3a8a00128068fc","ref":"","in":"body","required":false,"desc":"Money paid by customer in currency","default":"0.00","type":"float","name":"money_fee"},{"_id":"5d6ceb722338c600277e82db","ref":"","in":"body","required":false,"desc":"Token's Catalog Item Id","default":"","type":"int","name":"token_id"}],"url":"/:event_id/tickets/:id/token_topup","method":"post"},"isReference":true,"order":7,"body":"","excerpt":"Create a virtual topup for a ticket","slug":"ticketsidtoken_topup","type":"post","title":"/tickets/:id/token_topup","__v":6,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/:id/token_topup
Create a virtual topup for a ticket
Path Params
event_id:
integer
Event id
id:
integer
Ticket id (or code)
Body Params
credits:
required
float
Credits to be topped up
gateway:
string
Payment gateway used to pay for credits
send_email:
booleanfalse
Send email to customer about operation
money_base:
float0.00
Money paid by customer in currency
money_fee:
float0.00
Money paid by customer in currency
token_id:
integer
Token's Catalog Item Id
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"5aa9cbedcf3a8a0012806924","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:27:09.237Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Ticket id (or code)","default":"","type":"int","name":"id"}],"url":"/:event_id/tickets/:id/ban","method":"post"},"isReference":true,"order":8,"body":"","excerpt":"Ban a ticket of an event","slug":"ticketsidban","type":"post","title":"/tickets/:id/ban","__v":3,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.165Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/:id/ban
Ban a ticket of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5aa9cc0ccf3a8a0012806925","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:27:40.091Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"text","code":""}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"id\": 2022309,\n\t\"tag_uid\": \"12345671234567\",\n\t\"banned\": false,\n\t\"redeemed\": false,\n\t\"active\": true,\n\t\"consistent\": true,\n\t\"credits\": \"0.0\",\n\t\"virtual_credits\": \"0.0\",\n\t\"final_balance\": \"0.0\",\n\t\"final_virtual_balance\": \"0.0\",\n\t\"customer_id\": 666,\n\t\"ticket_type_id\": null\n}","name":""}]},"auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cb4b5a677f100154f8de2","ref":"","in":"path","required":false,"desc":"Ticket id (or code)","default":"","type":"int","name":"id"}],"url":"/:event_id/tickets/:id/unban","method":"post"},"isReference":true,"order":9,"body":"","excerpt":"Unban a ticket of an event","slug":"ticketsidunban","type":"post","title":"/tickets/:id/unban","__v":3,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.166Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/:id/unban
Unban a ticket of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5ab297275197f80025812174","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6c","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-21T17:32:23.950Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","settings":"","results":{"codes":[{"language":"json","code":"[\n {\n\t\t\"event_id\": 317,\n\t\t\"action\": \"sale\",\n\t\t\"description\": \"sale\",\n\t\t\"operation_id\": 21172,\n\t\t\"source\": \"onsite\",\n\t\t\"date\": \"2018-03-21T13:31:16.000+01:00\",\n\t\t\"line_counter\": 1,\n\t\t\"gtag_counter\": 9,\n\t\t\"device_id\": 5356,\n\t\t\"station_id\": 10658,\n\t\t\"customer_id\": 974684,\n\t\t\"customer_gtag_id\": 1993812,\n\t\t\"operator_id\": 974685,\n\t\t\"operator_gtag_id\": 1993813,\n\t\t\"credential_type\": \"Ticket\",\n\t\t\"credential_id\": 3422,\n\t\t\"ticket_type_id\": null,\n\t\t\"product_id\": null,\n\t\t\"order_id\": null,\n\t\t\"catalog_item_id\": null,\n\t\t\"catalog_item_type\": null,\n\t\t\"sale_item_quantity\": null,\n\t\t\"sale_item_unit_price\": null,\n\t\t\"sale_item_total_price\": null,\n\t\t\"standard_unit_price\": null,\n\t\t\"standard_total_price\": null,\n\t\t\"payment_method\": null,\n\t\t\"monetary_quantity\": null,\n\t\t\"monetary_unit_price\": null,\n\t\t\"monetary_total_price\": null,\n\t\t\"credit_type\": \"CatalogItem\",\n\t\t\"credit_id\": 849,\n\t\t\"credit_name\": \"Virtual\",\n\t\t\"credit_amount\": \"15.0\",\n\t\t\"final_balance\": \"25.0\",\n\t\t\"message\": null,\n\t\t\"priority\": null,\n\t\t\"user_flag_value\": null,\n\t\t\"access_direction\": null\n }\n]","name":"","status":200}]},"examples":{"codes":[{"language":"text","code":""}]},"auth":"required","params":[{"_id":"595cd6fba677f100154f8eb1","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cd6fba677f100154f8eb0","ref":"","in":"path","required":false,"desc":"Ticket id","default":"","type":"int","name":"ticket_id"}],"url":"/:event_id/tickets/:ticket_id/pokes","method":"get"},"isReference":true,"order":10,"body":"","excerpt":"Get pokes for a ticket","slug":"ticketsidpokes","type":"get","title":"/tickets/:id/pokes","__v":3,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.166Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/tickets/:id/pokes
Get pokes for a ticket
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"5d723fdd7706d802ad6754f9","version":"595ba3bb9ec1a2001512ab8f","updatedAt":"2019-09-24T13:37:31.167Z","createdAt":"2019-09-06T11:15:41.950Z","project":"569f7ef06c5c930d007e22bd","user":"5ba9ee7c64b8c60003f1d903","category":"595ba3bb9ec1a2001512ab6c","updates":[],"next":{"pages":[],"description":""},"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 65,\n \"code\": \"6B5D61A7A9CD6CA5CC8B5F160058B488\",\n \"redeemed\": false,\n \"banned\": false,\n \"purchaser_first_name\": null,\n \"purchaser_last_name\": null,\n \"purchaser_email\": null,\n \"ticket_type_id\": 13,\n \"customer_id\": null,\n \"credits\": 0,\n \"virtual_credits\": 0,\n \"tokens_info\": [],\n \"operator\": true\n}","name":""}]},"settings":"","examples":{"codes":[{"language":"text","code":"https://sandbox.glownet.com/api/v2/events/1/tickets/search?code=6B5D61A7A9CD6CA5CC8B5F160058B488"}]},"apiSetting":"59f6ff2927b9410024d0d6fb","auth":"required","params":[{"_id":"595cb1125c6c83001bde9d05","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d723fdd7706d802ad6754fa","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"code"}],"url":"/:event_id/tickets/search","method":"post"},"isReference":true,"order":11,"body":"","excerpt":"Search a ticket by code","slug":"ticketssearch","type":"post","title":"/tickets/search","__v":1,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/tickets/search
Search a ticket by code
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595ba3bb9ec1a2001512ab78","sync_unique":"","title":"/ticket_types","__v":15,"excerpt":"Get all ticket types of an event","githubsync":"","link_external":false,"link_url":"","parentDoc":null,"type":"get","createdAt":"2016-01-20T14:25:25.165Z","hidden":false,"api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"_id":"595ce995175e75003de3ec25","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d726033eaaf410034796655","ref":"","in":"query","required":false,"desc":"","default":"1","type":"int","name":"page"},{"_id":"5d726033eaaf410034796654","ref":"","in":"query","required":false,"desc":"","default":"100","type":"int","name":"per_page"}],"results":{"codes":[{"code":"[\n {\n \"id\": 2618,\n \"name\": \"0 Credits\",\n \"company_code\": \"\",\n \"company\": \"Glownet\",\n \"color\": \"#196976\",\n \"catalog_item\": null\n },\n {\n \"id\": 2619,\n \"name\": \"GA + 5 Free Drinks\",\n \"company_code\": \"\",\n \"company\": \"Glownet\",\n \"color\": \"#e84888\",\n \"catalog_item\": {\n \"id\": 314,\n \"name\": \"GA + 5 TKD\",\n \"type\": \"Pack\"\n }\n },\n {\n \"id\": 2760,\n \"name\": \"ABONO 16 ENTRADA\",\n \"company_code\": \"\",\n \"company\": \"Glownet\",\n \"color\": \"#195636\",\n \"catalog_item\": null\n },\n {\n \"id\": 2758,\n \"name\": \"DIA 16 ENTRADA\",\n \"company_code\": \"\",\n \"company\": \"Glownet\",\n \"color\": \"#190336\",\n \"catalog_item\": null\n }\n]","name":"","status":200,"language":"json"}]},"settings":"","url":"/:event_id/ticket_types","apiSetting":"59f6ff2927b9410024d0d6fb"},"category":"595ba3bb9ec1a2001512ab6d","isReference":true,"updates":[],"version":"595ba3bb9ec1a2001512ab8f","body":"Response headers includes pagination info: Total (total resource number) and Per-Page(resources per page)","next":{"description":"","pages":[]},"order":0,"project":"569f7ef06c5c930d007e22bd","slug":"get-ticket_types","user":"5c0a5d58d6680101885d0d25","updatedAt":"2019-09-24T13:37:31.167Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/ticket_types
Get all ticket types of an event
Path Params
event_id:
integer
Event id
Query Params
page:
integer1
per_page:
integer100
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595cecb61375bd0049129c22","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6d","user":"5c0a5d58d6680101885d0d25","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T13:42:14.652Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"id\": 2918,\n \"name\": \"VIP Pass\",\n \"company_code\": null,\n \"company\": \"Glownet\",\n \"color\": \"#e84888\",\n \"catalog_item\": {\n \"id\": 574,\n \"name\": \"VIP Pass\",\n \"type\": \"Pack\"\n }\n}","name":""}]},"examples":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"595ce9caa677f100154f8f69","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595ceccc01467d001526270d","ref":"","in":"path","required":false,"desc":"Ticket type id","default":"","type":"int","name":"id"}],"url":"/:event_id/ticket_types/:id","method":"get","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":1,"body":"","excerpt":"Get a ticket type of an event","slug":"ticket_typesid","type":"get","title":"/ticket_types/:id","__v":9,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.167Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
get/ticket_types/:id
Get a ticket type of an event
Definition
{{ api_url }}{{ page_api_url }}
Result Format
{"_id":"595ba3bb9ec1a2001512ab7a","version":"595ba3bb9ec1a2001512ab8f","editedParams":true,"isReference":true,"link_url":"","order":2,"next":{"pages":[],"description":""},"user":"5c0a5d58d6680101885d0d25","api":{"settings":"","url":"/:event_id/ticket_types","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"ticket_type\": {\n \"name\": \"VIP Ticket\",\n \"company_code\": \"123AA\",\n \"color\": \"#196936\"\n }\n}"}]},"method":"post","params":[{"_id":"595ce9caa677f100154f8f69","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"5d7904e300464f00481811d8","ref":"","in":"body","required":true,"desc":"Name of the Ticket Type","default":"","type":"string","name":"name"},{"_id":"5d7904e300464f00481811d7","ref":"","in":"body","required":false,"desc":"If used, must be unique","default":"","type":"string","name":"company_code"},{"_id":"5d7904e300464f00481811d6","ref":"","in":"body","required":false,"desc":"Hexadecimal color","default":"","type":"string","name":"color"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n \"id\": 2918,\n \"name\": \"VIP Ticket\",\n \"company_code\": \"123AA\",\n \"company\": \"[Organization Name]\",\n \"color\": \"#196936\",\n \"catalog_item\": null\n}","name":""}]},"apiSetting":"59f6ff2927b9410024d0d6fb"},"createdAt":"2016-01-20T14:41:14.969Z","githubsync":"","hidden":false,"title":"/ticket_types","editedParams2":true,"parentDoc":null,"slug":"post-ticket_types","sync_unique":"","excerpt":"Create a new ticket type","link_external":false,"project":"569f7ef06c5c930d007e22bd","type":"post","__v":20,"body":"","category":"595ba3bb9ec1a2001512ab6d","updates":[],"updatedAt":"2019-09-24T13:37:31.168Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/ticket_types
Create a new ticket type
Path Params
event_id:
integer
Event id
Body Params
name:
required
string
Name of the Ticket Type
company_code:
string
If used, must be unique
color:
string
Hexadecimal color
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595ba3bb9ec1a2001512ab7b","version":"595ba3bb9ec1a2001512ab8f","body":"","createdAt":"2016-01-20T14:42:48.155Z","editedParams2":true,"githubsync":"","isReference":true,"sync_unique":"","updates":[],"user":"5c0a5d58d6680101885d0d25","api":{"results":{"codes":[{"name":"","code":"{\n \"id\": 2918,\n \"name\": \"New Ticket Type name\",\n \"company_code\": \"newCode\",\n \"company\": \"Foo\",\n \"color\": \"#196936\",\n \"catalog_item\": null\n}","language":"json","status":200}]},"settings":"","url":"/:event_id/ticket_types/:id","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"ticket_type\": {\n \"name\": \"New Ticket Type name\",\n \"company_code\": \"newCode\",\n \"color\": \"#196936\"\n \"company\": \"Foo\"\n }\n}"}]},"method":"patch","params":[{"_id":"5c07a9c062cadb000d5ff68b","ref":"","in":"path","required":false,"desc":"Id of Event","default":"","type":"int","name":"event_id"},{"_id":"5c07a9d1f78b8501573a5475","ref":"","in":"path","required":false,"desc":"Id of Ticket Type","default":"","type":"int","name":"id"},{"_id":"5d790a64b068580011d420d6","ref":"","in":"body","required":false,"desc":"Name of the Ticket Type","default":"","type":"string","name":"name"},{"_id":"5d790a64b068580011d420d5","ref":"","in":"body","required":false,"desc":"If used, must be unique","default":"","type":"string","name":"company_code"},{"_id":"5d790a64b068580011d420d4","ref":"","in":"body","required":false,"desc":"Hexadecimal color","default":"","type":"string","name":"color"},{"_id":"5d790a64b068580011d420d3","ref":"","in":"body","required":false,"desc":"Name of the company creating the ticket","default":"","type":"string","name":"company"}],"apiSetting":"59f6ff2927b9410024d0d6fb"},"editedParams":true,"link_external":false,"next":{"description":"","pages":[]},"slug":"patch-ticket_types-id","type":"patch","category":"595ba3bb9ec1a2001512ab6d","excerpt":"Modify a ticket type of an event","link_url":"","project":"569f7ef06c5c930d007e22bd","title":"/ticket_types/:id","__v":15,"hidden":false,"order":3,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.168Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
patch/ticket_types/:id
Modify a ticket type of an event
Path Params
event_id:
integer
Id of Event
id:
integer
Id of Ticket Type
Body Params
name:
string
Name of the Ticket Type
company_code:
string
If used, must be unique
color:
string
Hexadecimal color
company:
string
Name of the company creating the ticket
Definition
{{ api_url }}{{ page_api_url }}
Examples
Result Format
{"_id":"595cee09c00614003df28770","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6d","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-07-05T13:47:53.571Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"code":"","name":"","status":200,"language":"json"}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"595ce995175e75003de3ec25","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cee2449658c001b1ad9ec","ref":"","in":"path","required":false,"desc":"Ticket type id","default":"","type":"int","name":"id"}],"url":"/:event_id/ticket_types/:id","method":"delete","apiSetting":"59f6ff2927b9410024d0d6fb"},"isReference":true,"order":4,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Delete a ticket type","slug":"ticket_types","type":"delete","title":"/ticket_types/:id","__v":7,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.169Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
delete/ticket_types/:id
Delete a ticket type
Path Params
event_id:
integer
Event id
id:
integer
Ticket type id
Definition
{{ api_url }}{{ page_api_url }}
{"_id":"5aa9d07fd4b08700126b35db","project":"569f7ef06c5c930d007e22bd","version":"595ba3bb9ec1a2001512ab8f","category":"595ba3bb9ec1a2001512ab6d","user":"59a5ad0f27cc70002fcb1063","updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-03-15T01:46:39.824Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"apiSetting":"59f6ff2927b9410024d0d6fb","examples":{"codes":[{"language":"json","code":"{\n\t\"tickets\": [\"AAA\", \"BBB\"] \n}"}]},"results":{"codes":[{"code":"{\n \"id\": 46023,\n \"name\": \"Night\",\n \"company_code\": \"1521052183\",\n \"company\": \"Glownet\"\n}","name":"","status":201,"language":"json"}]},"settings":"","auth":"required","params":[{"_id":"595ce995175e75003de3ec25","ref":"","in":"path","required":false,"desc":"Event id","default":"","type":"int","name":"event_id"},{"_id":"595cee2449658c001b1ad9ec","ref":"","in":"path","required":false,"desc":"Ticket type id","default":"","type":"int","name":"id"}],"url":"/:event_id/ticket_types/:id/bulk_upload","method":"post"},"isReference":true,"order":5,"body":"[block:api-header]\n{\n \"title\": \"Warning\"\n}\n[/block]\nCannot be done once event is launched","excerpt":"Upload multiple codes into ticket type","slug":"ticket_typesidbulk_upload","type":"post","title":"/ticket_types/:id/bulk_upload","__v":4,"parentDoc":null,"updatedAt":"2019-09-24T13:37:31.169Z","metadata":{"title":"","description":"","image":[]},"childrenPages":[]}
post/ticket_types/:id/bulk_upload
Upload multiple codes into ticket type
Path Params
event_id:
integer
Event id
id:
integer
Ticket type id
Definition
{{ api_url }}{{ page_api_url }}