{"openapi":"3.0.0","info":{"title":"Loyalty Starter Open API","version":"1.1.13"},"servers":[{"url":"https://api.loyaltystarter.io/v1"}],"paths":{"/banners":{"get":{"tags":["Banners"],"operationId":"4e708afdcc5b1436280be58a25263865","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"status","in":"query","description":"Banner status: 0 - disabled, 1 - enabled, sortable","required":false,"schema":{"type":"integer","enum":[0,1]}},{"name":"order","in":"query","description":"Sort by position or status, schema: 'position:asc,satus:desc'","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of banners","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"banners":{"type":"array","items":{"$ref":"#/components/schemas/Banner"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/attachments":{"get":{"tags":["Attachments"],"summary":"Get client attachments","operationId":"e207f2b16a1a7878e65e3058ce75668a","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Sort by date_add, schema: 'date_add:asc' or 'date_add:desc'","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of attachments","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/ClientsAttachments"}}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Attachments"],"summary":"Upload attachments.","description":"Upload attachments. Valid mimetypes: 'image/jpg', 'image/jpeg', 'image/gif', 'image/png', 'application/pdf', 'application/xml', 'text/xml', 'text/csv', 'application/vnd.ms-excel', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'application/x-vnd.oasis.opendocument.spreadsheet'. Max size: 20M","operationId":"6e5929d5ed70c55d660f6681472a4641","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"Binary attachment","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"201":{"description":"Message sent","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Attachment uploaded"},"data":{"properties":{"attachment":{"$ref":"#/components/schemas/ClientsAttachments"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/attachments/{uuid}":{"get":{"tags":["Attachments"],"summary":"Get client attachment","operationId":"a49cd0e0ce6e18427978a7cf397a6055","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","description":"Attachment uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get attachment as binary file","content":{"application/octet-stream":{}}},"404":{"description":"Client/Attachment not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"delete":{"tags":["Attachments"],"summary":"Delete attachment","operationId":"ce372cd41f92ac276a56d31174a934bc","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","description":"Attachment uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Attachment deleted","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true}},"type":"object"}}}},"404":{"description":"Client/Attachment not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/banners":{"get":{"tags":["Banners"],"summary":"Get client banners","operationId":"2b568d03a75e429984a7e908595106e5","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Sort by position, schema: 'position:asc' or 'position:desc'","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of banners","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"banners":{"type":"array","items":{"$ref":"#/components/schemas/Banner"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/cms/pages":{"get":{"tags":["CMS Pages"],"summary":"Get client cms pages","description":"Client's tags are replaced with vars","operationId":"394f2ee594b8f5ebd677662f07c4b6d1","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"categoryId","in":"query","description":"Category Id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pages array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/Page"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/cms/pages/{uuid}":{"get":{"tags":["CMS Pages"],"summary":"Get client cms page","description":"Client's tags are replaced with vars","operationId":"c7fce2df18a0bc799188c6df6e46e906","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"uuid","in":"path","description":"Page uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"page":{"$ref":"#/components/schemas/Page"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid Request"}},"security":[{"Default":["read"]}]}},"/clients/{number}/goals":{"get":{"tags":["Goals"],"summary":"Get client goals","operationId":"4ee3fb1551f5d8a4c101e6eeff23b142","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Goals per page in range 1-500","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Goals array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/Goal"}}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid Request"}},"security":[{"Default":["read"]}]}},"/clients/{number}/goals/{id}":{"post":{"tags":["Goals"],"summary":"Contribute to a goal","operationId":"4ae1e28d0ab5fd86e99438f4c5dfde7c","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Goal id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Contribution to make","content":{"application/json":{"schema":{"properties":{"contribution":{"$ref":"#/components/schemas/ContributionRequest"}},"type":"object"}}}},"responses":{"201":{"description":"Contributed to a goal","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Contributed to a goal"},"data":{"properties":{"goal":{"$ref":"#/components/schemas/Goal"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/messages":{"get":{"tags":["Messages"],"summary":"Get sent messages by client number","operationId":"b8253f40c01195fe9a176efbdb9a0080","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"title","in":"query","description":"Message title, sortable","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Message status: 0- unread, 1 - read, sortable","required":false,"schema":{"type":"integer","enum":[0,1]}},{"name":"dateSent","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Array of messages","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Messages"],"summary":"Send message","operationId":"ef49f4014f7acae133256da5c3ad35fb","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"message":{"$ref":"#/components/schemas/SendMessageRequest"}},"type":"object"}}}},"responses":{"201":{"description":"Message sent","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Message sent"},"data":{"properties":{"message":{"$ref":"#/components/schemas/Message"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Client not found"}},"security":[{"Default":["write"]}]}},"/clients/{number}/messages/{id}":{"get":{"tags":["Messages"],"summary":"Get message by client number and id","operationId":"3bb2a5b68c31794e6de23971b59d8d92","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Message id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of messages","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"messages":{"type":"array","items":{"$ref":"#/components/schemas/Message"}}},"type":"object"}},"type":"object"}}}},"404":{"description":"Message not found"}},"security":[{"Default":["read"]}]},"put":{"tags":["Messages"],"summary":"Change message status","operationId":"c2bdca21d2234ecbd2c0e2fc7cfac523","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Message id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The message status","content":{"application/json":{"schema":{"required":["message"],"properties":{"message":{"required":["status"],"properties":{"status":{"type":"integer"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Updated message object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Client created"},"data":{"properties":{"message":{"$ref":"#/components/schemas/Message"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Message not found"}},"security":[{"Default":["write"]}]}},"/clients/{number}/operations":{"get":{"tags":["Operations"],"summary":"Get operations by client number","description":"Results are paged by 100 operations per page","operationId":"e36099e8612d0baf90318bb530364189","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Operations per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Operation type, sortable","required":false,"schema":{"type":"string","enum":["add","subtract"]}},{"name":"clientNumber","in":"query","description":"Client number, sortable","required":false,"schema":{"type":"string"}},{"name":"userId","in":"query","description":"User id","required":false,"schema":{"type":"string"}},{"name":"document","in":"query","description":"Receipt or invoice number, sortable","required":false,"schema":{"type":"string"}},{"name":"points","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}},{"name":"balance","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"Sortable","required":false,"schema":{"type":"integer"}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"tags","in":"query","description":"Tags separeted by comma (','). Search is performed with 'or' conjunction on tags.","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of Operations","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/referrals":{"get":{"tags":["Referrals"],"summary":"Get client referrals","operationId":"168ef935a66d6c478ee8c0cd0cad310e","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Referrals array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"referrals":{"type":"array","items":{"$ref":"#/components/schemas/ClientReferral"}}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid Request"}},"security":[{"Default":["read"]}]}},"/clients/{number}":{"get":{"tags":["Clients"],"summary":"Get client by number","operationId":"1cbdd9ea7e6bdca1cbcf4b7b160cc085","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Client object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"client":{"$ref":"#/components/schemas/ClientRead"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"put":{"tags":["Clients"],"summary":"Updates client (can be partial)","operationId":"4a305c2438442d28911bffb06ed3b12a","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The client data to update","content":{"application/json":{"schema":{"properties":{"client":{"$ref":"#/components/schemas/ClientUpdate"}},"type":"object"}}}},"responses":{"200":{"description":"Updated client","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Client updated"},"data":{"properties":{"client":{"$ref":"#/components/schemas/ClientRead"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]},"delete":{"tags":["Clients"],"summary":"Delete client by number","operationId":"2896dc49ab4ffd7d1265cd0d903cb860","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Client deleted","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/reviews":{"get":{"tags":["Reviews"],"summary":"Get client reviews","operationId":"0ae3016a275fabddf6ed99869d3842f8","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"stars","in":"query","description":"Separate range with '|' eg. 1|3, 3|, |5. Sortable","required":false,"schema":{"type":"string"}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Review status: 0 - new, 1 - accepted, 2 - rejected, sortable","required":false,"schema":{"type":"integer","enum":[0,1,2]}}],"responses":{"200":{"description":"Reviews array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/Review"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/rewards/orders":{"get":{"tags":["Rewards"],"summary":"Get client rewards orders","operationId":"d660e00d9557539f491084823e3a085c","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Operations per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Array of client's rewards orders","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"rewards_orders":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/MaterialRewardOrder"},{"$ref":"#/components/schemas/DigitalRewardOrder"}]}}},"type":"object"}},"type":"object"}}}},"404":{"description":"Reward order not found"}},"security":[{"Default":["read"]}]}},"/clients/{number}/rewards":{"get":{"tags":["Rewards"],"summary":"Get rewards for client to order","description":"Returns all available rewards for that client. The only condition that has to be checked is balance. Reward will be returned despite client has enaough points or not. This can be covered also by __points__ filter.","operationId":"f22e6ed7af6cf0b66385be7d4391562f","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Clients per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"symbol","in":"query","description":"Reward unique symbol","required":false,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Reward category id, use comma to separate id","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Reward type, sortable","required":false,"schema":{"type":"string","enum":["material","digital","variant"]}},{"name":"points","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of Rewards","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"rewards":{"type":"array","items":{"$ref":"#/components/schemas/Reward"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/rewards/material/{id}":{"post":{"tags":["Rewards"],"summary":"Order material reward for client","operationId":"7307d5830e8b1bb4153e9beae2113fc0","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reward id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reward_order":{"required":["quantity"],"properties":{"quantity":{"type":"integer","maximum":1000,"minimum":1},"shop":{"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"status":{"description":"Reward order status","type":"string","default":"new","enum":["new","sent","delivered","canceled"]},"description":{"description":"Reward order operation description","type":"string"},"delivery_type":{"description":"Reward order delivery type. Optional","type":"string","default":"ADDRESS_SHIPMENT","enum":["ADDRESS_SHIPMENT","PICKUP"]},"address":{"nullable":true,"description":"Only for ADDRESS_SHIPMENT delivery type","properties":{"delivery":{"properties":{"name":{"description":"Client delivery name","type":"string"},"surname":{"description":"Client delivery surname","type":"string"},"address":{"description":"Client delivery address","type":"string"},"city":{"description":"Client delivery city","type":"string"},"postcode":{"description":"Client delivery postcode","type":"string"},"phone":{"description":"Client delivery phone","type":"string"},"details":{"description":"Client delivery details","type":"string"}},"type":"object"}},"type":"object"},"pickup":{"nullable":true,"description":"Only for PICKUP delivery type","properties":{"delivery":{"properties":{"details":{"description":"Pickup delivery details","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Reward ordered"},"data":{"properties":{"reward_order":{"$ref":"#/components/schemas/MaterialRewardOrder"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body; reward not available; client does not have enough points","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Reward/client not found"}},"security":[{"Default":["write"]}]}},"/clients/{number}/rewards/digital/{id}":{"post":{"tags":["Rewards"],"summary":"Order digital reward for client","operationId":"bdad76dbf88796fe0be7327ce3e32353","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Reward id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"reward_order":{"properties":{"shop":{"properties":{"id":{"nullable":true,"type":"string","example":"L09bDW8poW"}},"type":"object"},"description":{"description":"Reward order operation description","type":"string"}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Reward ordered"},"data":{"properties":{"reward_order":{"$ref":"#/components/schemas/DigitalRewardOrder"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body; reward not available; client does not have enough points","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Reward/client not found"}},"security":[{"Default":["write"]}]}},"/clients/{number}/surveys/polls":{"get":{"tags":["Survey Polls"],"summary":"Get client unresolved polls","operationId":"1fd799da98daa7bf76786c530f2e4e98","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Polls per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"status","in":"query","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Polls array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/Quiz"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/surveys/polls/{id}":{"get":{"tags":["Survey Polls"],"summary":"Get client poll answer by id","operationId":"695feef41419b32ed4b2e62e6b09e419","parameters":[{"name":"id","in":"path","description":"Poll id","required":true,"schema":{"type":"string"}},{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Poll answer object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"poll":{"$ref":"#/components/schemas/PollAnswer"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Poll not found"}},"security":[{"Default":["read"]}]},"post":{"tags":["Survey Polls"],"summary":"Take poll","operationId":"43d190cf50fb6de25cc0ed29eda5c7d4","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Poll id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["poll"],"properties":{"poll":{"required":["answers"],"properties":{"answers":{"description":"Poll answers","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PollTextAnswerRequest"},{"$ref":"#/components/schemas/PollTagsAnswerRequest"},{"$ref":"#/components/schemas/PollSwitchAnswerRequest"},{"$ref":"#/components/schemas/PollNumberAnswerRequest"},{"$ref":"#/components/schemas/PollSelectAnswerRequest"},{"$ref":"#/components/schemas/PollMultiselectAnswerRequest"}]}}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Poll solved","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Poll solved"},"data":{"properties":{"poll":{"$ref":"#/components/schemas/Quiz"},"result":{"properties":{"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"message":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/surveys/polls/solved":{"get":{"tags":["Survey Polls"],"summary":"Get client solved polls","operationId":"71d96179357454ab6358d8b6888492b1","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Polls per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Solved polls array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/PollAnswer"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/surveys/quizzes":{"get":{"tags":["Survey Quizzes"],"summary":"Get client unresolved quizzes","operationId":"2c05ee29ac9d925c8271407cfdb0c7bf","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Quizzes per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"status","in":"query","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Quizzes array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"quizzes":{"type":"array","items":{"$ref":"#/components/schemas/Quiz"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/surveys/quizzes/{id}":{"get":{"tags":["Survey Quizzes"],"summary":"Get client quiz answer by id","operationId":"8848666f3482dbb6ae9c882123464a48","parameters":[{"name":"id","in":"path","description":"Quiz id","required":true,"schema":{"type":"string"}},{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Quiz answer object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"quiz":{"$ref":"#/components/schemas/QuizAnswer"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Quiz not found"}},"security":[{"Default":["read"]}]},"post":{"tags":["Survey Quizzes"],"summary":"Take quiz","operationId":"b0f1f368871dc759ad9f973a544c973b","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Quiz id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"required":["quiz"],"properties":{"quiz":{"required":["answers"],"properties":{"answers":{"description":"Quiz answers","type":"array","items":{"$ref":"#/components/schemas/QuizAnswerRequest"}}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Quiz solved","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Quiz solved"},"data":{"properties":{"quiz":{"$ref":"#/components/schemas/Quiz"},"result":{"properties":{"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"message":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients/{number}/surveys/quizzes/solved":{"get":{"tags":["Survey Quizzes"],"summary":"Get client solved quizzes","operationId":"9f006ed02c98296d53cce0e3dcd9d9dc","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Quizes per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Solved quizzes array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"quizzes":{"type":"array","items":{"$ref":"#/components/schemas/QuizAnswer"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/clients/{number}/tags":{"get":{"tags":["Tags"],"summary":"Get client tags","operationId":"fdb62a712449b8b4890426b1789c4baa","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of client tags","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"tags":{"type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Tags"],"summary":"Add tags into client","operationId":"bfb18849dac9e9eaaebd08d419c42a70","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The array of tags to add. Max tag length is 120 characters. Comma (',') is forbidden.","content":{"application/json":{"schema":{"required":["tags"],"properties":{"tags":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"responses":{"200":{"description":"Array of tags on client after operation","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"tags":{"type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]},"delete":{"tags":["Tags"],"summary":"Delete client tags","operationId":"4aea930ba2d88cbbcd5e869fa51e9530","parameters":[{"name":"number","in":"path","description":"Client number","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The array of tags to remove","content":{"application/json":{"schema":{"required":["tags"],"properties":{"tags":{"type":"array","items":{"type":"string"}}},"type":"object"}}}},"responses":{"200":{"description":"Array of tags on client after operation","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"tags":{"type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"}}}},"404":{"description":"Client not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/clients":{"get":{"tags":["Clients"],"summary":"Get clients","operationId":"148f91d25065748740a8e2adb1281b61","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Clients per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable scalar columns; tags and segments are not sortable. Schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"dateAdd","in":"query","description":"Date add. YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateLastLogin","in":"query","description":"Date add. YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"birthday","in":"query","description":"Date add. YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"clientNumber","in":"query","description":"Client number, use comma to separate numbers, sortable","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"phone","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"surname","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"nip","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"city","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"address","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"company","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"rankingPosition","in":"query","description":"Ranking position. Separate range with '|' eg. 1|3, 10|, |100, sortable","required":false,"schema":{"type":"string"}},{"name":"rankingPoints","in":"query","description":"Ranking position. Separate range with '|' eg. 1|3, 10|, |100, sortable","required":false,"schema":{"type":"string"}},{"name":"referralClientNumber","in":"query","description":"Referral client number, use comma to separate numbers, sortable","required":false,"schema":{"type":"string"}},{"name":"origin","in":"query","description":"Client origin, sortable","required":false,"schema":{"type":"string","enum":["api","gui","member-module","unknown"]}},{"name":"rfmSegment","in":"query","description":"RFM segment. Sortable","required":false,"schema":{"type":"string"}},{"name":"rfmRecency","in":"query","description":"RFM recency wage. Separate range with '|' eg. 1|3, 10|, |100, sortable","required":false,"schema":{"type":"string"}},{"name":"rfmFrequency","in":"query","description":"RFM frequency wage. Separate range with '|' eg. 1|3, 10|, |100, sortable","required":false,"schema":{"type":"string"}},{"name":"rfmMonetary","in":"query","description":"RFM monetary wage. Separate range with '|' eg. 1|3, 10|, |100, sortable","required":false,"schema":{"type":"string"}},{"name":"segmentId","in":"query","description":"Segment Id.","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","description":"Group Id.","required":false,"schema":{"type":"string"}},{"name":"additionalFields","in":"query","description":"Additional fields. Use configured field slugs as keys, e.g. additionalFields[field_slug]=additional_field_value. Separate range with '|' eg. 1|3, 10|, |100 for numerable fields. Separate tags with comma ',' for tags fields. Separate '|' options for multiple select fields.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Array of Clients","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"clients":{"type":"array","items":{"$ref":"#/components/schemas/ClientRead"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Clients"],"summary":"Creates client","operationId":"c7200b2a9689dd7382906f97482b9b23","requestBody":{"description":"The client to create","content":{"application/json":{"schema":{"required":["client"],"properties":{"client":{"required":["number"],"allOf":[{"properties":{"referrer":{"properties":{"client":{"properties":{"number":{"description":"Card number of referrer","type":"string","default":"1234567"}},"type":"object"}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/ClientWrite"}]}},"type":"object"}}}},"responses":{"201":{"description":"Created client","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Client created"},"data":{"properties":{"client":{"$ref":"#/components/schemas/ClientRead"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/cms/pages/{uuid}":{"get":{"tags":["CMS Pages"],"summary":"Get cms page","operationId":"5292d63ba4caae5fad5b67f9f49f31e1","parameters":[{"name":"uuid","in":"path","description":"Page uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"page":{"$ref":"#/components/schemas/Page"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid Request"}},"security":[{"Default":["read"]}]}},"/cms/pages":{"get":{"tags":["CMS Pages"],"summary":"Get cms pages","operationId":"ff62c75a8c62b10f964a361c1d68965c","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"categoryId","in":"query","description":"Category Id","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Pages array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"pages":{"type":"array","items":{"$ref":"#/components/schemas/Page"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/cms/pagescategories/{uuid}":{"get":{"tags":["CMS Pages"],"summary":"Get page caegory by uuid","operationId":"4f26821465d2011b071d02afcdfd4ad0","parameters":[{"name":"uuid","in":"path","description":"Category uuid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Page Category object with category pages array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"category":{"$ref":"#/components/schemas/PagesCategory"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid Request"}},"security":[{"Default":["read"]}]}},"/cms/pagescategories":{"get":{"tags":["CMS Pages"],"summary":"Get cms categories","operationId":"37edefad46d890d79ddd32144a2f4ae7","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Categories array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/PagesCategory"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/configs/clients/agreements":{"get":{"tags":["Configs"],"summary":"Get available agreements for clients","operationId":"05f7788961e4b0ac2f8400bb550fe36e","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Agreements array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"agreements":{"type":"array","items":{"$ref":"#/components/schemas/ClientAgreement"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/configs/clients/fields/additional":{"get":{"tags":["Configs"],"summary":"Get available additional fields for clients","operationId":"ab529dbf99710fb865f08da1fab74cbc","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"AdditionalFields array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/ClientField"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/configs/points/multiplicator":{"get":{"tags":["Configs"],"summary":"Get default points multilicator for clients","operationId":"884abc4ee7b2bd52681633c6c0b47d6d","responses":{"200":{"description":"Get default point multiplicator","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"points_multiplicator":{"type":"string"},"points_round_off_strategy":{"description":"up,down,arithmetic,none","type":"string"}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/events":{"get":{"tags":["Events"],"summary":"Get events","operationId":"a6ee266502a36fe709e26cf8a4723735","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Event name, sortable","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Event status: 0 - disabled, 1 - enabled, sortable","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Array of events","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"events":{"type":"array","items":{"$ref":"#/components/schemas/Event"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Events"],"summary":"Triggers event","operationId":"c9a9f26d5a1c1eca8192b4d9fc536688","requestBody":{"content":{"application/json":{"schema":{"properties":{"event":{"required":["id","client"],"properties":{"id":{"description":"Event identificator","type":"string"},"client":{"required":["number"],"properties":{"number":{"description":"Client number","type":"string"}},"type":"object"},"details":{"properties":{"additional":{"properties":{"additional_example":{"description":"Field that can be used in Marketing Automation. Name can be choosen while implementation. Max characters in additional field name: 100. Characters that can be use in additional names: a-zA-Z0-9_  ","type":"string"}},"type":"object"},"operation":{"properties":{"amount":{"type":"integer"},"document":{"type":"integer"},"shop":{"properties":{"id":{"description":"Shop id","type":"string"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Event triggered","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Event triggered"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/goals/{id}":{"get":{"tags":["Goals"],"summary":"Get goal by id","operationId":"8b8263ab6c422ef5e7d5a3a951c45b7d","parameters":[{"name":"id","in":"path","description":"Goal id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Goal object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"goal":{"$ref":"#/components/schemas/Goal"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Goal not found"}},"security":[{"Default":["read"]}]}},"/goals":{"get":{"tags":["Goals"],"summary":"Get goals","operationId":"7bdc46e69698c5722bb2d3bc845f9bab","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Goals per page in range 1-500","required":false,"schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Goals array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/Goal"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/groups":{"get":{"tags":["Groups"],"summary":"Get available groups","operationId":"36b1a13fa924b293f1625b5e118b75ad","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Groups array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"groups":{"type":"array","items":{"$ref":"#/components/schemas/Group"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/operations/aggregate":{"get":{"tags":["Operations"],"summary":"Get aggregated summary about operations","description":"Results are paged by 100 grouped records per page","operationId":"b112a14366e7dd4250aeb250af0a4a45","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Operations per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'. Operations can be ordered by following client fields: client:number, client:dateAdd","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Operation type, sortable","required":false,"schema":{"type":"string","enum":["add","subtract"]}},{"name":"clientNumber","in":"query","description":"Client number, sortable","required":false,"schema":{"type":"string"}},{"name":"userId","in":"query","description":"User id","required":false,"schema":{"type":"string"}},{"name":"document","in":"query","description":"Receipt or invoice number, sortable","required":false,"schema":{"type":"string"}},{"name":"points","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}},{"name":"balance","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"Sortable","required":false,"schema":{"type":"integer"}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"tags","in":"query","description":"Tags separeted by comma (','). Search is performed with 'or' conjunction on tags.","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"groupBy","in":"query","description":"All Operation attributes (for example clientNumber) and one Client attribute (client:number).","required":false,"schema":{"type":"string"}},{"name":"mode","in":"query","description":"Aggregation mode.","required":false,"schema":{"type":"string","enum":["MODE_SUBTRACT_AS_POSITIVE_POINTS","MODE_SUBTRACT_AS_NEGATIVE_POINTS"]}}],"responses":{"200":{"description":"Aggregated summary of operations","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"required":["info","all","grouped_by","grouped"],"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"all":{"$ref":"#/components/schemas/AggregateOperations"},"grouped_by":{"type":"string"},"grouped":{"properties":{"grouped_element":{"$ref":"#/components/schemas/AggregateOperations"}},"type":"object"}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/operations":{"get":{"tags":["Operations"],"summary":"Get operations","description":"Results are paged by 100 operations per page","operationId":"e6cd9afcfe995120421156912f0a213a","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Operations per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Operation type, sortable","required":false,"schema":{"type":"string","enum":["add","subtract"]}},{"name":"clientNumber","in":"query","description":"Client number, sortable","required":false,"schema":{"type":"string"}},{"name":"userId","in":"query","description":"User id","required":false,"schema":{"type":"string"}},{"name":"shopId","in":"query","description":"Shop id","required":false,"schema":{"type":"string"}},{"name":"document","in":"query","description":"Receipt or invoice number, sortable","required":false,"schema":{"type":"string"}},{"name":"points","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"balance","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"tags","in":"query","description":"Tags separeted by comma (','). Search is performed with 'or' conjunction on tags.","required":false,"schema":{"type":"string"}},{"name":"description","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of Operations","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"operations":{"type":"array","items":{"$ref":"#/components/schemas/Operation"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Operations"],"summary":"Creates add or subtract operation","operationId":"c7a841a428e4585f36abd16d5ae98ffd","requestBody":{"description":"The operation to create","content":{"application/json":{"schema":{"required":["operation"],"properties":{"operation":{"required":["type","client"],"properties":{"type":{"type":"string","enum":["add","subtract"]},"shop":{"required":["id"],"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"client":{"required":["number"],"properties":{"number":{"type":"string","example":"7362819029"}},"type":"object"},"user":{"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"points":{"description":"Omit if amount given and points should be calculated from amount","type":"number","minimum":0,"example":100},"amount":{"description":"If points are omitted, points are calculated from amount. If points are provided, amount is stored with the operation.","type":"number","format":"decimal","minimum":0,"example":100.5},"document":{"description":"Receipt or invoice number, required when unique_document is true","type":"string","example":"DOC-123"},"unique_document":{"description":"Check document number uniqueness","type":"boolean"},"tags":{"description":"Tags separeted by comma ','","type":"string"},"description":{"description":"Operation description","type":"string"},"mode":{"description":"ONLY SUBTRACT OPERATION. Default: MODE_STANDARD. MODE_STANDARD - Standard points subtract. MODE_CLEAR_BALANCE - If operation points exceeds client balance, operation points will be overrided to clear client balance. MODE_NEGATIVE_BALANCE - If configuration allows for negative balance, balance will fall below 0.","type":"string","enum":["MODE_STANDARD","MODE_CLEAR_BALANCE","MODE_NEGATIVE_BALANCE"]}},"type":"object"}},"type":"object"}}}},"responses":{"201":{"description":"Created operation","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Created operation"},"data":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/operations/{id}":{"get":{"tags":["Operations"],"summary":"Get operation by id","operationId":"172eb5db96226d13087953b3c94b4443","parameters":[{"name":"id","in":"path","description":"Operation id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"operation":{"$ref":"#/components/schemas/Operation"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Operation not found"}},"security":[{"Default":["read"]}]}},"/operations/{id}/cancel":{"put":{"tags":["Operations"],"summary":"Cancel operation","description":"Only operations added via api or admin panel can be cancelled","operationId":"fa59a92afdd50cb821b5b89e38de8638","parameters":[{"name":"id","in":"path","description":"Operation id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation cancelled successfully","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Operation cancelled"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Operation not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/pictures":{"get":{"tags":["Pictures"],"summary":"Get all pictures","operationId":"ddb5cd5fc9c6fb7edf63391278da2102","responses":{"200":{"description":"Pictures array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"pictures":{"type":"array","items":{"$ref":"#/components/schemas/Picture"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Pictures"],"summary":"Create picture","operationId":"51cc67b0beae6b4d9c57fd08320a0b5f","requestBody":{"description":"The client to create","content":{"multipart/form-data":{"schema":{"properties":{"picture":{"description":"Picture to upload","type":"string","format":"binary"}},"type":"object"}},"application/json":{"schema":{"required":["picture"],"properties":{"url":{"type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Picture object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"picture":{"$ref":"#/components/schemas/Picture"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/pictures/{pictureId}":{"get":{"tags":["Pictures"],"summary":"Get picture by id","operationId":"4dd7af32b71ea6c79aaf5ad9f2c75bcc","parameters":[{"name":"pictureId","in":"path","description":"Picture id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Picture object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"picture":{"$ref":"#/components/schemas/Picture"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Picture not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/products/groups":{"get":{"tags":["Products Groups"],"summary":"Get available products groups","operationId":"b6cc218c2eec1d36b0ef2639d89a96ab","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Products groups array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"products_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductGroup"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Products Groups"],"summary":"Create product group","description":"Endpoint to create new product group. 100 elements max.","operationId":"737cead740958579a853bdc962e16913","requestBody":{"description":"Collection of product groups","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ProductGroupWrite"}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Product group created"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"},"products_groups":{"type":"array","items":{"$ref":"#/components/schemas/ProductGroup"}}},"type":"object"}}}}},"security":[{"Default":["write"]}]},"delete":{"tags":["Products Groups"],"summary":"Delete product groups","description":"Endpoint to delete product groups. 100 elements max.","operationId":"fe1460019016ab430ff15360d5f30458","requestBody":{"description":"Collection of product group ID","content":{"application/json":{"schema":{"type":"array","items":{"description":"Product group ID","type":"string","example":"aI5c1"}}}}},"responses":{"200":{"description":"Product groups deleted"},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/products/groups/{groupId}":{"put":{"tags":["Products Groups"],"summary":"Update product group","description":"Endpoint to update product group by id","operationId":"4d6026751333e0d78f9b342388f741f1","parameters":[{"name":"groupId","in":"path","description":"Product group id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The product group data to update","content":{"application/json":{"schema":{"properties":{"product_group":{"$ref":"#/components/schemas/ProductGroupWrite"}},"type":"object"}}}},"responses":{"200":{"description":"Updated product group","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Product group updated"},"data":{"properties":{"product_group":{"$ref":"#/components/schemas/ProductGroup"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Product group not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/reviews":{"get":{"tags":["Reviews"],"summary":"Get reviews","operationId":"8d3bf803d8913860c2185d81b061bdaf","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"stars","in":"query","description":"Separate range with '|' eg. 1|3, 3|, |5. Sortable","required":false,"schema":{"type":"string"}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"status","in":"query","description":"Review status: 0 - new, 1 - accepted, 2 - rejected, sortable","required":false,"schema":{"type":"integer","enum":[0,1,2]}}],"responses":{"200":{"description":"Reviews array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"reviews":{"type":"array","items":{"$ref":"#/components/schemas/Review"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/reviews/{id}":{"get":{"tags":["Reviews"],"summary":"Get operation by id","operationId":"70b14dedabb87ad697fea0b00ee83d06","parameters":[{"name":"id","in":"path","description":"Review id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Operation object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"operation":{"$ref":"#/components/schemas/Review"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Review not found"}},"security":[{"Default":["read"]}]}},"/rewards/categories/{id}":{"get":{"tags":["Rewards"],"summary":"Get reward category by id","operationId":"990b03078eae51b8b5551658c82df4ff","parameters":[{"name":"id","in":"path","description":"Reward category id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reward category object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"reward_category":{"$ref":"#/components/schemas/RewardCategory"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Reward category not found"}},"security":[{"Default":["read"]}]}},"/rewards/orders/{id}":{"get":{"tags":["Rewards"],"summary":"Get reward order by id","operationId":"8d6f9e47aa46db7fda176b9bd7ab36d2","parameters":[{"name":"id","in":"path","description":"Reward order id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reward object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"reward_order":{"$ref":"#/components/schemas/RewardOrder"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Reward order not found"}},"security":[{"Default":["read"]}]},"put":{"tags":["Rewards"],"summary":"Change order status","description":"Only new reward orders can be changed, available statuses: sent, delivered, canceled","operationId":"101dc2a37970ae9f204d176e11a1ba08","parameters":[{"name":"id","in":"path","description":"Reward order id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The order status to update","content":{"application/json":{"schema":{"required":["reward_order"],"properties":{"reward_order":{"properties":{"status":{"type":"string","enum":["sent","delivered","canceled"]}},"type":"object"}},"type":"object"}}}},"responses":{"200":{"description":"Updated reward order","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Reward order updated"},"data":{"properties":{"reward_order":{"$ref":"#/components/schemas/MaterialRewardOrder"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Reward order not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/rewards/{id}":{"get":{"tags":["Rewards"],"summary":"Get reward by id","operationId":"e489980c3d991e0dc15db30086b62f13","parameters":[{"name":"id","in":"path","description":"Reward id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reward object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"reward":{"$ref":"#/components/schemas/Reward"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Reward not found"}},"security":[{"Default":["read"]}]}},"/rewards":{"get":{"tags":["Rewards"],"summary":"Get list of rewards","operationId":"b683b9994fe9a1b2f87cfb7bdf7fc585","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"symbol","in":"query","description":"Reward unique symbol","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Reward type, sortable","required":false,"schema":{"type":"string","enum":["material","digital","variant"]}},{"name":"points","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"category","in":"query","description":"Reward category id, use comma to separate id","required":false,"schema":{"type":"string"}},{"name":"segmentId","in":"query","description":"Segment Id, use comma to separate id","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","description":"Group Id, use comma to separate id","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"integer"}},{"name":"integration_type","in":"query","description":"Integration type, ex.: multivoucher","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of Rewards","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"rewards":{"type":"array","items":{"$ref":"#/components/schemas/Reward"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]},"post":{"tags":["Rewards"],"summary":"Create reward","description":"Endpoint to create new rewards","operationId":"28fedbdf511682ecef2fe8450587d5fd","requestBody":{"description":"The reward data to create","content":{"application/json":{"schema":{"properties":{"reward":{"$ref":"#/components/schemas/RewardWrite"}},"type":"object"}}}},"responses":{"201":{"description":"Created reward","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Reward created"},"data":{"properties":{"reward":{"$ref":"#/components/schemas/Reward"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/rewards/{rewardId}":{"put":{"tags":["Rewards"],"summary":"Update reward","description":"Endpoint to update reward by id","operationId":"f5809eea8ab6249fe39fce1ec0e3ecf7","parameters":[{"name":"rewardId","in":"path","description":"Reward id","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The reward data to update","content":{"application/json":{"schema":{"properties":{"reward":{"$ref":"#/components/schemas/RewardWrite"}},"type":"object"}}}},"responses":{"200":{"description":"Updated reward","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"message":{"type":"string","default":"Reward updated"},"data":{"properties":{"reward":{"$ref":"#/components/schemas/Reward"}},"type":"object"}},"type":"object"}}}},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}},"404":{"description":"Reward not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]},"delete":{"tags":["Rewards"],"summary":"Delete reward by id","operationId":"4fdd33a328b5551ac1a006edce2e2913","parameters":[{"name":"rewardId","in":"path","description":"Reward id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Reward deleted","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true}},"type":"object"}}}},"404":{"description":"Reward not found","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false}},"type":"object"}}}}},"security":[{"Default":["write"]}]}},"/rewards/categories":{"get":{"tags":["Rewards"],"summary":"Get list of rewards categories","operationId":"19f049f8fdd14a72a53e1a4000deb1fe","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Array of rewards categories","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"rewards_categories":{"type":"array","items":{"$ref":"#/components/schemas/RewardCategory"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/rewards/orders":{"get":{"tags":["Rewards"],"summary":"Get list of rewards orders","operationId":"fa493f630cc5ee1a87ddbfb2bdd0b443","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"number","in":"query","description":"Reward order number. Sortable","required":false,"schema":{"type":"string"}},{"name":"rewardName","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"rewardSymbol","in":"query","description":"Reward unique symbol","required":false,"schema":{"type":"string"}},{"name":"rewardType","in":"query","description":"Sortable","required":false,"schema":{"type":"string","enum":["material","digital"]}},{"name":"clientNumber","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"shopId","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Sortable","required":false,"schema":{"type":"string","enum":["new","sent","delivered","canceled"]}},{"name":"dateAdd","in":"query","description":"Date add YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"dateStatus","in":"query","description":"Date status YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"points","in":"query","description":"Separate range with '|' eg. 1|3, 10|, |100. Sortable","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Array of Rewards Orders","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"rewards_orders":{"type":"array","items":{"$ref":"#/components/schemas/RewardOrder"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/segments":{"get":{"tags":["Segments"],"summary":"Get available segments","operationId":"ec3af185afebf684cdce15754ead93ef","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Segments array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/shops":{"get":{"tags":["Shops"],"summary":"Get available shops","operationId":"aaa9f2e64a2fe2ea06c9d321f2c7865f","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}}],"responses":{"200":{"description":"Shops array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"shops":{"type":"array","items":{"$ref":"#/components/schemas/Shop"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/shops/symbol/{symbol}":{"get":{"tags":["Shops"],"summary":"Get shops by symbol","operationId":"4cdfefe38ad49d6284dc44cd719cea3a","parameters":[{"name":"symbol","in":"path","description":"Shop symbol","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Shop object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"shop":{"$ref":"#/components/schemas/Shop"}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/surveys/polls/{id}":{"get":{"tags":["Survey Polls"],"summary":"Get poll by id","operationId":"17d5a012f90a81e42d6a55d2e03ff42c","parameters":[{"name":"id","in":"path","description":"Poll id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Poll object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"poll":{"$ref":"#/components/schemas/Poll"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Poll not found"}},"security":[{"Default":["read"]}]}},"/surveys/quizzes/{id}":{"get":{"tags":["Survey Quizzes"],"summary":"Get quiz by id","operationId":"9aeac1abdbc3f999f84e61682d96d16c","parameters":[{"name":"id","in":"path","description":"Quiz id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Quiz object","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"quiz":{"$ref":"#/components/schemas/Quiz"}},"type":"object"}},"type":"object"}}}},"404":{"description":"Quiz not found"}},"security":[{"Default":["read"]}]}},"/surveys/polls":{"get":{"tags":["Survey Polls"],"summary":"Get polls","operationId":"09e8f9c09aee52e13ad4c28a8f6b3c25","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Polls per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"status","in":"query","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Polls array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"polls":{"type":"array","items":{"$ref":"#/components/schemas/Quiz"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/surveys/quizzes":{"get":{"tags":["Survey Quizzes"],"summary":"Get quizzes","operationId":"411b0d1cd5283c1627f78f3352815ce7","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Quizes per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"status","in":"query","required":false,"schema":{"type":"integer","enum":[0,1]}}],"responses":{"200":{"description":"Quizzes array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"quizzes":{"type":"array","items":{"$ref":"#/components/schemas/Quiz"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/users":{"get":{"tags":["Users"],"summary":"Get available users","operationId":"76a1021eacf33b5862546ff2400281ee","parameters":[{"name":"page","in":"query","description":"Page number","required":false,"schema":{"type":"integer","default":1}},{"name":"perPage","in":"query","description":"Pages per page in range 1-500","required":false,"schema":{"type":"integer","maximum":500,"minimum":1}},{"name":"order","in":"query","description":"Only sortable columns, schema: 'column1:asc,column2:desc'","required":false,"schema":{"type":"string"}},{"name":"dateAdd","in":"query","description":"Date add. YYYY-MM-DD separate range with '|' eg. 2019-01-01|2019-01-10, 2019-01-01|, |2019-01-20, sortable","required":false,"schema":{"type":"string","format":"date"}},{"name":"email","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"phone","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"surname","in":"query","description":"Sortable","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"User status:  0 - not active, 1 - active, 2 - waiting for account activation","required":false,"schema":{"type":"integer","enum":[0,1,2]}}],"responses":{"200":{"description":"Users array","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":true},"data":{"properties":{"info":{"$ref":"#/components/schemas/PaginationInfo"},"users":{"type":"array","items":{"$ref":"#/components/schemas/User"}}},"type":"object"}},"type":"object"}}}}},"security":[{"Default":["read"]}]}},"/wallet/template":{"post":{"tags":["Wallet"],"summary":"Wallet template.","description":"Wallet template. Valid mimetypes: 'image/png'. Max size: 5M","operationId":"fb578c269e6d3801c87a76c7d591e38c","requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"required":["organization_name"],"properties":{"organization_name":{"description":"Organization name","type":"string"},"organization_label":{"description":"Organization label","type":"string"},"program_name":{"description":"Program name","type":"string"},"program_label":{"description":"Program Label","type":"string"},"program_logo":{"description":"PNG image. Minimum 660px on 660px","type":"string","format":"binary"},"program_banner":{"description":"PNG image. Minimum 1032px on 336px","type":"string","format":"binary"},"url":{"description":"Program website URL","type":"string"},"owner_label":{"description":"Member Label","type":"string"},"points_label":{"description":"Points label","type":"string"}},"type":"object"}}}},"responses":{"200":{"description":"Template updated"},"400":{"description":"Invalid request body","content":{"application/json":{"schema":{"properties":{"status":{"type":"boolean","default":false},"message":{"type":"string"}},"type":"object"}}}}},"security":[{"Default":["write"]}]}}},"components":{"schemas":{"Banner":{"required":["id","status","url","position","picures","availability_limits"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"status":{"description":"Banner status","type":"integer","enum":[0,1]},"url":{"type":"string"},"position":{"type":"integer"},"pictures":{"properties":{"desktop":{"$ref":"#/components/schemas/Picture"},"mobile":{"$ref":"#/components/schemas/Picture"}},"type":"object"},"availability_limits":{"$ref":"#/components/schemas/AvailabilityLimits"}},"type":"object"},"ClientAgreement":{"required":["number","enabled","name","content"],"properties":{"number":{"description":"Agreement numeric identifier. Use slug as the key for client agreement values.","type":"string"},"slug":{"nullable":true,"description":"Agreement slug","type":"string"},"enabled":{"type":"boolean"},"name":{"description":"Agreement name","type":"string"},"content":{"description":"Agreement","type":"string"}},"type":"object"},"ClientsAttachments":{"required":["number","name","enabled","type"],"properties":{"name":{"description":"Additional field number","type":"string"},"uuid":{"description":"uuid of the file","type":"string"},"date_add":{"type":"string","example":"2019-09-14 23:59:59"}},"type":"object"},"ClientField":{"required":["number","name","enabled","type"],"properties":{"number":{"description":"Additional field number.","type":"string"},"slug":{"nullable":true,"description":"Additional field slug. Use this value as the key for additional fields in Open API requests and responses.","type":"string"},"name":{"description":"Additional field name","type":"string"},"enabled":{"description":"Field enabled","type":"boolean"},"type":{"description":"Field Type. 0 - text field, 1 - tags field (comma separator), 2 - bool(0/1) field, 3 - numeric field, 4 - select field, 5 - multiselect field","type":"integer","enum":[0,1,2,3,4,5]},"options":{"nullable":true,"description":"Field options. Only for select and multiselect","type":"array","items":{"type":"string"}},"limits":{"nullable":true,"description":"Field limits. Only for multiselect","properties":{"from":{"nullable":true,"description":"Minimum options number for multiselect field","type":"integer"},"to":{"nullable":true,"description":"Maximum options number for multiselect field","type":"integer"}},"type":"object"}},"type":"object"},"Client":{"properties":{"number":{"description":"Client number","type":"string"},"mode":{"description":"Client number generator mode","type":"string","enum":["USE_GIVEN_NUMBER","GENERATE_NUMBER","GET_NUMBER_FROM_POOL"]},"name":{"nullable":true,"description":"Client name","type":"string","maxLength":30,"minLength":2},"surname":{"nullable":true,"description":"Client surname","type":"string","maxLength":30,"minLength":2},"company":{"description":"Client company","type":"string","maxLength":300},"nip":{"description":"Client nip","type":"string","maxLength":20},"address":{"nullable":true,"description":"Client address","type":"string","maxLength":50},"city":{"nullable":true,"description":"Client city","type":"string","maxLength":30},"postcode":{"nullable":true,"description":"Client postcode","type":"string"},"voivodeship":{"nullable":true,"description":"Client voivodeship. 0 - Dolnośląskie, 1 - Kujawsko-pomorskie, 2 - Lubelskie, 3 - Lubuskie, 4 - Łódzkie, 5 - Małopolskie, 6 - Mazowieckie, 7 - Opolskie, 8 - Podkarpackie, 9 - Podlaskie, 10 - Pomorskie, 11 - Śląskie, 12 - Świętokrzyskie, 13 - Warmińsko-mazurskie, 14 - Wielkopolskie, 15 - Zachodniopomorskie","type":"string","enum":[null,"0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"]},"birthday":{"nullable":true,"description":"Client birthday","type":"string"},"sex":{"nullable":true,"description":"Client sex","type":"string"},"email":{"nullable":true,"description":"Client email","type":"string","maxLength":100},"phone":{"nullable":true,"description":"Client phone","type":"string"},"note":{"nullable":true,"description":"Client note","type":"string"},"points_multiplicator":{"description":"Client points multiplicator","type":"string","readOnly":true},"factor_in":{"description":"Client points factor","type":"string","readOnly":true},"date_add":{"description":"Client date_add","type":"string","readOnly":true},"saldo":{"description":"Client saldo","type":"string","readOnly":true},"group":{"nullable":true,"required":["id"],"properties":{"id":{"type":"string","example":"L09bDW8poW"},"name":{"type":"string","example":"Grupa"}},"type":"object"},"referrer":{"nullable":true,"description":"Client referrer","type":"string","readOnly":true},"referral_client":{"nullable":true,"properties":{"number":{"description":"Referral client number","type":"string"}},"type":"object","readOnly":true},"additional":{"description":"Additional fields. Keys are configured field slugs. For tags join values with comma separator. For multiselect use | as separator.","type":"object","example":{"field_slug":"String field","tag_field_slug":"Tag 1,Tag 2,Tag 3","multiselect_field_slug":"Multi 1|Multi 2|Multi 3"},"additionalProperties":{"type":"string"}},"ranking_position":{"nullable":true,"description":"Client ranking position","type":"string","readOnly":true},"ranking_points":{"nullable":true,"description":"Client ranking points","type":"string","readOnly":true},"date_first_login":{"nullable":true,"description":"Date of first member module login","type":"string","readOnly":true},"date_last_login":{"nullable":true,"description":"Date of last member module login","type":"string","readOnly":true},"origin":{"description":"Client origin","type":"string","enum":["api","gui","member-module","unknown"],"readOnly":true},"rfm":{"nullable":true,"properties":{"segment":{"description":"A-H segment","type":"string"},"recency":{"description":"Wage 1-3","type":"integer"},"frequency":{"description":"Wage 1-3","type":"integer"},"monetary":{"description":"Wage 1-3","type":"integer"}},"type":"object","readOnly":true},"segments":{"description":"Client segments","type":"array","items":{"$ref":"#/components/schemas/Segment"},"readOnly":true},"tags":{"description":"Client tags","type":"array","items":{"type":"string"},"readOnly":true},"status":{"nullable":true,"description":"Client status. 1 - active, 2 - suspended, 3 - blocked","type":"integer","enum":[null,1,2,3],"example":1}},"type":"object"},"ClientReferral":{"required":["date_reference","client"],"properties":{"date_reference":{"description":"Date of reference","type":"string"},"client":{"required":["number"],"properties":{"number":{"description":"Referred client number","type":"string"}},"type":"object"}},"type":"object"},"Event":{"required":["id","status","name"],"properties":{"id":{"description":"Event identificator","type":"string","example":"L09bDW8poW"},"status":{"description":"Event status. 0 - disabled, 1 - enabled","type":"integer","enum":[0,1]},"name":{"description":"Event name","type":"string"}},"type":"object"},"Goal":{"required":["id","status","name","points","points_contributed","picture","availability_limits","description","contribute_message"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"status":{"description":"Goal status","type":"integer","enum":[0,1]},"name":{"type":"string"},"points":{"description":"Number of points to reach goal","oneOf":[{"type":"string"},{"type":"number"}]},"points_contributed":{"description":"Number of contributed points","oneOf":[{"type":"string"},{"type":"number"}]},"picture":{"$ref":"#/components/schemas/Picture"},"availability_limits":{"$ref":"#/components/schemas/AvailabilityLimits"},"description":{"type":"string"},"contribute_message":{"type":"string"}},"type":"object"},"Group":{"required":["id","name"],"properties":{"id":{"description":"Group identificator","type":"string","example":"L09bDW8poW"},"name":{"description":"Group name","type":"string","default":"Grupa VIP"},"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"points_multiplicator":{"type":"string","default":"1.6"}},"type":"object","nullable":true},"PagesCategory":{"required":["id","name"],"properties":{"id":{"description":"Category identificator","type":"string"},"name":{"description":"Category name","type":"string"}},"type":"object"},"Page":{"required":["id","title","in_menu","date_add","content","status","picture"],"properties":{"id":{"description":"Page identificator","type":"string"},"title":{"description":"Page title","type":"string"},"in_menu":{"description":"Is page in menu","type":"boolean"},"date_add":{"description":"Page add date","type":"string"},"content":{"description":"Page content","type":"string"},"status":{"description":"Page status. 0 - disabled,  1 - enabled","type":"integer","enum":[0,1]},"category":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/PagesCategory"}]},"picture":{"$ref":"#/components/schemas/Picture"}},"type":"object"},"Message":{"required":["id","title","content","status","date_sent","date_read"],"properties":{"id":{"description":"Message identificator","type":"string","readOnly":true,"example":"L09bDW8poW"},"title":{"description":"Message title","type":"string","readOnly":true},"content":{"description":"Message content","type":"string","readOnly":true},"status":{"description":"Message status. 0 - unread, 1 - read","type":"integer","enum":[0,1]},"date_sent":{"description":"Message date sent","type":"string","readOnly":true},"date_read":{"nullable":true,"description":"Message date read","type":"string","readOnly":true}},"type":"object"},"Operation":{"required":["id","client","user","type","date_add","points","amount","balance","document","description"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"client":{"required":["number"],"properties":{"number":{"type":"string","example":"7362819029"}},"type":"object"},"user":{"nullable":true,"required":["id"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"}},"type":"object"},"type":{"description":"Operation type","type":"string","enum":["add","subtract"]},"date_add":{"type":"string","example":"2019-09-14 23:59:59"},"points":{"description":"Given amount of points or value after multiplying amount with factor","oneOf":[{"type":"string"},{"type":"number"}]},"amount":{"oneOf":[{"type":"string"},{"type":"number"}]},"balance":{"oneOf":[{"type":"string"},{"type":"integer"}]},"document":{"nullable":true,"type":"string"},"tags":{"nullable":true,"description":"Tags separeted by comma ','","type":"string"},"description":{"nullable":true,"type":"string"},"reward_order":{"nullable":true,"required":["id","name"],"properties":{"id":{"type":"string","example":"WpN3A5wGvb"},"name":{"description":"Reward name","type":"string"},"symbol":{"nullable":true,"description":"Reward symbol captured at order time","type":"string"}},"type":"object"},"goal":{"nullable":true,"required":["id","name"],"properties":{"id":{"type":"string","example":"WpN3A5wGvb"},"name":{"description":"Goal name","type":"string"}},"type":"object"},"shop":{"nullable":true,"required":["id","name","symbol"],"properties":{"id":{"type":"string","example":"WpN3A5wGvb"},"name":{"description":"Shop name","type":"string"},"symbol":{"description":"Shop symbol","type":"string"}},"type":"object"}},"type":"object"},"Review":{"required":["id","date_add","stars","status","review"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"client":{"nullable":true,"required":["number"],"properties":{"number":{"type":"string","example":"7362819029"}},"type":"object"},"operation":{"nullable":true,"required":["id"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"}},"type":"object"},"date_add":{"type":"string","example":"2019-09-14 23:59:59"},"stars":{"type":"number","example":"1"},"status":{"description":"Review status. 0 - new, 1 - accepted, 2 - rejected","type":"integer","enum":[0,1]},"review":{"nullable":true,"type":"string"}},"type":"object"},"Picture":{"properties":{"id":{"description":"Picture id","type":"string"},"picture":{"nullable":true,"description":"Original picture url","type":"string"},"picture_thumb":{"nullable":true,"description":"Picture resized to thumbnail","type":"string"},"picture_thumb_module":{"nullable":true,"description":"Picture resized to module thumbnail","type":"string"}},"type":"object"},"ProductGroup":{"required":["id","name","points_multiplicator"],"properties":{"id":{"description":"ProductGroup identificator","type":"string","example":"wGvbWpN3A5"},"name":{"description":"ProductGroup name","type":"string"},"points_multiplicator":{"description":"Product Group points multiplicator","type":"string"}},"type":"object"},"Segment":{"required":["id","name"],"properties":{"id":{"description":"Segment identificator","type":"string","example":"L09bDW8poW"},"name":{"description":"Segment name","type":"string","default":"Segment VIP"}},"type":"object","nullable":true},"RewardCategory":{"required":["id","name","status"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"name":{"description":"Category name","type":"string"},"status":{"description":"Category status","type":"string","enum":["0","1"]}},"type":"object"},"Reward":{"required":["id","status","points","type","name","description","picture","availability_limits"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"status":{"description":"Reward status","type":"string","enum":["0","1"]},"available_in_member_module":{"description":"If enebaled then reward is visible in member module","type":"boolean"},"points":{"description":"Reward points","oneOf":[{"type":"string"},{"type":"number"}]},"type":{"description":"Reward type","type":"string","enum":["material","digital","variant"]},"name":{"description":"Reward name","type":"string"},"symbol":{"nullable":true,"description":"Optional developer-facing reward identifier, unique within the entity","type":"string"},"category":{"nullable":true,"description":"Reward category","required":["id"],"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"variants":{"nullable":true,"description":"Reward variants","type":"array","items":{"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"}},"variant_of":{"nullable":true,"type":"array","items":{"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"}},"description":{"nullable":true,"description":"description","type":"string"},"picture":{"$ref":"#/components/schemas/Picture"},"availability_limits":{"$ref":"#/components/schemas/RewardAvailabilityLimits"},"integration_type":{"nullable":true,"type":"string"}},"type":"object"},"RewardOrder":{"required":["id","number","client","reward","quantity","points","status","date_add","date_status","shop","description"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"number":{"type":"string","example":"2021041500143312"},"client":{"nullable":true,"required":["number"],"properties":{"number":{"type":"string","example":"7362819029"}},"type":"object"},"reward":{"required":["id","type","name","picture"],"properties":{"id":{"type":"string","example":"xGAdAAN331"},"type":{"type":"string","enum":["material","digital"]},"name":{"description":"Reward name","type":"string"},"symbol":{"nullable":true,"description":"Reward symbol captured at order time","type":"string"},"picture":{"$ref":"#/components/schemas/Picture"}},"type":"object"},"quantity":{"description":"Reward quantity","type":"integer"},"points":{"description":"Reward order points","oneOf":[{"type":"string"},{"type":"number"}]},"status":{"description":"Reward order status","type":"string","enum":["new","sent","delivered","canceled"]},"date_add":{"description":"Reward order add date","type":"string"},"date_status":{"description":"Reward order status date","type":"string"},"shop":{"nullable":true,"properties":{"id":{"type":"string","example":"xgfA22Sh1"}},"type":"object"},"description":{"nullable":true,"description":"Reward order operation description","type":"string"}},"type":"object"},"Shop":{"required":["id","name","long_name","symbol","date_add"],"properties":{"id":{"description":"Shop identificator","type":"string","example":"wGvbWpN3A5"},"name":{"description":"Shop short name","type":"string"},"long_name":{"description":"Shop long name","type":"string"},"symbol":{"description":"Shop symbol","type":"string"},"date_add":{"description":"Shop add date","type":"string","example":"2019-09-14 23:59:59"}},"type":"object"},"PollAnswer":{"required":["result"],"nullable":true,"allOf":[{"properties":{"result":{"required":["solved","points","date_solved"],"properties":{"solved":{"type":"boolean"},"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"date_solved":{"type":"string","example":"2019-09-14 23:59:59"},"answers":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/PollTextAnswerRequest"},{"$ref":"#/components/schemas/PollTagsAnswerRequest"},{"$ref":"#/components/schemas/PollSwitchAnswerRequest"},{"$ref":"#/components/schemas/PollNumberAnswerRequest"},{"$ref":"#/components/schemas/PollSelectAnswerRequest"},{"$ref":"#/components/schemas/PollMultiselectAnswerRequest"}]}}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/Poll"}]},"PollMessage":{"required":["id","message"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"message":{"type":"string"}},"type":"object"},"Poll":{"required":["id","status","name","points","picture","availability_limits","short_description","description","questions","message"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"status":{"description":"Poll status","type":"integer","enum":[0,1]},"name":{"type":"string"},"points":{"description":"Number of points to earn for the poll","oneOf":[{"type":"string"},{"type":"number"}]},"picture":{"$ref":"#/components/schemas/Picture"},"availability_limits":{"$ref":"#/components/schemas/AvailabilityLimits"},"short_description":{"description":"Poll short desription","type":"string"},"description":{"type":"string"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/PollQuestion"}},"message":{"$ref":"#/components/schemas/PollMessage"}},"type":"object"},"PollQuestionAnswer":{"required":["id","answer"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"answer":{"type":"string"}},"type":"object"},"PollQuestion":{"required":["id","picture","question","answers"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"picture":{"$ref":"#/components/schemas/Picture"},"description":{"nullable":true,"type":"string"},"question":{"type":"string"},"type":{"type":"string","enum":["text","textarea","tags","switch","number","select","multiselect"]},"answers":{"type":"array","items":{"$ref":"#/components/schemas/PollQuestionAnswer"}},"details":{"nullable":true,"type":"object"}},"type":"object"},"QuizAnswer":{"required":["result"],"nullable":true,"allOf":[{"properties":{"result":{"required":["solved","points","date_solved"],"properties":{"solved":{"type":"boolean"},"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"date_solved":{"type":"string","example":"2019-09-14 23:59:59"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuizAnswerRequest"}}},"type":"object"}},"type":"object"},{"$ref":"#/components/schemas/Quiz"}]},"QuizMessage":{"required":["id","default","message","points_from","points_to"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"default":{"description":"Is default message","type":"boolean"},"message":{"type":"string"},"points_from":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true}]},"points_to":{"anyOf":[{"type":"string","nullable":true},{"type":"number","nullable":true}]}},"type":"object"},"Quiz":{"required":["id","status","name","points","picture","availability_limits","short_description","description","questions","messages"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"status":{"description":"Quiz status","type":"integer","enum":[0,1]},"name":{"type":"string"},"points":{"description":"Number of points to earn for the quiz","oneOf":[{"type":"string"},{"type":"number"}]},"picture":{"$ref":"#/components/schemas/Picture"},"availability_limits":{"$ref":"#/components/schemas/AvailabilityLimits"},"short_description":{"description":"Quiz short desription","type":"string"},"description":{"type":"string"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/QuizQuestion"}},"messages":{"type":"array","items":{"$ref":"#/components/schemas/QuizMessage"}}},"type":"object"},"QuizQuestionAnswer":{"required":["id","answer","points"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"answer":{"type":"string"},"points":{"oneOf":[{"type":"string"},{"type":"number"}]},"is_correct_answer":{"nullable":true,"type":"boolean","default":null}},"type":"object"},"QuizQuestion":{"required":["id","picture","question","answers"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"picture":{"$ref":"#/components/schemas/Picture"},"description":{"nullable":true,"type":"string"},"question":{"type":"string"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/QuizQuestionAnswer"}}},"type":"object"},"User":{"required":["id","email","name","surname","phone","date_add","status"],"properties":{"id":{"type":"string","example":"wGvbWpN3A5"},"email":{"type":"string"},"name":{"type":"string"},"surname":{"type":"string"},"phone":{"type":"string"},"date_add":{"type":"string","example":"2019-09-14 23:59:59"},"status":{"description":"Users status: 0 - not active, 1 - active, 2 - waiting for account activation","type":"string","enum":["0","1","2"]}},"type":"object"},"ContributionRequest":{"required":["points"],"properties":{"points":{"type":"integer"},"description":{"type":"string"},"shop":{"$ref":"#/components/schemas/ShopRequestObject"}},"type":"object"},"ShopRequestObject":{"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"SendMessageRequest":{"required":["title","content"],"properties":{"title":{"type":"string"},"content":{"type":"string"},"date_sent":{"type":"string","example":"2019-09-14 23:59:59"}},"type":"object"},"AggregateOperations":{"required":["count","points","amount","date_add"],"properties":{"count":{"description":"Aggregated operations count. This value may be served from a short-lived cache.","type":"integer"},"date_add":{"required":["first","last"],"properties":{"first":{"nullable":true,"type":"string"},"last":{"nullable":true,"type":"string"}},"type":"object"},"points":{"required":["sum","min","max","avg"],"properties":{"sum":{"oneOf":[{"type":"string"},{"type":"number"}]},"min":{"oneOf":[{"type":"string"},{"type":"number"}]},"max":{"oneOf":[{"type":"string"},{"type":"number"}]},"avg":{"oneOf":[{"type":"string"},{"type":"number"}]}},"type":"object"},"amount":{"required":["sum","min","max","avg"],"properties":{"sum":{"type":"number"},"min":{"type":"number"},"max":{"type":"number"},"avg":{"type":"number"}},"type":"object"}},"type":"object"},"AgreementsRead":{"properties":{"agreements":{"description":"Keys are configured agreement slugs. Values: 0 - not collected, 1 - given, 2 - not given, 3 - withdrawn","properties":{"1":{"description":"Configured agreement slug 1","type":"string"},"2":{"description":"Configured agreement slug 2","type":"string"},"3":{"description":"Configured agreement slug 3","type":"string"},"4":{"description":"Configured agreement slug 4","type":"string"},"5":{"description":"Configured agreement slug 5","type":"string"}},"type":"object","readOnly":true}},"type":"object"},"AgreementsWrite":{"properties":{"agreements":{"description":"Keys are configured agreement slugs. Values: true/false","properties":{"1":{"description":"Configured agreement slug 1","type":"boolean"},"2":{"description":"Configured agreement slug 2","type":"boolean"},"3":{"description":"Configured agreement slug 3","type":"boolean"},"4":{"description":"Configured agreement slug 4","type":"boolean"},"5":{"description":"Configured agreement slug 5","type":"boolean"}},"type":"object"}},"type":"object"},"AvailabilityLimits":{"properties":{"date_from":{"nullable":true,"type":"string","example":"2019-09-11 00:00:00"},"date_to":{"nullable":true,"type":"string","example":"2019-09-14 23:59:59"},"quantity":{"nullable":true,"type":"integer"},"per_client":{"nullable":true,"type":"integer"}},"type":"object"},"ClientRead":{"required":["number"],"allOf":[{"$ref":"#/components/schemas/Client"},{"$ref":"#/components/schemas/AgreementsRead"}]},"ClientUpdate":{"allOf":[{"$ref":"#/components/schemas/Client"},{"$ref":"#/components/schemas/AgreementsWrite"}]},"ClientWrite":{"required":["number"],"allOf":[{"$ref":"#/components/schemas/Client"},{"$ref":"#/components/schemas/AgreementsWrite"}]},"DigitalRewardOrder":{"required":["message"],"type":"object","allOf":[{"properties":{"message":{"description":"Digital reward order message","type":"string"},"code":{"nullable":true,"description":"Digital reward order code","type":"string"}},"type":"object"},{"$ref":"#/components/schemas/RewardOrder"}]},"MaterialRewardOrder":{"type":"object","allOf":[{"properties":{"address":{"$ref":"#/components/schemas/RewardOrderAddress"}},"type":"object"},{"$ref":"#/components/schemas/RewardOrder"}]},"PaginationInfo":{"required":["count","per_page","page"],"properties":{"count":{"description":"Objects count. For paginated Open API endpoints this value may be served from a short-lived cache.","type":"integer"},"per_page":{"description":"How many objects are on page","type":"integer"},"page":{"description":"Page shown","type":"integer"}},"type":"object"},"PickupRewardOrder":{"type":"object","allOf":[{"properties":{"pickup":{"$ref":"#/components/schemas/RewardOrderPickup"}},"type":"object"},{"$ref":"#/components/schemas/RewardOrder"}]},"PollMultiselectAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"required":["id"],"properties":{"id":{"type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"}},"type":"object"},"PollNumberAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"type":"integer"}},"type":"object"}},"type":"object"},"PollSelectAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"required":["id"],"properties":{"id":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"PollSwitchAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"type":"boolean"}},"type":"object"}},"type":"object"},"PollTagsAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"type":"array","items":{"type":"string"}}},"type":"object"}},"type":"object"},"PollTextAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"type":"string"}},"type":"object"}},"type":"object"},"ProductGroupWrite":{"required":["name","type"],"properties":{"name":{"description":"Product group name. From 1 to 150 chars","type":"string"},"points_multiplicator":{"description":"Points multiplicator. Decimal (14.4) with dot (.) separator.","oneOf":[{"type":"string"},{"type":"number"}]}},"type":"object"},"QuizAnswerRequest":{"required":["question"],"properties":{"question":{"required":["id","answer"],"properties":{"id":{"type":"string"},"answer":{"required":["id"],"properties":{"id":{"type":"string"}},"type":"object"}},"type":"object"}},"type":"object"},"RewardAvailabilityLimits":{"type":"object","allOf":[{"properties":{"date_from":{"nullable":true,"type":"string","example":"2019-09-11 00:00:00"},"date_to":{"nullable":true,"type":"string","example":"2019-09-14 23:59:59"},"quantity":{"nullable":true,"type":"integer"},"per_client":{"nullable":true,"type":"integer"},"groups":{"nullable":true,"description":"null means there is no groups limits.","type":"array","items":{"description":"groupId","type":"string","example":"wGvbWpN3A5"}},"segments":{"nullable":true,"description":"null means there is no segments limits.","type":"array","items":{"description":"segmentId","type":"string","example":"wGvbWpN3A5"}}}},{"$ref":"#/components/schemas/AvailabilityLimits"}]},"RewardOrderAddress":{"description":"Material reward order address","required":["name","surname","address","city","postcode","phone","details"],"properties":{"name":{"nullable":true,"type":"string"},"surname":{"nullable":true,"type":"string"},"address":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"postcode":{"nullable":true,"type":"string"},"phone":{"nullable":true,"type":"string"},"details":{"nullable":true,"type":"string"}},"type":"object"},"RewardOrderPickup":{"description":"Pickup reward order details","required":["details"],"properties":{"details":{"nullable":true,"type":"string"}},"type":"object"},"RewardWrite":{"required":["name","type"],"properties":{"category":{"nullable":true,"description":"Used to assign this award to a specific category","required":["id"],"properties":{"id":{"type":"string","example":"L09bDW8poW"}},"type":"object"},"codes":{"nullable":true,"description":"List of codes to be sent in a order. Can't be use with availability_limits.quantity property at the same time.","type":"array","items":{"type":"string","example":"MY_UNIQUE_REWARD_CODE"}},"picture":{"nullable":true,"description":"Picture of the reward","required":["id"],"properties":{"id":{"nullable":true,"description":"Can be null when picture.url field is not empty","type":"string","example":"L09bDW8poW"},"url":{"description":"Pass the url to the picture to upload it and attach it to the reward","type":"string"}},"type":"object"},"type":{"description":"Reward type. May be one of ['digital', 'material', 'variant']","type":"string"},"points":{"nullable":true,"description":"Rewards price in points","type":"string"},"name":{"description":"Reward name","type":"string"},"symbol":{"nullable":true,"description":"Optional developer-facing identifier, unique within the entity","type":"string","maxLength":50},"order_message":{"nullable":true,"description":"The message that will be shown to the user after purchasing a reward. Required for 'digital' reward type.","oneOf":[{"type":"string"},{"type":"number"}]},"status":{"description":"Describes the status of the reward. 0 - disabled to order, 1 - enabled to order","type":"integer","default":0,"enum":[0,1]},"description":{"nullable":true,"description":"The description of the reward that will be displayed to the user in the member module","type":"string"},"available_in_member_module":{"description":"If enabled then reward is visible in member module","type":"integer","default":0,"enum":[0,1]},"availability_limits":{"$ref":"#/components/schemas/RewardAvailabilityLimits"}},"type":"object"}},"responses":{"400":{"description":"Invalid Request"},"404":{"description":"Client not found"}},"securitySchemes":{"Default":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.loyaltystarter.io/v1/oauth2/token","scopes":{"read":"Grants read access. Methods allowed: GET","write":"Grants write access. Methods Allowed: POST, PUT, PATCH, DELETE"}}}}}}}