{"items":[{"type":"link","label":"Zoined Partner & Retail Analytics Portal API","link":"/","routeSlug":"/"},{"type":"separator","label":"Zone - Zoined Partner API"},{"type":"group","label":"Zone API Overview","link":"/partner-overview","routeSlug":"/partner-overview","items":[]},{"type":"group","label":"Maintenance","link":"/partner-maintenance","routeSlug":"/partner-maintenance","items":[{"label":"Check connectivity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-maintenance/partnercheckconnectivity","routeSlug":"/partner-maintenance/partnercheckconnectivity","metadata":{"seo":{"title":"Check connectivity","description":"This endpoint can be used to verify that you are able to access our API."}},"httpPath":"/api"},{"label":"Retrieving invoicing information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-maintenance/partnergetinvoicinginformation","routeSlug":"/partner-maintenance/partnergetinvoicinginformation","metadata":{"seo":{"title":"Retrieving invoicing information","description":"Provides monthly invoicing report for last 12 months. Report lists total and per customer cash register, store, and camera counts per month."}},"httpPath":"/api/invoicing/{environment}"}]},{"type":"group","label":"Customer","link":"/partner-customers","routeSlug":"/partner-customers","items":[{"label":"List customers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerlistcustomers","routeSlug":"/partner-customers/partnerlistcustomers","metadata":{"seo":{"title":"List customers","description":"Lists all your customers."}},"httpPath":"/api/customers"},{"label":"Create customer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnercreatecustomer","routeSlug":"/partner-customers/partnercreatecustomer","metadata":{"seo":{"title":"Create customer","description":"This API endpoint allows you to create new customer. On success you'll receive JSONwith key for the newly created customer. Please note that it will take some time toinitialize the customer in our systems. Customer's status will be shown ascreating while setup is in progress. Once status changes to ok the customer isfully operational."}},"httpPath":"/api/customers"},{"label":"List single customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnergetcustomer","routeSlug":"/partner-customers/partnergetcustomer","metadata":{"seo":{"title":"List single customer","description":"List single customer matching provided identifier."}},"httpPath":"/api/customers/{id}"},{"label":"Edit customer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerupdatecustomer","routeSlug":"/partner-customers/partnerupdatecustomer","metadata":{"seo":{"title":"Edit customer","description":"Change name, disabled state or data source configuration for customer."}},"httpPath":"/api/customers/{id}"},{"label":"Delete customer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerdeletecustomer","routeSlug":"/partner-customers/partnerdeletecustomer","metadata":{"seo":{"title":"Delete customer","description":"Completely remove customer. This can only be done for customers who are not in theproduction state."}},"httpPath":"/api/customers/{id}"},{"label":"Promote customer into production state","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerpromotecustomer","routeSlug":"/partner-customers/partnerpromotecustomer","metadata":{"seo":{"title":"Promote customer into production state","description":"Promotes customer into production. Production customers have monitoring enabled,and their data can no longer be deleted via the API."}},"httpPath":"/api/customers/{id}/promote"},{"label":"Truncate data","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnertruncatecustomerdata","routeSlug":"/partner-customers/partnertruncatecustomerdata","metadata":{"seo":{"title":"Truncate data","description":"Removes all stored data from the customer. This is useful when setting up the customerintegration, if there are any issues with loading the data. Data can only be truncatedwhen customer is still in sandbox mode. After user has been switched to production, datacan no longer be truncated with this API."}},"httpPath":"/api/customers/{id}/data"},{"label":"Invite users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerinvitecustomeruser","routeSlug":"/partner-customers/partnerinvitecustomeruser","metadata":{"seo":{"title":"Invite users","description":"Invite new users to specified customer."}},"httpPath":"/api/customers/{id}/users"},{"label":"Remove users","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-customers/partnerremovecustomeruser","routeSlug":"/partner-customers/partnerremovecustomeruser","metadata":{"seo":{"title":"Remove users","description":"Remove specific user access from all roles for specified customer."}},"httpPath":"/api/customers/{id}/users/{user}"}]},{"type":"group","label":"Messaging","link":"/partner-messaging","routeSlug":"/partner-messaging","items":[{"label":"Set new message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-messaging/partnersetmessage","routeSlug":"/partner-messaging/partnersetmessage","metadata":{"seo":{"title":"Set new message","description":"Adds new message to system as either broadcast or alternatively for specific customers. Replaces any existing message of that type."}},"httpPath":"/api/messaging"},{"label":"Delete message","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-messaging/partnerdeletemessage","routeSlug":"/partner-messaging/partnerdeletemessage","metadata":{"seo":{"title":"Delete message","description":"Remove either current broadcast message from system or alternatively messages for specific companies."}},"httpPath":"/api/messaging"},{"label":"Get message statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/partner-messaging/partnergetmessagestatistics","routeSlug":"/partner-messaging/partnergetmessagestatistics","metadata":{"seo":{"title":"Get message statistics","description":"Returns information about either current broadcast message or customer specific message view statistics."}},"httpPath":"/api/messaging"}]},{"type":"separator","label":"Zoined Retail Analytics Portal API"},{"type":"group","label":"SSO-API Overview","link":"/portal-overview","routeSlug":"/portal-overview","items":[]},{"type":"group","label":"Session transfer","link":"/portal-session-transfer","routeSlug":"/portal-session-transfer","items":[{"label":"Session transfer via URL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal-session-transfer/portalsessiontransferviaurl","routeSlug":"/portal-session-transfer/portalsessiontransferviaurl","metadata":{"seo":{"title":"Session transfer via URL","description":"Allows user to login with generated URL."}},"httpPath":"/sso/session_transfer/{customer_id}"},{"label":"Session transfer via POST request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/portal-session-transfer/portalsessiontransferviapost","routeSlug":"/portal-session-transfer/portalsessiontransferviapost","metadata":{"seo":{"title":"Session transfer via POST request","description":"Login user via SSO POST request."}},"httpPath":"/sso/session_transfer/{customer_id}"}]},{"type":"group","label":"Data Structures","link":"/portal-data-structures","routeSlug":"/portal-data-structures","items":[{"type":"link","label":"SessionTransfer","link":"/portal-data-structures/sessiontransfer","routeSlug":"/portal-data-structures/sessiontransfer","httpVerb":"schema"},{"type":"link","label":"RestrictedDimensions","link":"/portal-data-structures/restricteddimensions","routeSlug":"/portal-data-structures/restricteddimensions","httpVerb":"schema"},{"type":"link","label":"UserRestrictions","link":"/portal-data-structures/userrestrictions","routeSlug":"/portal-data-structures/userrestrictions","httpVerb":"schema"},{"type":"link","label":"SessionTransferUserData","link":"/portal-data-structures/sessiontransferuserdata","routeSlug":"/portal-data-structures/sessiontransferuserdata","httpVerb":"schema"}]}]}