Guper is a powerful tool developed based on the MACH architecture (Microservices, API-first, Cloud-native, and Headless), with its main goal being to drive customer revenue. This platform offers various functionalities, such as Loyalty, which encourages customer loyalty by offering cashback as an incentive for future purchases in the store. Additionally, Analytics is an indispensable tool that analyzes store order data and provides valuable insights and strategic suggestions to optimize sales and promote more effective campaigns. With Guper, companies gain access to essential resources to boost financial returns and enhance their business strategies.
\nPOS & Ecommece
\nAll POS and Ecommerce integrations communicate with the Integration API, specifically through the Checkout API, to transmit shopping data to the Guper Engine.
\nThe Guper Engine is the core component responsible for evaluating and applying all promotion and reward rules. It processes this data in real time, ensuring that the appropriate benefits—such as discounts, cashback, or loyalty points—are applied seamlessly during both navigation and checkout.
\nWhen data is received, the Guper Engine determines which rules are eligible based on the configured conditions. For each rule that is triggered, it returns the corresponding effect(s) to the integration layer, enabling an instant and smooth application of the rewards.
\nData Transfer
\nThe Data Transfer layer is designed to keep your systems—such as CRM, BI tools, Data Lakes, or any other applications—up to date with the latest customer and order activity.
\nWe provide two dedicated feeds: Customer Feed and Order Feed. These feeds continuously list updates in real time. Every time a customer or order is updated, a new entry is added to the respective feed.
\nUpdates may include:
\nNew customer or order registration
\nProfile or status changes
\nItems added or removed from an order
\nTags or audiences added or removed
\nRewards or promotions applied or revoked
\nAnd more
\nThis setup ensures a seamless data flow for enriched analytics, reporting, and customer engagement strategies.
\nThe authorization token is extremely necessary to make any requests to APIs in Guper.
\nAuthentication for Guper APIs is performed through our Authorization Token. This token must be included in nearly all requests, utilizing the 'x-guper-authorization' header.
\nThe generation of this token is carried out via a dedicated endpoint, using the API key (x-guper-apikey) and API secret (x-guper-apisecret). These credentials are established during the configuration of an API access account, with the initial set being generated by the Guper integration team.
\nAn HTTP 500 response from our servers is some internal API malfunction. If the outage persists or you receive any other form of HTTP 5XX error, contact support.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1022797","collectionId":"b7996912-fccb-4091-8821-89e464400101","publishedId":"2s93m5zh2u","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-08-09T17:15:31.000Z"},"item":[{"name":"API reference","item":[{"name":"Sandbox","item":[],"id":"9303f6fc-139c-4a53-baa8-ff521032570d","description":"For testing purposes, you can use the following sandbox credentials to simulate API requests in a non-production environment.
\nInterface: sandbox
API Key: sandbox-admin-XKQHFBAS
API Secret: W069YCPVI2X7SGJ5OA3MD8QL
\n\n","_postman_id":"9303f6fc-139c-4a53-baa8-ff521032570d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","name":"API reference","type":"folder"}}},{"name":"Interface","item":[],"id":"1dca51ac-265e-4020-be24-d25599bebd7d","description":"Note: These credentials are for testing purposes only. Ensure you use the appropriate production credentials when interacting with the live environment.
\n
At Guper, we integrate with various external systems such as Bling, Vtex, Linx, Shopify, among others. Each of these integrations is called a Provider, and within each provider, there are different Sources representing the origin of the data.
\nTo organize and standardize information from these different systems, we use a concept called Data Interface. An interface acts as a \"translator\" between the external system's data and the format expected within Guper, ensuring the correct mapping between identifiers from each platform.
\nEach interface has a unique identifier within Guper. When configured, it defines a mapping between the source system’s data and Guper’s internal data.
\nInterface: \"xpto1\" → Unique identification of the interface within Guper
categoryId: \"45asd-5\" → Category ID in the source system
After processing through Guper’s \"translator,\" the data is structured as follows:
\n{\n \"translatedFrom\": \"xpto1\",\n \"categoryRefId\": \"45asd-5\",\n \"categoryId\": 563\n}\n\ntranslatedFrom: Identifies which interface performed the data conversion.
categoryRefId: The reference ID of the category in the external system (source).
categoryId: The standardized ID recognized within Guper.
This model ensures that data from different providers is correctly converted and can be used in a unified way within the system.
\n","_postman_id":"1dca51ac-265e-4020-be24-d25599bebd7d","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","name":"API reference","type":"folder"}}},{"name":"Monetary Value Standards","item":[],"id":"aa737e8d-5f58-4faa-9465-5ff97dd48096","description":"When submitting orders to our API, all monetary values—including item prices, taxes, discounts, and totals—must be expressed as integers representing the smallest unit of the currency (for example, cents for BRL, USD, etc.). This means that values should be transmitted without any decimal points.
\nCents Format:
Each value is converted to the smallest currency unit. For example, a price of R$52.20 should be sent as 5220, and a tax of R$3.75 as 375.
JSON Representation Example:
\n{\n \"itemPrice\": 5220,\n \"tax\": 375,\n \"total\": 5595\n}\n\nChoosing integers eliminates the precision and rounding issues commonly encountered with floating-point numbers, ensuring accurate calculations and data integrity during transmission between systems.
\n","_postman_id":"aa737e8d-5f58-4faa-9465-5ff97dd48096","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","name":"API reference","type":"folder"}}},{"name":"List Query Parameters","item":[],"id":"47d015b3-c142-4c6c-8cc4-a9f971fc1514","description":"q[column][operator]=value\n\ncolumn – can be composite, separated by “;” or “|”.
\noperator – list of supported operators:
\nOperators that can accept multiple values must be configured in sequence.
Example:
q[column][IN]=1&q[column][]=2&q[column][]=3\n\nGenerates:
\ncolumn IN (1, 2, 3)\n\nq[column][IS]=null\n\no[column]=dir\n\ncolumn – the column to sort by
\ndir – sorting direction:
\n[ASC, asc, 1] → ascending
[DESC, desc, 0] → descending
e=entries&p=page\n\nentries – number of items per page (default: 20, max: 1000, if 0 → unlimited)
\npage – page number (default: 1, min: 1)
\nEndFragment
\n","_postman_id":"47d015b3-c142-4c6c-8cc4-a9f971fc1514","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","name":"API reference","type":"folder"}}}],"id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc","description":"This section provides detailed documentation on the available API endpoints, their request and response structures, and usage guidelines.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"587933d5-bc9f-4fd7-bc7c-9aade482e5dc"},{"name":"Connect","item":[{"name":"API","item":[{"name":"Get token","event":[{"listen":"test","script":{"id":"99c02dd2-cd85-41e8-aec8-b7769d0f76c9","exec":["((pm) => {\r"," const responseBody = pm.response.json();\r","\r"," \r"," if ('accessToken' in responseBody) {\r"," const accessToken = responseBody.accessToken;\r","\r"," \r"," pm.environment.set('x-guper-authorization', accessToken);\r","\r"," \r"," console.log(`Value of 'x-guper-authorization' set in the environment variable: ${accessToken}`);\r"," } else {\r"," console.log('The key \"accessToken\" was not found in the response body.');\r"," }\r","\r","})(pm);"],"type":"text/javascript","packages":{}}}],"id":"7d83bb85-ebe4-4dd9-a0ee-b95ae764088f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"x-guper-apikey","value":"{{x-guper-apikey}}","type":"text"},{"key":"x-guper-apisecret","value":"{{x-guper-apisecret}}","type":"text"}],"url":"https://acme.myguper.com/api/connect/token","description":"This feature allows requesting access authorization token.
\nWhich will be used for future requests
\n","urlObject":{"protocol":"https","path":["api","connect","token"],"host":["acme","myguper.com"],"query":[],"variable":[]}},"response":[{"id":"79e11926-fccc-4353-94cc-89d64026c70b","name":"Successful Response","originalRequest":{"method":"GET","header":[{"key":"x-guper-apikey","value":"{{apiKey}}","type":"text"},{"key":"x-guper-apisecret","value":"{{apiSecret}}","type":"text"}],"url":"https://acme.myguper.com/api/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 11 Aug 2023 12:12:57 GMT"},{"key":"Server","value":"Apache/2.4.53 (Win64) OpenSSL/1.1.1n PHP/8.1.6"},{"key":"X-Powered-By","value":"PHP/8.1.6"},{"key":"Content-Length","value":"161"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"accessToken\": \"c074cb9bd30d7b431230877facb45e0a06790e93dea6a728cef9fdaf656bf349\",\n \"expiresIn\": \"2023-08-11T15:13:00-03:00\",\n \"dateTime\": \"2023-08-11T09:13:00-03:00\"\n}"}],"_postman_id":"7d83bb85-ebe4-4dd9-a0ee-b95ae764088f"},{"name":"Create Access","id":"7adbfad4-2606-43bf-b930-a68ba1b2d7bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"identification\": \"Admin\",\r\n \"apiKey\": \"acme\",\r\n \"apiSecret\": \"a10b20c30\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://acme.myguper.com/api/connect/access","description":"Resources for creating ApiAccess
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resources for creating ApiAccess
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Requests for operations related to API Access.
\n","_postman_id":"ba348ca8-f164-4eb2-8580-5f8324bc132c","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resources for creating ApiAccess
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resources for creating ApiAccess
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Requests for operations related to user access.
\n","_postman_id":"4a4686d0-d2c5-4c81-9318-75852e63d910","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resource for checking service availability
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"This document refers to the process of connecting your application, where its main function is to generate the Access Token through the apiKey and apiSecret that will be used in future requests
\n","event":[{"listen":"prerequest","script":{"id":"bc7a8335-d2f2-4dc2-8caa-8916f4b0b980","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"d1b957fd-97f9-4bbc-928c-7d225f65889c","type":"text/javascript","exec":[""]}}],"_postman_id":"37010de6-9ea8-471d-a756-f5b32a528e10","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"This request operates in two modes: Public and Private. In Private mode, it returns customer data, redeemable reward information, and a confirmation token. In Public mode, it only returns the values that will be accumulated.
\nTo use the Public mode, simply omit the x-guper-authorization header. For Private mode, provide the corresponding token in the same header.
It is advisable to re-enter all purchase items. If this is not possible and you are canceling an item (ID or SKU) that appears more than once, it is mandatory to re-enter all items with the same ID/SKU in the same sequence as they were sent in Reward by Order so that the system knows which item will be canceled. An error will be returned if there is a difference in the quantity of items. It will not be returned if the sequence is different, but another item will be canceled, which may result in a discrepancy in the balance to be returned and/or withdrawn
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"This request operates in two modes: Public and Private. In Private mode, it returns customer data, redeemable reward information, and a confirmation token. In Public mode, it only returns the values that will be accumulated.
\nTo use the Public mode, simply omit the x-guper-authorization header. For Private mode, provide the corresponding token in the same header.
Request body parameters
\n\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Endpoints responsible for rewards earned from placing orders.
\n","_postman_id":"b461d9b5-6eb3-453d-af64-de19198abeac","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Creates reward cards for the customer via external-events campaigns.
\n The reward value is passed directly in each campaign entry (value field in cents). The external system decides when and how much to reward — the loyalty\n service only creates the cards following the campaign principles (validity, tags, sequence, etc.).
The client field accepts the same formats as rewardByOrder: int (person ID), string (refId), or object with identifiers (id, email, cellphone,\n document). The client is resolved via the Mapping + Translate pipeline (same as rewardByOrder).
Accepts a single campaign object { id, value } or an array of objects. If a single object is sent, it is auto-wrapped into an array.
Required fields:
\nOptional fields:
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"confirmToken
\n","type":"text/plain"},"type":"any","value":"","key":"hash"}]}},"response":[],"_postman_id":"01c12438-d8c7-493c-ae9f-6d78f62774ff"},{"name":"Cancel","event":[{"listen":"test","script":{"id":"607b67b9-384b-4b1d-a29a-34c811613eb4","exec":["((pm) => {\r","\r"," // Extract the value of 'confirmToken' from the response body in JSON format\r"," const responseBody = pm.response.json();\r","\r"," // Check if 'confirmToken' is present in the response body\r"," if ('confirmToken' in responseBody) {\r"," // Get the value of 'confirmToken'\r"," const confirmTokenValue = responseBody.confirmToken;\r","\r"," // Set the value of 'confirmToken' in the environment variable with the same name\r"," pm.environment.set('confirmToken', confirmTokenValue);\r","\r"," // Log the confirmation of the process in the tests section\r"," console.log(`Value of 'confirmToken' set in the environment variable: ${confirmTokenValue}`);\r"," } else {\r"," // If 'confirmToken' is not present in the response, log a warning in the tests section\r"," console.log('The key \"confirmToken\" was not found in the response body.');\r"," }\r","\r","})(pm);"],"type":"text/javascript","packages":{}}}],"id":"2abb60dc-cfbb-4354-9639-0c47dc4b293a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"interface\": \"vtex\",\r\n \"storeId\": \"vtex\",\r\n \"client\": {\r\n \"refId\": \"3143c4fb-af42-4a0d-8719-3d218937ded8\",\r\n \"name\": \"Rodrigo Dechen\",\r\n \"email\": \"mestri.rodrigo@gmail.com\",\r\n \"document\": \"44613737\",\r\n \"cellphone\": null,\r\n \"id\": 652\r\n },\r\n \"items\": [\r\n {\r\n \"skuRefId\": \"1\",\r\n \"name\": \"Smartphone Guper G1\",\r\n \"categoryRefId\": 2,\r\n \"brandRefId\": 2000000,\r\n \"quantity\": 1,\r\n \"productPrice\": 150000,\r\n \"sellingPrice\": 91800,\r\n \"categoryId\": null,\r\n \"brandId\": null\r\n }\r\n ],\r\n \"total_item\": 150000,\r\n \"total_discounts\": 58200,\r\n \"total_shipping\": 44160,\r\n \"total_taxes\": 0,\r\n \"total_order\": 145960\r\n}","options":{"raw":{"language":"json"}}},"url":"https://acme.myguper.com/api/loyalty/redeem/cancel/:hash","description":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"confirmToken
\n","type":"text/plain"},"type":"any","value":"","key":"hash"}]}},"response":[],"_postman_id":"2abb60dc-cfbb-4354-9639-0c47dc4b293a"},{"name":"Settle","event":[{"listen":"test","script":{"id":"607b67b9-384b-4b1d-a29a-34c811613eb4","exec":["((pm) => {\r","\r"," // Extract the value of 'confirmToken' from the response body in JSON format\r"," const responseBody = pm.response.json();\r","\r"," // Check if 'confirmToken' is present in the response body\r"," if ('confirmToken' in responseBody) {\r"," // Get the value of 'confirmToken'\r"," const confirmTokenValue = responseBody.confirmToken;\r","\r"," // Set the value of 'confirmToken' in the environment variable with the same name\r"," pm.environment.set('confirmToken', confirmTokenValue);\r","\r"," // Log the confirmation of the process in the tests section\r"," console.log(`Value of 'confirmToken' set in the environment variable: ${confirmTokenValue}`);\r"," } else {\r"," // If 'confirmToken' is not present in the response, log a warning in the tests section\r"," console.log('The key \"confirmToken\" was not found in the response body.');\r"," }\r","\r","})(pm);"],"type":"text/javascript","packages":{}}}],"id":"fd0fb37f-a7f7-4849-97ff-19eff242eb23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"interface\": \"vtex\",\r\n \"storeId\": \"vtex\",\r\n \"client\": {\r\n \"refId\": \"3143c4fb-af42-4a0d-8719-3d218937ded8\",\r\n \"name\": \"Rodrigo Dechen\",\r\n \"email\": \"mestri.rodrigo@gmail.com\",\r\n \"document\": \"44613737\",\r\n \"cellphone\": null,\r\n \"id\": 652\r\n },\r\n \"items\": [\r\n {\r\n \"skuRefId\": \"1\",\r\n \"name\": \"Smartphone Guper G1\",\r\n \"categoryRefId\": 2,\r\n \"brandRefId\": 2000000,\r\n \"quantity\": 1,\r\n \"productPrice\": 150000,\r\n \"sellingPrice\": 91800,\r\n \"categoryId\": null,\r\n \"brandId\": null\r\n }\r\n ],\r\n \"total_item\": 150000,\r\n \"total_discounts\": 58200,\r\n \"total_shipping\": 44160,\r\n \"total_taxes\": 0,\r\n \"total_order\": 145960\r\n}","options":{"raw":{"language":"json"}}},"url":"https://acme.myguper.com/api/loyalty/redeem/settle/:hash","description":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"confirmToken
\n","type":"text/plain"},"type":"any","value":"","key":"hash"}]}},"response":[],"_postman_id":"fd0fb37f-a7f7-4849-97ff-19eff242eb23"}],"id":"b917c93d-c4c8-48bd-91bd-dde542b0bf0d","_postman_id":"b917c93d-c4c8-48bd-91bd-dde542b0bf0d","description":"","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Confirm Token
\n","type":"text/plain"},"type":"any","value":"","key":"hash"}]}},"response":[],"_postman_id":"32b7caf5-fb51-4fb4-847d-a2cc921d3dc2"}],"id":"f1753f36-1e87-4cf7-8cc5-ffae0f4127fe","_postman_id":"f1753f36-1e87-4cf7-8cc5-ffae0f4127fe","description":"","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resource for checking service availability
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"This endpoint retrieves the details of a specific category by providing the reference ID in the URL path.
\nMethod: GET
\nURL: https://acme.myguper.com/api/catalog/category/:refId
Path Parameters:
\nrefId: The reference ID of the category to retrieve.Request for registering people
\nThe response for this request can be represented as a JSON schema:
\n{\n \"type\": \"object\",\n \"properties\": {\n \"category\": {\n \"type\": \"string\"\n },\n \"parent\": {\n \"type\": \"string\"\n },\n \"refId\": {\n \"type\": \"string\"\n },\n \"organization\": {\n \"type\": \"string\"\n },\n \"dateTime\": {\n \"type\": \"string\"\n }\n }\n}\n\nRequest for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resource for checking service availability
\n","urlObject":{"protocol":"https","path":["api","catalog","ping"],"host":["acme","myguper.com"],"query":[],"variable":[]}},"response":[{"id":"d30d1917-83ea-4eb7-a318-d4331bb5e110","name":"Success","originalRequest":{"method":"GET","header":[{"key":"x-guper-authorization","value":"","type":"text"}],"url":"https://acme.myguper.com/api/register/ping"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 11 Aug 2023 16:48:47 GMT"},{"key":"Server","value":"Apache/2.4.53 (Win64) OpenSSL/1.1.1n PHP/8.1.6"},{"key":"X-Powered-By","value":"PHP/8.1.6"},{"key":"Content-Length","value":"84"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"account\": \"acme\",\n \"response\": \"Server online\",\n \"dateTime\": \"2023-08-11T13:48:50-03:00\"\n}"}],"_postman_id":"55d2caee-28d8-466b-9481-d2fe3bd27096"}],"id":"12e11211-9157-4eec-9dba-eaaa469675e8","event":[{"listen":"prerequest","script":{"id":"9ad43236-e9a3-4df8-8ef5-12e8d6e557c4","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"21e341aa-6015-43c2-900e-eda9126df538","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"12e11211-9157-4eec-9dba-eaaa469675e8","description":"","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"This API enables the batch import of multiple purchase orders in a single request. It is designed to handle large datasets efficiently, processing multiple purchases simultaneously. Each purchase record should include all necessary details, such as items, prices, and other related information. This API is ideal for integrating multiple transactions at once.
\nThis API allows the import of a single purchase into the system. The request submits all relevant purchase details, including items, prices, and other associated data. This API is designed for cases where only one purchase needs to be processed at a time.
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"| Customer ID | \r","Name | \r","Registered On | \r","|
|---|---|---|---|
| {{customerID}} | \r","{{name}} | \r","{{email}} | \r","{{registeredOn}} | \r","
The response to this request will include the relevant details of the customer registration process. The specific structure of the response will depend on the API implementation and the success or failure of the registration process.
\n* Fields marked with an asterisk are essential and will always be present in a successful response.
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"| Customer ID | \r","Name | \r","Registered On | \r","|
|---|---|---|---|
| {{customerID}} | \r","{{name}} | \r","{{email}} | \r","{{registeredOn}} | \r","
Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Person requests serve as the central registration for all individuals associated with the organization, whether they are customers or employees. If you are registering an employee, begin by creating their registration as a 'person.' Afterward, request an invite through the endpoint /register/invite/{{idPerson}}.
For 'person' registration, the mandatory fields are name and cellphone.
Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","urlObject":{"protocol":"https","path":["api","register","storeGroup"],"host":["acme","myguper.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"21c5d643-6d25-423f-892d-64482dc308ae"},{"name":"Remove","id":"7bf88db0-a596-4293-bcba-51a722464de8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"id\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://acme.myguper.com/api/register/storeGroup","description":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Requested page
\n","type":"text/plain"},"key":"page","value":"1"},{"disabled":true,"description":{"content":"Number of entry items on pagination pages
\n","type":"text/plain"},"key":"entries","value":"10"},{"disabled":true,"key":"q[store]","value":"1"},{"disabled":true,"key":"q[storeGroup]","value":"1"}],"variable":[]}},"response":[],"_postman_id":"810adda6-1169-4bac-9dd6-c058c634be08"},{"name":"Create","id":"91bad340-ad94-425d-9a3b-c59dfd7b2cf4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"store\": 1,\r\n \"storeGroup\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://acme.myguper.com/api/register/linkStoreGroup?page=1&entrari","description":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"StartFragmentThe Audience List is a resource designed to create and manage groups of people with shared characteristics or interests. Each list consists of two main components:
\n1. List Definition: Contains information such as the name of the audience, helping to identify and organize different groups.
2. List of People: Represents the individuals included in the audience, allowing you to add, update, or remove participants.
This resource is ideal for segmentation, personalized communication, and planning targeted actions.
\n","_postman_id":"71d67b4d-9856-4069-84ab-f89386dc8d5d","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Person requests serve as the central registration for all individuals associated with the organization, whether they are customers or employees. If you are registering an employee, begin by creating their registration as a 'person.' Afterward, request an invite through the endpoint /register/invite/{{idPerson}}.
For 'person' registration, the mandatory fields are name and cellphone.
Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request body parameters
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Request for registering people
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Resource for checking service availability
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"The Register service plays a pivotal role in our application, as it serves as the central repository for recording all types of records, including those associated with individuals and stores.
\n","event":[{"listen":"prerequest","script":{"id":"b471337c-07ca-41f6-81f6-adbec7a795b0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"1c7ee48a-d0b4-4b28-9e79-9310af248ef3","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"bbfaf76c-80e0-4d6d-a06c-0474e9988663","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Cria um External Provider (webhook) para a organizacao.
\nbearer → Header: Authorization: Bearer {token}
basic → Header: Authorization: Basic {base64(user:pass)}
apikey → Header: X-API-Key: {token}
none → Sem header de auth
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Remove um External Provider.
\nTemplates associados a este provider passarao a usar o default da org (se existir).
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Lista todos os provider settings da organizacao.
\nRetorna todos os tipos (SMTP, Twilio, External, etc). Cada item inclui os dados de configuracao completos.
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Atualiza um External Provider existente.
\nEnviar apenas os campos que deseja alterar.
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Header de auth conforme authMethod configurado no provider_settings
\n"},{"key":"User-Agent","value":"Guper-Sender/1.0"}],"body":{"mode":"raw","raw":"{\n \"event\": \"message.send\",\n \"timestamp\": \"2026-02-26T14:30:00Z\",\n \"organization\": \"xpto\",\n \"message\": {\n \"id\": \"12345\",\n \"sequence\": \"welcome\",\n \"slug\": \"welcome_email\",\n \"subject\": \"Ola Joao, bem-vindo!\",\n \"body\": \"Seu cadastro foi confirmado. Aproveite seu cashback de R$ 50,00.\",\n \"destination\": {\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\",\n \"cellphone\": \"+5511999999999\",\n \"countryCallingCode\": \"55\"\n }\n },\n \"variables\": {\n \"client\": {\n \"name\": \"Joao Silva\",\n \"email\": \"joao@email.com\",\n \"cellphone\": \"11999999999\"\n },\n \"order\": {\n \"id\": 123,\n \"total\": 5000,\n \"date\": \"2026-02-26 14:30:00\"\n },\n \"reward\": {\n \"name\": \"Cashback\",\n \"value\": 5000\n },\n \"organization\": {\n \"name\": \"Loja XYZ\",\n \"currency\": \"BRL\",\n \"language\": \"pt_BR\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.meucrm.com/webhooks/messages","description":"Este request e apenas referencia — representa o que o Sender envia ao webhook.
\nResource for checking service availability
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"Make sure to use a token generated from a developer account to grant access to an organization's services.
\n","auth":{"type":"apikey","apikey":{"value":"{{x-guper-authorization}}","key":"