Smartbis API v2 enables external systems to integrate directly with the Smartbis Loyalty Marketing platform, allowing businesses to automate customer engagement, register sales, validate coupons, and interact with the loyalty rewards engine in real time.
\nThe API is designed for secure server-to-server integrations and supports modern JSON-based communication with Bearer Token authentication.
\nBase URL
\n\nAuthentication
\nAll requests require authentication using an access token.
\nStep 1 — Generate Access Token
\nPOST /v2/auth/token
\nProvide your api_key and api_secret to obtain an access_token.
\nStep 2 — Use Bearer Token
\nInclude the token in every request header:
\nAuthorization: Bearer {access_token}
\nRequest Format
\n• All requests must use application/json
\n• All responses are returned in JSON
\n• UTF-8 encoding is used throughout the API
\nHeader example
\nContent-Type: application/json
\nAuthorization: Bearer {access_token}
\nCore Features
\nCustomer Management
\nCreate and retrieve customers to connect them to loyalty programs.
\nSales Registration
\nRegister customer purchases using sale_amount.
\nThis triggers the Smartbis loyalty engine, which automatically processes cashback, rewards, and loyalty benefits.
\nRewards Access
\nRetrieve available rewards and manage reward inventory.
\nCategories Management
\nAccess or create reward categories.
\nCoupon Validation
\nValidate reward coupons issued by the loyalty system.
\nTypical Integration Flow
\nGenerate an access token
\nCreate or locate a customer
\nRegister a sale with sale_amount
\nSmartbis automatically processes loyalty rewards
\nCustomer Identification
\nSales can be registered using either:
\n• cpf
\n• customer_id
\nThis allows flexible integrations with existing customer databases.
\nSecurity
\n• Token-based authentication
\n• HTTPS required for all requests
\n• Access tokens expire after a predefined period
\nDesigned For
\nSmartbis API v2 is built for integrations with:
\n• POS systems
\n• E-commerce platforms
\n• Mobile applications
\n• ERP systems
\n• Custom backend integrations
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3977729","collectionId":"366361c6-1cb7-4f18-b464-d52d371255d2","publishedId":"2sBXihoXUJ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-17T02:56:26.000Z"},"item":[{"name":"Auth","item":[{"name":"Generate Token","event":[{"listen":"test","script":{"type":"text/javascript","exec":["pm.test('Status 200', function () { pm.response.to.have.status(200); });","var json = pm.response.json();","pm.test('Retornou access_token', function () { pm.expect(json.data.access_token).to.exist; });","if (json.data && json.data.access_token) {"," pm.collectionVariables.set('access_token', json.data.access_token);","}"],"id":"3165e1bd-2b57-4ef1-8fd5-fac454005dc6"}}],"id":"585810bb-6702-4f14-81c8-5db33fb2342b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"api_key\": \"\",\n \"api_secret\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/auth/token","description":"Gera o token Bearer e salva automaticamente em .
\n","urlObject":{"path":["auth","token"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"585810bb-6702-4f14-81c8-5db33fb2342b"}],"id":"b6125ced-5465-4c6c-8ae9-fbc28a0f99f1","_postman_id":"b6125ced-5465-4c6c-8ae9-fbc28a0f99f1","description":""},{"name":"Customers","item":[{"name":"List Customers","id":"37411f70-d1af-46c2-bdea-6cb1f0115abb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.smartbis.com/v2/customers?page=1&per_page=50","urlObject":{"path":["customers"],"host":["https://api.smartbis.com/v2"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"50"}],"variable":[]}},"response":[],"_postman_id":"37411f70-d1af-46c2-bdea-6cb1f0115abb"},{"name":"Find Customer by CPF","id":"c3f41dcb-bfa0-4df5-8bbc-fdd32ac87299","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.smartbis.com/v2/customers?cpf=","urlObject":{"path":["customers"],"host":["https://api.smartbis.com/v2"],"query":[{"key":"cpf","value":""}],"variable":[]}},"response":[],"_postman_id":"c3f41dcb-bfa0-4df5-8bbc-fdd32ac87299"},{"name":"Create Customer","id":"4e9bc4ba-0d20-4951-ba3b-dd69b5ba3f14","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Test Customer\",\n \"cpf\": \"122188736662\", //optional\n \"phone\": \"11993999994\",\n \"email\": \"customer@example.com\", //optional \n \"birth_date\": \"1990-01-20\", //optional\n \"gender\": \"M\", //optional\n \"password\": \"123456\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/customers","urlObject":{"path":["customers"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"4e9bc4ba-0d20-4951-ba3b-dd69b5ba3f14"}],"id":"c008bef7-e00f-41f4-9c63-a1cb4167e8be","_postman_id":"c008bef7-e00f-41f4-9c63-a1cb4167e8be","description":""},{"name":"Register Sales","item":[{"name":"Register Sale by CPF","id":"3e416479-2baa-4d76-8ebd-c45bffd004b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cpf\": \"\",\n \"sale_amount\": 100.0,\n \"description\": \"Sale registered via API\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/sales","urlObject":{"path":["sales"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e416479-2baa-4d76-8ebd-c45bffd004b8"},{"name":"Register Sale by Customer ID","id":"de34ed42-c598-4253-a001-13f28c1a1fb0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customer_id\": \"\",\n \"sale_amount\": 100.0,\n \"description\": \"Sale registered via API\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/sales","urlObject":{"path":["sales"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"de34ed42-c598-4253-a001-13f28c1a1fb0"}],"id":"68320d5d-73bf-4527-88b1-b4aeb342dd6a","_postman_id":"68320d5d-73bf-4527-88b1-b4aeb342dd6a","description":""},{"name":"Coupons","item":[{"name":"List Coupons","id":"b9a49f98-f93c-4c34-9a5f-02834ab108fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.smartbis.com/v2/coupons","urlObject":{"path":["coupons"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"b9a49f98-f93c-4c34-9a5f-02834ab108fe"},{"name":"Update Reward Stock","id":"148b8d8c-e923-4c0b-8edf-8fb494d6ff2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stock\": 80\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/coupons//stock","urlObject":{"path":["coupons","","stock"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"148b8d8c-e923-4c0b-8edf-8fb494d6ff2e"}],"id":"379cfd4b-ec59-40e9-b43b-583ab56860f4","_postman_id":"379cfd4b-ec59-40e9-b43b-583ab56860f4","description":""},{"name":"Categories","item":[{"name":"List Categories","id":"48dadb39-c532-482d-af44-a6738d4977d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.smartbis.com/v2/categories","urlObject":{"path":["categories"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"48dadb39-c532-482d-af44-a6738d4977d6"},{"name":"Create Category","id":"c2e93631-7662-4bc4-83db-11314577bd54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"description\": \"Food & Beverage\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/categories","urlObject":{"path":["categories"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2e93631-7662-4bc4-83db-11314577bd54"}],"id":"2479d3c6-ce4d-401c-b486-07f9f5d31f8d","_postman_id":"2479d3c6-ce4d-401c-b486-07f9f5d31f8d","description":""},{"name":"Vouchers","item":[{"name":"List Vouchers","id":"57d401d0-9513-47ac-a0a7-4bab950a2d01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://api.smartbis.com/v2/vouchers?page=1&per_page=50","urlObject":{"path":["vouchers"],"host":["https://api.smartbis.com/v2"],"query":[{"key":"page","value":"1"},{"key":"per_page","value":"50"}],"variable":[]}},"response":[],"_postman_id":"57d401d0-9513-47ac-a0a7-4bab950a2d01"},{"name":"Validate Voucher","id":"8b9959b3-b16a-4aca-9023-a1a95e6993c5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{}","options":{"raw":{"language":"json"}}},"url":"https://api.smartbis.com/v2/vouchers/19654132691/validate","urlObject":{"path":["vouchers","19654132691","validate"],"host":["https://api.smartbis.com/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"8b9959b3-b16a-4aca-9023-a1a95e6993c5"}],"id":"b06ec0a4-365f-4823-ba8f-577630b5655d","_postman_id":"b06ec0a4-365f-4823-ba8f-577630b5655d","description":""}],"event":[{"listen":"prerequest","script":{"id":"12e11d12-ada7-4dae-9860-25fde0800b6e","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"298ba324-d63f-401c-aed2-260ff38234ad","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.smartbis.com/v2"},{"key":"api_key","value":""},{"key":"api_secret","value":""},{"key":"access_token","value":""},{"key":"cpf_teste","value":"040.602.062-02"},{"key":"telefone_teste","value":"5599999999999"},{"key":"email_teste","value":"teste@exemplo.com"},{"key":"senha_teste","value":"123456"},{"key":"premio_id","value":"1"},{"key":"voucher_code","value":"19654132691"},{"key":"customer_cpf","value":""},{"key":"customer_id","value":""},{"key":"coupon_id","value":""}]}