Nessa documentação você irá encontrar todas as APIs abertas da increazy, antes de começar devemos falar sobre os meios de autenticação e processo de homologação para as APIs que você encontrará aqui.
\nPara a api de ecommerce existem dois tipos de autenticação, ambas são baseadas em headers, você pode encontrar esses dois tipos de headers:
- app : serve para endpoins que serão chamados diretamente no front, então basta enviar o ID da sua aplicação na increazy, sem token, assim você já terá sucesso nas chamadas. Obs: para obter o ID da sua aplicação entre em contato com nosso suporte.
- api-key : o uso dos tokens são recomendados para integrações que serão feitas a partir de cURL, e também para endpoints administrativos. Nunca use um token de api diretamente no front da sua aplicação, isso irá criar brechas de segurança na sua integração. Obs: para criar um token de API basta acessar Configuração > Tokens de APIs no painel da increazy.
Você deve perceber nessa documentação a falta de domínio para as APIs, e dos ids das aplicações. Para receber esses dados e começar sua integração e homologação entre em contato com nosso time, a partir disso fornececeremos os dados para você começar!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"3925893","collectionId":"112056e4-458e-411c-9ac9-7c9e2f69e4ac","publishedId":"2sA3JFBQXW","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01151E"},"publishDate":"2024-06-27T14:16:53.000Z"},"item":[{"name":"Para fronts/apps","item":[{"name":"Consumidor","item":[{"name":"Conta","item":[{"name":"Atualizar conta","id":"5bc0aa81-9237-4cf2-9038-209d60de7430","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": 48,\n \"name\": \"Leonardo da Silva\",\n \"document\": \"188.889.870-45\",\n \"email\": \"leonardo@gmail.com\",\n \"phone\": \"(34) 99882-7432\",\n \"password\": \"123456\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/customer/update","description":"Realiza a edição de um cliente existente na plataforma. Veja alguns detalhes:
\nDados opcionais: phone, password (enviado apenas quando quer editar a senha atual)
Dados obrigatórios: id (retornado no login ou verify logged), name, document, email
O header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Realiza o cadastro de um cliente na plataforma. Veja alguns detalhes:
\nDados opcionais: phone, dob e os dados do endereço
Dados obrigatórios: name, document, email, password
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
A request verifica se o cliente já possui uma conta na plataforma. A validação pode ser feita por documento ou email, mas recomendamos sempre usar o email.
\nEm caso de não existêcia do cliente a request irá retornar o status 400.
\n","urlObject":{"path":["exec","customer","exists"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"9f6a7c37-0a13-4f85-9346-371997cecb58","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"}],"body":{"mode":"raw","raw":"{\n \"isDocument\": false,\n \"input\": \"leonardo@gmail.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/customer/exists"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 19:17:03 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true\n}"}],"_postman_id":"b4388c4c-fc32-4003-ad52-4aeec9687708"}],"id":"7868e182-6a74-41f8-bc52-eeed599c772f","_postman_id":"7868e182-6a74-41f8-bc52-eeed599c772f","description":""},{"name":"Autenticação","item":[{"name":"Login","id":"c9e2f7d7-afca-4776-949a-957925824e0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"leonardo@gmail.com\",\n \"password\": \"123456\",\n \"cartId\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/auth/login","description":"Nesse caso, o cartId é opcional, serve para vincular um carrinho anonimo ao cliente quando ele logar.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Recupera o perfil do cliente usando o token dele salvo no seu sistema/front, esse token é criado e retornado no momento do login do cliente.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Envia um email de recuperação de senha com um código de 6 digitos para que o cliente possa editar sua senha esquecida.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Valida o código de recuperação enviado no email do cliente, já trocando a senha dele pela a nova que foi enviada
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Recupera a lista de endereços de um cliente
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","address","list"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"c72cc106-a830-4ebd-b894-ab9b6a5175b3","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": \"485\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:27:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 850,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": \"Leonardo\",\n \"lastname\": \"Vilarinho\",\n \"customer_id\": 485,\n \"created_at\": \"2024-06-26T19:17:03.000000Z\",\n \"updated_at\": \"2024-06-26T19:17:03.000000Z\",\n \"phone\": \"(34) 99882-7432\",\n \"cep\": \"38300970\",\n \"custom_inputs\": {},\n \"is_default\": false\n }\n]"},{"id":"728c20cc-0f62-4a81-a99e-5a996322a3fb","name":"Error","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": \"4\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/list"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8001"},{"key":"Date","value":"Wed, 26 Jun 2024 20:31:40 GMT"},{"key":"Date","value":"Wed, 26 Jun 2024 20:31:40 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Não autorizado a acessar esse recurso\",\n \"msg_o\": \"Não autorizado a acessar esse recurso\",\n \"message\": \"Não autorizado a acessar esse recurso\"\n}"}],"_postman_id":"ca514c31-c62b-4049-aaca-1d06d69cffc5"},{"name":"Cria novo endereço","id":"5fcc4ccc-a894-4528-9da9-23b5fbedadd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"phone\": \"(34) 99882-7432\",\n \"street\": \"Rua A\",\n \"number\": \"103\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Ituiutaba\",\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"postcode\": \"38300-970\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/create","description":"Todos dados são obrigatórios para a criação de um endereço
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","address","create"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"6eb02e98-b222-40fe-96b4-4022111fa146","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"phone\": \"(34) 99882-7432\",\n \"street\": \"Rua A\",\n \"number\": \"103\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Ituiutaba\",\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"postcode\": \"38300-970\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:32:59 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 850,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": \"Leonardo\",\n \"lastname\": \"Vilarinho\",\n \"customer_id\": 485,\n \"created_at\": \"2024-06-26T19:17:03.000000Z\",\n \"updated_at\": \"2024-06-26T19:17:03.000000Z\",\n \"phone\": \"(34) 99882-7432\",\n \"cep\": \"38300970\",\n \"custom_inputs\": {},\n \"is_default\": false\n },\n {\n \"id\": 853,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"103\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": null,\n \"lastname\": \".\",\n \"customer_id\": 485,\n \"created_at\": \"2024-06-26T20:32:59.000000Z\",\n \"updated_at\": \"2024-06-26T20:32:59.000000Z\",\n \"phone\": \"(34) 99882-7432\",\n \"cep\": \"38300970\",\n \"custom_inputs\": {},\n \"is_default\": false\n }\n]"}],"_postman_id":"5fcc4ccc-a894-4528-9da9-23b5fbedadd0"},{"name":"Apaga um endereço","id":"041f9263-a26d-493e-96b4-62b7f0788bdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"id\": \"853\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/remove","description":"Apaga um endereço do cliente
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","address","remove"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"1b97134b-83b6-4501-bee5-2b8470eff880","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"address\": {\n \"id\": \"853\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/address/remove"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:34:26 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 850,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": \"Leonardo\",\n \"lastname\": \"Vilarinho\",\n \"customer_id\": 485,\n \"created_at\": \"2024-06-26T19:17:03.000000Z\",\n \"updated_at\": \"2024-06-26T19:17:03.000000Z\",\n \"phone\": \"(34) 99882-7432\",\n \"cep\": \"38300970\",\n \"custom_inputs\": {},\n \"is_default\": false\n },\n {\n \"id\": 853,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"103\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": null,\n \"lastname\": \".\",\n \"customer_id\": 485,\n \"created_at\": \"2024-06-26T20:32:59.000000Z\",\n \"updated_at\": \"2024-06-26T20:32:59.000000Z\",\n \"phone\": \"(34) 99882-7432\",\n \"cep\": \"38300970\",\n \"custom_inputs\": {},\n \"is_default\": false\n }\n]"}],"_postman_id":"041f9263-a26d-493e-96b4-62b7f0788bdf"}],"id":"6dce4193-b86e-4d50-9e43-a543533d71ef","_postman_id":"6dce4193-b86e-4d50-9e43-a543533d71ef","description":""}],"id":"e8affbab-6027-4d64-81a1-f54f1993b1e9","description":"Com as requests dessa página você poderá manipular os dados do cliente e meios de pagamentos salvos.
\n","_postman_id":"e8affbab-6027-4d64-81a1-f54f1993b1e9"},{"name":"Carrinho de compra","item":[{"name":"Criar ou recuperar carihno","id":"ffcf4565-3204-486f-8074-fc146223e6f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/getorcreate","description":"Cria ou recupera um carrinho existente baseado no id enviado na request. Para criar um novo carrinho basta enviar o id vazio.
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio. Nessa request ele é opcional, caso você passe a ele, automaticamente o carrinho será vinculado ao usuário desse token, caso esse header esteja ausente, será criado um carrinho anônimo.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
Adiciona um produto no carrinho
\nPara plataforma dinâmica (ERPs):
- obrigatório enviar o nome e preço do produto, pois ele será reconhecido mesmo sem um catálogo previamente cadastrado.
Para plataforma de ecommerce (Magento, Vtex, etc):
- obrigatório enviar apenas id, sku e opções de variações.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","addItem"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"144025a7-8242-4cde-a96d-ce395cf394a7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"quantity\": 2,\n \"product\": {\n \"id\": 472142,\n \"sku\": \"123\",\n \"name\": \"Produto de teste\",\n \"sale_price\": 100\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/addItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:18:49 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 6,\n \"created_at\": \"2024-06-26T20:18:15.000000Z\",\n \"updated_at\": \"2024-06-26T20:18:48.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 600,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"600.00\",\n \"subtotal\": 600,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"7e0c00c7-b844-479e-beaa-6c546abc2072"},{"name":"Atualizar quantidade de item","id":"820d1723-cffd-4ba0-9b2e-2196a798d069","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"quantity\": 3,\n \"product\": {\n \"id\": 472142,\n \"sku\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/changeItem","description":"Atualiza um produto do carrinho, para isso é necessário enviar o ID e a nova quantidade.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","changeItem"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"3e91c894-646b-4a8f-b005-17191e2e6552","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"quantity\": 3,\n \"product\": {\n \"id\": 472142,\n \"sku\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/changeItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:22:53 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 3,\n \"created_at\": \"2024-06-26T20:18:15.000000Z\",\n \"updated_at\": \"2024-06-26T20:22:52.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 300,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"300.00\",\n \"subtotal\": 300,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"820d1723-cffd-4ba0-9b2e-2196a798d069"},{"name":"Remover um item","id":"2dc4fb0b-db17-4583-970b-b23165dd031f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"product\": {\n \"id\": 472142,\n \"sku\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/removeItem","description":"Remove um produto do carrinho, para isso é necessário enviar o ID do item.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","removeItem"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"a34a6b2f-a19b-47df-9428-a5b1cbadca9f","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"product\": {\n \"id\": 472142,\n \"sku\": \"123\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/removeItem"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:24:08 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [],\n \"total\": \"0.00\",\n \"subtotal\": 0,\n \"count\": 0,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"2dc4fb0b-db17-4583-970b-b23165dd031f"},{"name":"Adicionar cupom de desconto","id":"0815c7ba-f0b1-4b8a-99a2-b4cbf21ef1be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"coupon\": \"TESTEERRO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/addCoupon","description":"Adiciona um cupom de desconto ao carrinho.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","addCoupon"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"4f714f82-cac9-4728-80c3-f1365e55ee15","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"coupon\": \"TESTE\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/addCoupon"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 21:10:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": \"teste\",\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T21:10:34.000000Z\",\n \"discount\": 1,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"199.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"},{"id":"495f3ac6-2376-4f9f-bf8b-f05fc0806844","name":"Error","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"coupon\": \"TESTEERRO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/addCoupon"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 21:10:48 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"msg\": \"Cupom inválido\",\n \"msg_o\": \"Cupom inválido\",\n \"message\": \"Cupom inválido\"\n}"}],"_postman_id":"0815c7ba-f0b1-4b8a-99a2-b4cbf21ef1be"},{"name":"Remover cupom de desconto","id":"5d901aeb-9c78-494b-b0ee-c88c2ae33876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"coupon\": \"TESTEERRO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/removeCoupon","description":"Remove um cupom de desconto ao carrinho.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","removeCoupon"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"ac19b088-2c86-4415-af72-117cb9a18398","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"coupon\": \"TESTEERRO\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/removeCoupon"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 21:11:52 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T21:11:52.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"5d901aeb-9c78-494b-b0ee-c88c2ae33876"},{"name":"Setar meio de pagamento","id":"2a437121-d225-4e83-a776-a2463dda18f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"{{cart-id}}\",\n \"type\": \"pix\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/setMethod","description":"Disponível apenas para Magento
\nSeta o um meio de pagamento no carrinho, serve para carregar as promoções configuradas no Magento.
\nTipos aceitos: pix, billet ou creditcard.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","setMethod"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"4f4330b1-94fe-479f-9c25-571cc8e7adb0","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"3bc39535b77243dc124abd1d7174bc09","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"id\": \"140704\",\n \"type\": \"pix\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/setMethod"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:15:58 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [],\n \"total\": \"0.00\",\n \"subtotal\": 0,\n \"count\": 0,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"2a437121-d225-4e83-a776-a2463dda18f7"}],"id":"1e4005d8-3e85-431f-b0fc-c851c35a5465","description":"Nessa pasta você encontra os endpoints para malipular o carrinho de compra.
\n","_postman_id":"1e4005d8-3e85-431f-b0fc-c851c35a5465"},{"name":"Etapas de compras","item":[{"name":"Selecionar um endereço para o pedido","id":"14ff98c4-179d-4c83-990f-16edc83dd048","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": {{cart-id}},\n \"address\": {\n \"id\": 413\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/freight/byAddress","description":"Seleciona um endereço como endereço de entrega/cobrança daquela compra.
\nO retorna será os meios de entregas disponíveis.
\nPor enquanto, para a plataforma dinâmica, sempre retornaremos o meio de entrega fixo.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","freight","byAddress"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"4266393d-d27e-4216-b7c5-a23e9706fe93","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": {{cart-id}},\n \"address\": {\n \"id\": 413\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/freight/byAddress"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:46:10 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 0,\n \"title\": \"Grátis\",\n \"name\": \"Grátis\",\n \"price\": 0\n }\n]"}],"_postman_id":"14ff98c4-179d-4c83-990f-16edc83dd048"},{"name":"Selecionar um frete para o pedido","id":"30d6c8ef-4512-43a1-bd62-34d803f31133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": {{cart-id}},\n \"address\": {\n \"id\": 413\n },\n \"delivery\": {\n \"id\": 0\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/setDelivery","description":"Seta o meio de entrega para o pedido, para a plataforma dinâmica sempre será o ID 0, pois é o frete fixo.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","cart","setDelivery"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"b2f4c8f9-8687-456b-a22f-b947c3e7c8c8","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": {{cart-id}},\n \"address\": {\n \"id\": 413\n },\n \"delivery\": {\n \"id\": 0\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/cart/setDelivery"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:48:44 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:48:44.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n}"}],"_postman_id":"30d6c8ef-4512-43a1-bd62-34d803f31133"},{"name":"Buscar meios de pagamentos ativos","id":"ced6b463-6836-4a49-90f5-9e3fa396e061","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/payment/getMethods","description":"Recupera a lista de meios de pagamentos ativos no seu aplicativo da increazy, facilitando mostrar isso de maneira dinamica no seu front.
\n--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","payment","getMethods"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"26d0243d-d72b-4abf-ab52-973bb6a5c004","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"cart\": {\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:13:21.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": null,\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/payment/getMethods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:38:17 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 423,\n \"type\": \"pix\",\n \"gateway\": \"pagarme5\",\n \"order\": 1,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 223,\n \"payment_id\": 423,\n \"payment_type\": \"pix\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-04-24T18:54:16.000000Z\",\n \"updated_at\": \"2024-04-24T18:54:16.000000Z\"\n }\n },\n {\n \"id\": 424,\n \"type\": \"creditcard\",\n \"gateway\": \"erede\",\n \"order\": 2,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 224,\n \"payment_id\": 424,\n \"payment_type\": \"creditcard\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-04-24T18:54:40.000000Z\",\n \"updated_at\": \"2024-04-24T18:54:40.000000Z\"\n }\n },\n {\n \"type\": \"increazy-other\",\n \"gateway\": \"custom\",\n \"id\": 49,\n \"name\": \"meu pix\",\n \"description\": \"null\",\n \"order\": \"10\",\n \"icon\": \"\",\n \"status\": 1,\n \"min_value\": 0,\n \"max_value\": 0,\n \"installments\": 1,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 226,\n \"payment_id\": 49,\n \"payment_type\": \"custom\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-05-07T15:43:55.000000Z\",\n \"updated_at\": \"2024-05-07T15:43:55.000000Z\"\n }\n },\n {\n \"type\": \"increazy-other\",\n \"gateway\": \"custom\",\n \"id\": 50,\n \"name\": \"meu pix\",\n \"description\": \"null\",\n \"order\": \"10\",\n \"icon\": \"\",\n \"status\": 1,\n \"min_value\": 0,\n \"max_value\": 0,\n \"installments\": 1,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 227,\n \"payment_id\": 50,\n \"payment_type\": \"custom\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-05-07T15:50:38.000000Z\",\n \"updated_at\": \"2024-05-07T15:50:38.000000Z\"\n }\n },\n {\n \"type\": \"increazy-other\",\n \"gateway\": \"custom\",\n \"id\": 51,\n \"name\": \"meu pix\",\n \"description\": \"null\",\n \"order\": \"10\",\n \"icon\": \"\",\n \"status\": 1,\n \"min_value\": 0,\n \"max_value\": 0,\n \"installments\": 1,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 228,\n \"payment_id\": 51,\n \"payment_type\": \"custom\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-05-07T15:50:53.000000Z\",\n \"updated_at\": \"2024-05-07T15:50:53.000000Z\"\n }\n },\n {\n \"type\": \"increazy-other\",\n \"gateway\": \"custom\",\n \"id\": 52,\n \"name\": \"meu pix\",\n \"description\": \"null\",\n \"order\": \"10\",\n \"icon\": \"\",\n \"status\": 1,\n \"min_value\": 0,\n \"max_value\": 0,\n \"installments\": 1,\n \"discount\": 0,\n \"criterias\": {\n \"id\": 229,\n \"payment_id\": 52,\n \"payment_type\": \"custom\",\n \"data\": [],\n \"all_required\": 0,\n \"created_at\": \"2024-05-07T15:55:14.000000Z\",\n \"updated_at\": \"2024-05-07T15:55:14.000000Z\"\n }\n }\n]"}],"_postman_id":"ced6b463-6836-4a49-90f5-9e3fa396e061"}],"id":"e711bf9a-0067-4206-a8d5-ae1bd2ba3442","description":"Nessa pasta você encontra os endpoints necessários para etapas obrigatórias até a finalização de um pedido na plaforma, por favor, siga essas etapas na ordem indicada lateralmente.
\n","_postman_id":"e711bf9a-0067-4206-a8d5-ae1bd2ba3442"},{"name":"Pedidos","item":[{"name":"Finalizar pedido","id":"33889b21-9dba-477b-afee-a3fc0d3a872d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"custom_inputs\": {},\n \"extra\": {},\n \"cart\": {\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:48:44.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n },\n \"payment\": {\n \"type\": \"pix\",\n \"gateway\": \"pagarme5\",\n \"discount\": 0,\n \"tax\": 0\n },\n \"address\": {\n \"id\": 850,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": \"Leonardo\",\n \"lastname\": \"Vilarinho\",\n \"phone\": \"(34) 99882-7432\"\n },\n \"customer\": {\n \"id\": 485,\n \"lastname\": \"Vilarinho\",\n \"firstname\": \"Leonardo\",\n \"dob\": \"1996-10-12\",\n \"document\": \"18888987045\",\n \"email\": \"leonardo@gmail.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/payment/finish","description":"Finaliza o pedido de um cliente, para isso é necessário enviar todos os dados das etapas anteriores, sendo eles:
\n- cart - objeto de carrinho criado nas requests de carrinho
- address - objeto com o endereço selecionado pelo cliente
- customer - objeto com os dados do cliente
- payment - objeto com os dados de pagamento selecionado pelo cliente, além de descontos e taxas
Os dados são pedidos para uma revalidação da compra antes do fechamento, garantindo que os dados selecionados entre as etapas realmente batem com nossos registros, aumentando a segurança da compra.
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","payment","finish"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"030c57f9-1338-4c69-97fa-298cc9c341de","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"3bc39535b77243dc124abd1d7174bc09","type":"text"}],"body":{"mode":"raw","raw":"{\n \"custom_inputs\": {},\n \"extra\": {},\n \"cart\": {\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": \"\",\n \"delivery_price\": 0,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:48:44.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0,\n \"items\": [\n {\n \"id\": \"472142\",\n \"cart_id\": 140704,\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"product_id\": \"472142\",\n \"price\": \"100.00\",\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\",\n \"sku\": \"123\",\n \"details\": null,\n \"log\": null,\n \"total\": 200,\n \"path\": null,\n \"has_stock\": true,\n \"increment\": 1\n }\n ],\n \"total\": \"200.00\",\n \"subtotal\": 200,\n \"count\": 1,\n \"custom_inputs\": [],\n \"conversion_id\": 4392363\n },\n \"payment\": {\n \"type\": \"pix\",\n \"gateway\": \"pagarme5\",\n \"discount\": 0,\n \"tax\": 0\n },\n \"address\": {\n \"id\": 850,\n \"state\": \"Minas Gerais\",\n \"uf\": \"MG\",\n \"street\": \"Rua A\",\n \"number\": \"123\",\n \"complement\": \"\",\n \"neighborhood\": \"Centro\",\n \"telephone\": \"(34) 99882-7432\",\n \"postcode\": \"38300970\",\n \"city\": \"Ituiutaba\",\n \"firstname\": \"Leonardo\",\n \"lastname\": \"Vilarinho\",\n \"phone\": \"(34) 99882-7432\"\n },\n \"customer\": {\n \"id\": 485,\n \"lastname\": \"Vilarinho\",\n \"firstname\": \"Leonardo\",\n \"dob\": \"1996-10-12\",\n \"document\": \"18888987045\",\n \"email\": \"leonardo@gmail.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/payment/finish"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:55:35 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"increment_id\": 552\n}"}],"_postman_id":"33889b21-9dba-477b-afee-a3fc0d3a872d"},{"name":"Recupera pedidos do consumidor","id":"2f008894-1e0e-47c1-920a-49d02c81c3cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": 485\n },\n \"page\": 1,\n \"per_page\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/order/list","description":"Recupera a lista de pedidos de um cliente
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","order","list"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"943b94a2-5de5-409f-973a-04b7a8a1f6ed","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"3bc39535b77243dc124abd1d7174bc09","type":"text"}],"body":{"mode":"raw","raw":"{\n \"customer\": {\n \"id\": 485\n },\n \"page\": 1,\n \"per_page\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/order/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8001"},{"key":"Date","value":"Wed, 26 Jun 2024 20:57:57 GMT"},{"key":"Date","value":"Wed, 26 Jun 2024 20:57:57 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"items\": [\n {\n \"id\": 552,\n \"app\": \"i1713989969\",\n \"customer_id\": 485,\n \"status\": \"waiting\",\n \"items\": [\n {\n \"id\": 86440,\n \"log\": null,\n \"sku\": \"123\",\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"price\": 100,\n \"cart_id\": 140704,\n \"details\": null,\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"product_id\": \"472142\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\"\n }\n ],\n \"address_id\": 850,\n \"method\": \"pix\",\n \"payment_info\": {\n \"url\": \"https://api.pagar.me/core/v5/transactions/tran_l82XKQQfbRI5rPEw/qrcode?payment_method=pix\",\n \"qrcode\": \"00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/7c8f0197-1fa6-4ad0-acb7-04388daa578d5204000053039865406200.005802BR5914Conta primaria6014RIO DE JANEIRO62290525paclxwbeh1pojdd1fk8h2g25d6304E158\",\n \"barcode\": null,\n \"expiration\": \"2024-06-29T23:59:59Z\"\n },\n \"quote_id\": 140704,\n \"created_at\": \"2024-06-26T20:55:32.000000Z\",\n \"updated_at\": \"2024-06-26T20:55:32.000000Z\",\n \"cart\": {\n \"id\": 140704,\n \"auth_id\": 102308,\n \"coupon\": null,\n \"shipping_description\": null,\n \"delivery_price\": null,\n \"created_at\": \"2024-06-26T20:13:21.000000Z\",\n \"updated_at\": \"2024-06-26T20:48:44.000000Z\",\n \"discount\": 0,\n \"method_discount\": 0,\n \"freight\": {\n \"id\": 0,\n \"address_id\": 413\n },\n \"metadata\": null,\n \"app\": \"i1713989969\",\n \"active\": 1,\n \"dynamic_discount\": 0\n },\n \"total\": 200,\n \"coupon\": \"\",\n \"delivery_price\": 0,\n \"delivery_name\": \"\",\n \"discount\": 0,\n \"subtotal\": 200,\n \"date\": 200\n }\n ],\n \"total\": 1\n}"}],"_postman_id":"2f008894-1e0e-47c1-920a-49d02c81c3cd"},{"name":"Buscar pedido por ID","id":"b529cc68-79ce-4b04-a75e-6a4df79fff28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"api-key","value":"{{api-key}}","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"{{customer-token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"552\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/order/get","description":"Recupera um pedido do cliente baseado no ID do pedido do mesmo.
\nO header customer-token deve ter o valor do token do cliente logado, o token é gerado no momento do login do cliente e é vitálicio.
--
\nPara saber sobre os headers api-key e app leia a descrição inicial dessa documentação.
\n","urlObject":{"path":["exec","order","get"],"host":["{{ecommerce-api}}"],"query":[],"variable":[]}},"response":[{"id":"62a1a274-c387-4dfc-be31-9ff0d73a4bba","name":"Success","originalRequest":{"method":"POST","header":[{"key":"api-key","value":"66617faa27ec0881c3a9cd792351cc97","type":"text"},{"key":"app","value":"{{app-id}}","type":"text"},{"key":"customer-token","value":"3bc39535b77243dc124abd1d7174bc09","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"552\"\n}","options":{"raw":{"language":"json"}}},"url":"{{ecommerce-api}}/exec/order/get"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 26 Jun 2024 20:59:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Server","value":"nginx"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"},{"key":"Vary","value":"Accept-Encoding"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 552,\n \"app\": \"i1713989969\",\n \"customer_id\": 485,\n \"status\": \"waiting\",\n \"items\": [\n {\n \"id\": 86440,\n \"log\": null,\n \"sku\": \"123\",\n \"name\": \"Produto de teste\",\n \"image\": \"\",\n \"price\": 100,\n \"cart_id\": 140704,\n \"details\": null,\n \"quantity\": 2,\n \"created_at\": \"2024-06-26T20:24:20.000000Z\",\n \"product_id\": \"472142\",\n \"updated_at\": \"2024-06-26T20:24:20.000000Z\"\n }\n ],\n \"address_id\": 850,\n \"method\": \"pix\",\n \"payment_info\": {\n \"url\": \"https://api.pagar.me/core/v5/transactions/tran_l82XKQQfbRI5rPEw/qrcode?payment_method=pix\",\n \"qrcode\": \"00020101021226820014br.gov.bcb.pix2560pix.stone.com.br/pix/v2/7c8f0197-1fa6-4ad0-acb7-04388daa578d5204000053039865406200.005802BR5914Conta primaria6014RIO DE JANEIRO62290525paclxwbeh1pojdd1fk8h2g25d6304E158\",\n \"barcode\": null,\n \"expiration\": \"2024-06-29T23:59:59Z\"\n },\n \"quote_id\": 140704,\n \"created_at\": \"2024-06-26T20:55:32.000000Z\",\n \"updated_at\": \"2024-06-26T20:55:32.000000Z\",\n \"cart\": 140704,\n \"total\": 200,\n \"coupon\": \"\",\n \"delivery_price\": 0,\n \"delivery_name\": \"\",\n \"discount\": 0,\n \"subtotal\": 200,\n \"date\": 200,\n \"userID\": 485,\n \"bill\": \"Rua ANessa pasta você finalmente conseguirá finalizar uma compra no seu front usando os dados anteriores, e também consultas pedidos já feitos.
\n","_postman_id":"01523c67-6050-4c51-a43d-01970d1d8dcd"}],"id":"1232d73a-54b8-41f7-8e1e-6c7fc1628d44","description":"Nessa pasta você encontra a documentação das requests para que você consiga integrar o processo de compra de maneira transparente no seu sistema.
\nVocê tem uma loja, um aplicativo, um chatbot, ou qualquer outro sistema, e quer que seus clientes faça compras usando um carrinho e cadastro sem nem precisar saber da existência da increazy? Se é isso, essa documentação é pra você!
\nAlém de seguir as recomendações de Autenticação principal da nossa documentação, nessa API você vai notar em alguns endpoints a presença do header customer-token. Esse header deve conter o valor do token do seu cliente que está realizando a compra ou acesso ao seu sistema, pois com esse token iremos ter a garantia de que cada cliente terá acesso somente aos seus próprios dados.
Para saber o host da API e o seu token de api entre em contato com o nosso suporte para que possamos fazer a liberação da API.
\nA seguir, temos um descritivo do JSON enviado para a requisição:
\ncustomer (objeto)
\nsocial (string, opcional): Razão social da empresa
\nname (string, obrigatório): Nome do cliente
\ndocument (string, obrigatório): Documento do cliente
\nemail (string, obrigatório): Email do cliente
\nphone (string, obrigatório): Número de telefone do cliente
\ndob (string, opcional): Data de nascimento do cliente
\naddress (objeto)
\nstreet (string, obrigatório): Nome da rua
\nnumber (string, obrigatório): Número da rua
\ncomplement (string, opcional): Complemento do endereço
\nstate (string, obrigatório): Estado
\nuf (string, obrigatório): UF
\ncity (string, obrigatório): Cidade
\nneighborhood (string, obrigatório): Bairro
\npostcode (string, obrigatório): Código postal
\nproducts (array)
\nname (string, obrigatório): Nome do produto
\nid (string, obrigatório): ID do produto, identificador externo
\nsku (string, opcional): SKU do produto, identificador externo
\nprice (number, obrigatório): Preço do produto
\nimage (string, opcional): URL da imagem do produto
\nquantity (number, obrigatório): Quantidade do produto
\noptions (objeto)
\nname (string, obrigatório): Apelido apra o link de pagamento
\nis_unique (number, obrigatório): Indica se o link irá se expirar após a finalização do pedido
\nmethods (array, obrigatório): Métodos de pagamento disponíveis: pix, billet, creditcard, voucher, pix-installment
\ninstallments (number, obrigatório): Número de parcelas máximas para o cliente ver no link, em caso de cartão
\nhas_delivery (number, obrigatório): Irá mostrar a etapa de endereço no checkout?
\nhas_coupon (number, obrigatório): Irá mostrar campo de cupom de desconto no checkout?
\nexpires_days (number, obrigatório): Dias de validade, usar -1 para link que não expira
\nwebhook (string, optional): Caso queira receber uma request POST de aviso quando o link expirar, adicione aqui a url do seu webhook. o webhook será no seguinte formato { \"event\": \"invoice-expired\", \"object\": { dados da invoice, mesmo que o retorno dessa request }
Dentro do options você pode enviar qualquer outro dado extra também, seja um ID do seu vendedor, ou outro dado. Esses dados poderão ser usados para a busca no painel e vinculo de dados no webhook.
\nvendedor (string, obrigatório): Informação do vendedor
\noutros-dados (string, obrigatório): Você pode enviar qualquer arquivo JSON aqui dentro, para que ele fique disponível em consulta para você
\nRequest para consultar a situação dos pedidos de qualquer cliente que já fez um pedido na sua aplicação increazy. Vide os dados abaixos:
\n- page: página atual da busca
\n- perPage: quantidade de itens retornados por página
\n- filters: objeto de filtros disponíveis, todos os filtros são opcionais, e podem ser usados em conjunto, sendo:
-- filters.document: filtra pelo documento do cliente
-- filters.email: filtra pelo email do cliente
\n-- filters.start: filtra data inicial de finalização do pedido
\n- filters.end: filtra data final de finalização do pedido
\n- filters.extras: filtra por dados extras do pedido, enviados no momento da criação do mesmo. No exemplo dado estamos buscando pelo SLUG mas também por um vendedor chamado Luis, aqui você pode customizar de qualquer forma.
\nNOTA: essa request possui demanda um maior tempo para execução, pois ela vincula todos dados do pedido. Caso seu intuito seja apenas pegar o status do pedido, veja a request posterior.
\n---
Status de pagamento possíveis: waiting, success, canceled
Request para consutla a situação dos pedidos de qualquer cliente que já fez um pedido na sua aplicação increazy. Vide os dados abaixos:
\n- page: página atual da busca
\n- perPage: quantidade de itens retornados por página
\n- filters: objeto de filtros disponíveis, todos os filtros são opcionais, e podem ser usados em conjunto, sendo:
-- filters.document: filtra pelo documento do cliente
-- filters.email: filtra pelo email do cliente
\n-- filters.start: filtra data inicial de finalização do pedido
\n- filters.end: filtra data final de finalização do pedido
\n- filters.extras: filtra por dados extras do pedido, enviados no momento da criação do mesmo. No exemplo dado estamos buscando pelo SLUG mas também por um vendedor chamado Luis, aqui você pode customizar de qualquer forma.
\n---
Status de pagamento possíveis: waiting, success, canceled
Request para consulta a situação dos links de pagamentos criados na increazy. Em caso de já ter um pagamento, o retorno terá todos os pagamentos do link.
\n- page: página atual da busca
\n- perPage: quantidade de itens retornados por página
\n- filters: objeto de filtros disponíveis, todos os filtros são opcionais, e podem ser usados em conjunto, sendo:
-- filters.slug: filtra pelo slug do link
-- filters.start: filtra data inicial de finalização do pedido
\n- filters.end: filtra data final de finalização do pedido
\n- filters.extra: filtra por dados extras do pedido, enviados no momento da criação do mesmo.
\n---
Status de pagamento possíveis: waiting, success, canceled
options.selection: permite o cliente ver a lista de cartões que ele já tem salvo
\noptions.title: titulo que irá aparecer no formulário e listagem de cartões do cliente
\noptions.success_msg: mensagem de sucesso ao criar ou escolher um cartão padrão
\ninput: email ou documento do cliente
\nPara os gateways: Rede, GetNet e Cielo, não é necessárop enviar os objetos customer e address, dado que eles possuem suporte ao Zero Dollar Auth
Segue um detalhamento dos dados enviados na requisição
\nquote_id (number, required): ID externo da transação, pode ser qualquer um definido por você
extra (array): Dados extras
name (string): The name of the item.
quantity (number): The quantity of the item.
sku (string): The stock keeping unit of the item.
price (number): The price of the item.
customer (object): Customer details.
firstname (string): Customer's first name.
lastname (string): Customer's last name.
email (string): Customer's email address.
document (string): Customer's document information.
address (object): Customer's address details.
street (string): Street address.
postcode (string): Postal code.
neighborhood (string): Neighborhood.
city (string): City.
state (string): State.
uf (string): UF.
complement (string): Address complement.
phone (string): Phone number.
country (string): Country.
number (string): Address number.
payment (object): Payment details.
tax (number): Tax amount.
total (number): Total amount.
amount (number): Payment amount.
shipping (number): Shipping amount.
discount (number): Discount amount.
Pagamento com cartão de crédito ou voucher
\npayment.method (string): Enviar como creditcard ou voucher
payment.card_number (string): Card number.
payment.card_year (string): Card expiration year.
payment.card_month (string): Card expiration month.
payment.card_name (string): Cardholder name.
payment.card_cvv (string): Card CVV.
payment.card_flag (string): Card flag.
shipping_description (string): Shipping description.
payment.installments (number): Number of installments.
Pagamento com cartão de crédito salvo
\npayment.method (string): Enviar como onetap
payment.token (string): Token do cartao salvo anteriormente
payment.installments (number): Number of installments.
Pagamento com pix
\npayment.method (string): Enviar como pixPagamento com pix parcelado (pagaleve)
\npayment.method (string): Enviar como pix-installmentPagamento com boleto
\npayment.method (string): Enviar como billetPara usar em outro gateway além da Rede e Mercado Pago, entre em contato e solicite a implementação.
\n","urlObject":{"path":["exec","get-payment"],"host":["{{payment-api}}"],"query":[],"variable":[]}},"response":[{"id":"e32df485-3ef8-4056-a916-9c1aee35e31e","name":"Sucess","originalRequest":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"10462506201028196590\"\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/get-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8002"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 20 Jun 2025 13:39:00 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"method\": \"creditcard\",\n \"gateway\": \"erede\",\n \"id\": \"10462506201028196590\",\n \"created_at\": \"2025-06-20T10:33:07-03:00\",\n \"status\": \"success\",\n \"nsu\": \"125587867\"\n // abaixo os dados do body retornado pelo gateway, não mapeados como padrão\n}"}],"_postman_id":"a21fdcf4-22e2-472e-9b65-9f1a9b314b81"},{"name":"Estornar transação","id":"b325e2f4-fda6-40fb-9dc4-0a20f7b69488","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"11152409061648473981\",\n \"message\": \"solicitado pelo cliente\",\n \"amount\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/cancel-payment","description":"Segue um detalhamento dos dados enviados na requisição
\norder_id (string, required): ID da transação, atributo order retornado na request de criar uma transação
amount (float, optional): valor a ser estornado, caso não enviado iremos fazer o estorno total
message (string, optional): motivo ou comentário sobre o estorno
Rota para buscar as transações realizadas em um periodo de tempo.
\nTodos os atributos são opcionais
\n","urlObject":{"path":["exec","search-payment"],"host":["{{payment-api}}"],"query":[],"variable":[]}},"response":[{"id":"4cdd1c17-2702-4330-a6ae-88ac2550174c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n // todos campos são opcionais, embora não seja indicado não usar o\n // filtro de data, pois a request tem um limite de 30 segundos\n // para a busca dos dados\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-05-26\",\n \"status\": \"success\",\n \"methods\": [\"pix\", \"creditcard\"]\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/search-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8002"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 13:21:43 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"count\": 26,\n \"amount\": 36.2,\n \"amount_without_tax\": 36.2,\n \"amount_tax\": 0,\n \"orders\": [\n {\n \"id\": 129898,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"339012bf7ca947ac8b5375d340e5aa98\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-05-26T12:34:53.000000Z\",\n \"updated_at\": \"2025-05-26T12:37:18.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-05-26 09:35:31\",\n \"expiration\": \"2025-05-29\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": {\n \"url\": \"https://payment.api.increazy.com/qrcode?data=00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/9e3198f84752402fa3574ea9c110d9885204000053039865802BR5905EFISA6008SAOPAULO62070503***630463CF\",\n \"qrcode\": \"00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/9e3198f84752402fa3574ea9c110d9885204000053039865802BR5905EFISA6008SAOPAULO62070503***630463CF\",\n \"barcode\": null\n },\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 129490,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"075ec70add5b4e84b97f499746b6cc0b\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-05-23T18:58:39.000000Z\",\n \"updated_at\": \"2025-05-23T20:04:00.000000Z\",\n \"extra\": {\n \"phone\": \"44999969177\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-05-23 17:03:43\",\n \"expiration\": null,\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"refunded\",\n \"total\": 2,\n \"payment\": {\n \"url\": \"https://payment.api.increazy.com/qrcode?data=00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/6b83c0ce56ee40a6aef954bdb2a5f63c5204000053039865802BR5905EFISA6008SAOPAULO62070503***63049732\",\n \"qrcode\": \"00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/6b83c0ce56ee40a6aef954bdb2a5f63c5204000053039865802BR5905EFISA6008SAOPAULO62070503***63049732\",\n \"barcode\": null\n },\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 129482,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"4f16c2e4768c4b18b3d122dec5c08250\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-05-23T18:21:40.000000Z\",\n \"updated_at\": \"2025-05-23T20:03:54.000000Z\",\n \"extra\": {\n \"phone\": \"44998774989\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-05-23 17:03:43\",\n \"expiration\": null,\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"refunded\",\n \"total\": 2,\n \"payment\": {\n \"url\": \"https://payment.api.increazy.com/qrcode?data=00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/494f05c47fd142b7a6a0b2520e14e5f05204000053039865802BR5905EFISA6008SAOPAULO62070503***630459B1\",\n \"qrcode\": \"00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/494f05c47fd142b7a6a0b2520e14e5f05204000053039865802BR5905EFISA6008SAOPAULO62070503***630459B1\",\n \"barcode\": null\n },\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 129465,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"ff33b9fe5fea4e63a956ef1d4cb6f8da\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-05-23T17:33:27.000000Z\",\n \"updated_at\": \"2025-05-23T20:03:49.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-05-23 17:03:43\",\n \"expiration\": null,\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"refunded\",\n \"total\": 2,\n \"payment\": {\n \"url\": \"https://payment.api.increazy.com/qrcode?data=00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/ae6a7a6396a64c2da444fddc2914fc285204000053039865802BR5905EFISA6008SAOPAULO62070503***6304F912\",\n \"qrcode\": \"00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/ae6a7a6396a64c2da444fddc2914fc285204000053039865802BR5905EFISA6008SAOPAULO62070503***6304F912\",\n \"barcode\": null\n },\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 126264,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E318724952025050719492LFp3fiaI7w\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-05-07T19:49:50.000000Z\",\n \"updated_at\": \"2025-05-07T19:49:50.000000Z\",\n \"extra\": {\n \"txid\": \"0ae691296cf2490c9019703b8b6e7ba0\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.716.616-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"LEONARDO VILARINHO CORREIA DE SOUZA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-05-07 16:19:50\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 4,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 4,\n \"tax_amount\": 0\n },\n {\n \"id\": 123768,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"62ca271180e341c9b4133ed480dd2ea1\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-04-24T15:00:00.000000Z\",\n \"updated_at\": \"2025-04-24T15:01:17.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-04-24 12:00:15\",\n \"expiration\": \"2025-04-25\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 123764,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"1ff1cf36366c442cbc27ae79c79f355c\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-04-24T14:44:41.000000Z\",\n \"updated_at\": \"2025-04-24T14:45:51.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2022-03-22 12:40:15\",\n \"expiration\": \"2025-04-25\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 122675,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"22bbf61d38184c5e89208506e269abb7\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-17T14:31:51.000000Z\",\n \"updated_at\": \"2025-04-17T14:32:56.000000Z\",\n \"extra\": {\n \"phone\": \"44998774989\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2022-03-22 12:40:15\",\n \"expiration\": \"2025-04-18\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 122668,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"a3ced178df66462793b080949679e4bf\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-04-17T14:05:52.000000Z\",\n \"updated_at\": \"2025-04-17T14:08:31.000000Z\",\n \"extra\": {\n \"phone\": \"44998774989\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-04-17 11:07:47\",\n \"expiration\": \"2025-04-18\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 119992,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"c3522d592dd04c45a75c3724c47e85af\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-01T18:31:23.000000Z\",\n \"updated_at\": \"2025-04-01T18:32:33.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-04-01 15:31:37\",\n \"expiration\": \"2025-04-02\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 1.37,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1.37,\n \"tax_amount\": 0\n },\n {\n \"id\": 119991,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"4d5d6f97870d4fba86e1b7bbeae752dc\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-04-01T18:26:59.000000Z\",\n \"updated_at\": \"2025-04-01T18:29:06.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2025-04-01 15:27:37\",\n \"expiration\": \"2025-04-02\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 1.37,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1.37,\n \"tax_amount\": 0\n },\n {\n \"id\": 119986,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"dfa0a2f8b8b24e0aae9cb7ebd33e2973\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-01T18:19:42.000000Z\",\n \"updated_at\": \"2025-04-01T18:20:53.000000Z\",\n \"extra\": {\n \"phone\": null,\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2022-03-22 12:40:15\",\n \"expiration\": \"2025-04-02\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1,\n \"tax_amount\": 0\n },\n {\n \"id\": 119943,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202504011410s0220511a30\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-01T14:10:18.000000Z\",\n \"updated_at\": \"2025-04-01T19:30:41.000000Z\",\n \"extra\": {\n \"txid\": \"MINI0001D8E0\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.033.299-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"BRUNO UMEMURA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-04-01 10:40:18\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"refunded\",\n \"total\": 1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1,\n \"tax_amount\": 0\n },\n {\n \"id\": 119941,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202504011404s02a68f182a\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-01T14:05:12.000000Z\",\n \"updated_at\": \"2025-04-01T14:05:12.000000Z\",\n \"extra\": {\n \"txid\": \"MINI0001D8E0\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.033.299-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"BRUNO UMEMURA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-04-01 10:35:12\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.29,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.29,\n \"tax_amount\": 0\n },\n {\n \"id\": 119938,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202504011402s029f5ddc9c\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-04-01T14:02:37.000000Z\",\n \"updated_at\": \"2025-04-01T14:02:37.000000Z\",\n \"extra\": {\n \"txid\": \"MINI0001D8E0\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.033.299-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"BRUNO UMEMURA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-04-01 10:32:37\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.25,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.25,\n \"tax_amount\": 0\n },\n {\n \"id\": 119025,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202503262230s176bfa9bff\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-03-26T22:30:30.000000Z\",\n \"updated_at\": \"2025-03-26T22:30:30.000000Z\",\n \"extra\": {\n \"txid\": \"MINI0001D8E0\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": null,\n \"cliente_cnpj\": \"46547011000197\",\n \"cliente_nome\": \"MICHAEL JULIAN BARRIQUELLO \"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-03-26 19:00:30\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 2,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2,\n \"tax_amount\": 0\n },\n {\n \"id\": 118848,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202503251934s17be27ce18\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-03-25T19:34:55.000000Z\",\n \"updated_at\": \"2025-03-25T19:34:55.000000Z\",\n \"extra\": {\n \"txid\": \"MIDI123456\",\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": null,\n \"cliente_cnpj\": \"46547011000197\",\n \"cliente_nome\": \"MICHAEL JULIAN BARRIQUELLO \"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-03-25 16:04:55\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1,\n \"tax_amount\": 0\n },\n {\n \"id\": 118837,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E18236120202503251856s177e2fd800\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-03-25T18:56:38.000000Z\",\n \"updated_at\": \"2025-03-25T18:56:38.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": null,\n \"cliente_cnpj\": \"46547011000197\",\n \"cliente_nome\": \"MICHAEL JULIAN BARRIQUELLO \"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-03-25 15:26:38\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1,\n \"tax_amount\": 0\n },\n {\n \"id\": 118764,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"9186712dba5d49b8a1c0c8813d8a0c95\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-03-25T13:37:14.000000Z\",\n \"updated_at\": \"2025-03-25T13:38:13.000000Z\",\n \"extra\": {\n \"phone\": \"44991752440\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2022-03-22 12:40:15\",\n \"expiration\": \"2025-03-26\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2.5,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2.5,\n \"tax_amount\": 0\n },\n {\n \"id\": 118742,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"30c4b2265a184e6194dc426ed3550a1f\",\n \"gateway\": \"signapay\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 1,\n \"created_at\": \"2025-03-25T12:17:56.000000Z\",\n \"updated_at\": \"2025-03-25T12:19:44.000000Z\",\n \"extra\": {\n \"phone\": \"44991752440\",\n \"id_maquina\": \"MINI_0001D8E0\",\n \"payment_name\": \"\",\n \"identifier_type\": \"PHONE\"\n },\n \"notified_creation\": 1,\n \"last_verification\": \"2022-03-22 12:40:15\",\n \"expiration\": \"2025-03-26\",\n \"details\": {\n \"address\": null,\n \"installments\": 1\n },\n \"runs\": 4,\n \"substatus\": \"complete\",\n \"total\": 2.5,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 2.5,\n \"tax_amount\": 0\n },\n {\n \"id\": 106875,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E31872495202501101657CrGGmiFaAfZ\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-10T16:57:18.000000Z\",\n \"updated_at\": \"2025-01-10T16:57:18.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.716.616-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"LEONARDO VILARINHO CORREIA DE SOUZA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-10 13:27:18\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.1,\n \"tax_amount\": 0\n },\n {\n \"id\": 106874,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E31872495202501101655Tm0wbnxKlH8\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-10T16:55:39.000000Z\",\n \"updated_at\": \"2025-01-10T16:55:39.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.716.616-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"LEONARDO VILARINHO CORREIA DE SOUZA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-10 13:25:39\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.1,\n \"tax_amount\": 0\n },\n {\n \"id\": 106771,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E31872495202501092055EkKBScQjRKR\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-09T20:55:18.000000Z\",\n \"updated_at\": \"2025-01-09T20:55:18.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.784.549-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"JOAO FELIPE CASTANHO MOREIRA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-09 17:25:18\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.21,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.21,\n \"tax_amount\": 0\n },\n {\n \"id\": 106770,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E31872495202501092054QxfiezX6vgv\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-09T20:54:55.000000Z\",\n \"updated_at\": \"2025-01-09T20:54:55.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.784.549-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"JOAO FELIPE CASTANHO MOREIRA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-09 17:24:55\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.5,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.5,\n \"tax_amount\": 0\n },\n {\n \"id\": 106764,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E318724952025010920108bjmxnDysPA\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-09T20:10:12.000000Z\",\n \"updated_at\": \"2025-01-09T20:10:12.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.716.616-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"LEONARDO VILARINHO CORREIA DE SOUZA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-09 16:40:12\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 1,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 1,\n \"tax_amount\": 0\n },\n {\n \"id\": 106682,\n \"ecommerce_id\": \"i1733344182\",\n \"order_id\": \"E31872495202501082014poz3t73LGFh\",\n \"gateway\": \"efi\",\n \"recurrence_id\": null,\n \"status\": \"success\",\n \"method\": \"pix\",\n \"notified\": 0,\n \"created_at\": \"2025-01-09T13:30:44.000000Z\",\n \"updated_at\": \"2025-01-09T13:30:44.000000Z\",\n \"extra\": {\n \"chave_pix\": \"ecc0ca7f-cc60-4af5-9e8b-1b83bc2a2ad7\",\n \"descricao\": null,\n \"cliente_cpf\": \"***.716.616-**\",\n \"cliente_cnpj\": null,\n \"cliente_nome\": \"LEONARDO VILARINHO CORREIA DE SOUZA\"\n },\n \"notified_creation\": 0,\n \"last_verification\": \"2025-01-09 10:00:44\",\n \"expiration\": null,\n \"details\": null,\n \"runs\": 0,\n \"substatus\": \"complete\",\n \"total\": 0.01,\n \"payment\": null,\n \"tax\": 0,\n \"total_without_tax\": 0.01,\n \"tax_amount\": 0\n }\n ]\n}"}],"_postman_id":"e2fa714a-a9f2-4d75-a098-e9f7a03a410d"},{"name":"Busca resumo de transações","id":"872ad78e-e95f-47eb-a8f9-8940d13f0dc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"2025-05-01\",\n \"end_date\": \"2025-05-26\",\n \"status\": \"success\",\n \"methods\": \"pix,creditcard\"\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/summary-payment","description":"Rota para agrupar os pagamentos baseado no método de cada um, onde é possivel ver o total de transações feitas com aquele meio de pagamento.
\nTodos os atributos são opcionais
\n","urlObject":{"path":["exec","summary-payment"],"host":["{{payment-api}}"],"query":[],"variable":[]}},"response":[{"id":"6bc53835-69b6-4da9-a4c4-e6eaebbf1329","name":"Success","originalRequest":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n // todos campos são opcionais, embora não seja indicado não usar o\n // filtro de data, pois a request tem um limite de 30 segundos\n // para a busca dos dados\n \"start_date\": \"2025-05-01\",\n \"end_date\": \"2025-05-26\",\n \"status\": \"success\",\n \"methods\": \"pix,creditcard\"\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/summary-payment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8002"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.2.28"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 26 May 2025 13:21:36 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"summary\": [\n {\n \"method\": \"pix\",\n \"count\": 5,\n \"amount\": 12,\n \"amount_tax\": 0,\n \"amount_without_tax\": 12\n }\n ]\n}"}],"_postman_id":"872ad78e-e95f-47eb-a8f9-8940d13f0dc0"},{"name":"Busca status de transação","id":"b5d053fd-bab9-4284-8b23-733f22398f5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"language","value":"pt","type":"text"},{"key":"api-key","value":"{{api-key-payment}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"order_id\": \"11152409061648473981\",\n \"message\": \"solicitado pelo cliente\",\n \"amount\": 2\n}","options":{"raw":{"language":"json"}}},"url":"{{payment-api}}/exec/status-payment","description":"Segue um detalhamento dos dados enviados na requisição
\norder_id (string, required): ID da transação, atributo order retornado na request de criar uma transaçãoSegue um detalhamento dos dados enviados na requisição
\norder_id (string, required): ID da transação, atributo order retornado na request de criar uma transação
amount (float, optional): valor a ser estornado, caso não enviado iremos fazer o estorno total
message (string, optional): motivo ou comentário sobre o estorno
Segue um detalhamento dos dados enviados na requisição
\norder_id (string, required): ID da transação, atributo order retornado na request de criar uma transação
amount (float, optional): valor a ser estornado, caso não enviado iremos fazer o estorno total
message (string, optional): motivo ou comentário sobre o estorno
Cria um link UNICO para o cliente acessar a tela de minha conta dele
Quando você cadastra uma URL de notificação de pagamentos, ao recebermos algum update do status do pagamento iremos realizar essa chamada para o seu servidor.
\nAlguns pontos importantes:
\na request será do tipo POST
\no body terá o padrão exemplificado aqui
\nmeios de pagamentos possiveis: pix, billet e creditcard
\nstatus possíveis: waiting, canceled, success
\nsua api deve retornar o status 200 para sabermos que o resultado foi capturado, caso retorne outro status iremos continuar notificando mais vezes
\nNessa pasta você encontra a documentação das requests para que você consiga cobrar seus clientes de uma maneira rápida e direta, seja usando nosso checkout, ou já transacionando direto a compra.
\nVocê tem um painel administrativo, ERP, etc, e precisa cobrar seus clientes e gerenciar o pagamento de cada um de maneira fácil? Então essa integração é pra você!
\nSeguir a orientação da Autenticação principal dessa documentação, ou seja:
\n- Criar um token no painel da increazy, em Configurações > Tokens de APIs
--- Use o tipo 'Ecommerce' para gerenciamento de pedidos e links de pagamento.
--- Use o tipo 'Pagamento' para gerenciamento de transações e cobrar diretamente um cliente.
- Após a criação do token, basta usar ele no header api-key
pode ser agency ou manager
\n","type":"text"}]},"url":"{{connect-api}}/whitelabel/new","description":"Quando você precisar criar um novo painel para uma empresa cliente, basta enviar esses dados de acordo com as configurações do seu cliente.
\nVale mencionar, que o cliente do email enviado na request precisa já ter uma conta na increazy, ele será vinculado como DONO do painel criado. Podendo assim ver todos apps criados nesse novo painel, e convidar novos gerentes para acesso.
\n","urlObject":{"path":["whitelabel","new"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"72c476c7-32c7-4750-a8c1-aa0138366492","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Teste Increazy","type":"text","description":"nome apresentado no painel e navegador"},{"key":"domain","value":"wh.increazy.com","type":"text","description":"dominio para acessar o painel"},{"key":"color","value":"#fafafa","type":"text","description":"cor principal do painel"},{"key":"has_layout","value":"1","type":"text","description":"se havera o modulo 'layout'"},{"key":"has_ecommerce","value":"1","type":"text","description":"se havera o modulo 'plataforma'"},{"key":"has_checkout","value":"1","type":"text","description":"se havera o modulo 'checkout'"},{"key":"has_payments","value":"1","type":"text","description":"se havera o modulo 'pagamentos'"},{"key":"owner","value":"leonardo@increazy.com","type":"text","description":"email do dono desse painel, ele precisa ter conta na increazy"},{"key":"logo","description":"logo PNG exibido na abertura do menu, formato retangular","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/euleonardov/Downloads/logo-increazy-azul.png"],"src":"/Users/euleonardov/Downloads/logo-increazy-azul.png"},{"key":"square","description":"logo PNG exibido de forma comprimida, formato quadrado","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/euleonardov/Downloads/logos-incz/increazy-brandkit-05.png"],"src":"/Users/euleonardov/Downloads/logos-incz/increazy-brandkit-05.png"}]},"url":"{{connect-api}}/whitelabel/new"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Mon, 01 Jul 2024 19:52:41 GMT"},{"key":"Date","value":"Mon, 01 Jul 2024 19:52:41 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Teste Increazy\",\n \"domain\": \"wh.increazy.com\",\n \"logo\": \"https://storage.increazy.com/whitelabels/6fa281909efa6a7cb1997bc506b50da4/logo-1719863559-668309074f416.png\",\n \"square\": \"https://storage.increazy.com/whitelabels/6fa281909efa6a7cb1997bc506b50da4/square-1719863559-66830907df6ee.png\",\n \"color\": \"#fafafa\",\n \"has_layout\": \"1\",\n \"has_ecommerce\": \"1\",\n \"has_checkout\": \"1\",\n \"has_payments\": \"1\",\n \"father_id\": 1,\n \"hash\": \"c81abcd05e8df1e7081ee6665ee8f4ee\",\n \"type\": \"agency\",\n \"id\": 10\n}"}],"_postman_id":"aec8684d-e048-4f67-990b-a724ebe649d7"},{"name":"Atualizar dados de um painel","id":"be027f87-c64f-4db0-8fc7-afc07f86d5b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"{{connect-api}}/whitelabel/update","description":"Precisa trocar alguma cor, logo ou dado do whitelabel? Use essa request.
\nOs menus de módulos só podem ser editados por um administrador da empresa que criou o whitelabel.
\nPra trocar de domínio por favor entre em contato conosco.
\n","urlObject":{"path":["whitelabel","update"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"8fd246c7-83cc-4de7-a7d2-476160dc81ac","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Teste Leonardo edit","type":"text"},{"key":"color","value":"#ffffff","type":"text"},{"key":"has_layout","value":"1","type":"text","disabled":true},{"key":"has_ecommerce","value":"1","type":"text","disabled":true},{"key":"has_checkout","value":"1","type":"text","disabled":true},{"key":"has_payments","value":"1","type":"text","disabled":true},{"key":"logo","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/euleonardov/Documents/002890597E0DC4A40BDA987FDFFCB38A_thumbnail_600x.jpg"],"src":"/Users/euleonardov/Documents/002890597E0DC4A40BDA987FDFFCB38A_thumbnail_600x.jpg","disabled":true},{"key":"square","type":"file","src":"/Users/euleonardov/Downloads/1.png"}]},"url":"{{connect-api}}/whitelabel/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Fri, 05 Jul 2024 19:24:02 GMT"},{"key":"Date","value":"Fri, 05 Jul 2024 19:24:02 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 6,\n \"domain\": \"whleonardo.qualck.com\",\n \"name\": \"Teste Leonardo edit\",\n \"color\": \"#ffffff\",\n \"logo\": \"https://storage.increazy.com/whitelabels/6fa5676709efa6a7cb1997bc506b50da4/logo-1720207400-6688482884eb5.jpg\",\n \"has_layout\": 1,\n \"has_ecommerce\": 1,\n \"has_checkout\": 1,\n \"has_payments\": 1,\n \"square\": \"https://storage.increazy.com/whitelabels/6fa5676709efa6a7cb1997bc506b50da4/square-1720207439-6688484f04899.png\",\n \"type\": \"agency\",\n \"hash\": \"6fa5676709efa6a7cb1997bc506b50da4\",\n \"father_id\": null\n}"}],"_postman_id":"be027f87-c64f-4db0-8fc7-afc07f86d5b6"},{"name":"Buscar entradas DNS do painel","id":"b058a889-96c7-4c4a-9f50-60d0afa53874","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"domain","value":"wht.increazy.com","type":"text"}]},"url":"{{connect-api}}/whitelabel/records","description":"Após criar um painel, é necessário apontar o DNS do cliente para nossa infraestrutura, com essa request você saberá as entradas ideais para serem adicionadas no DNS.
\nVeja nos exemplos de requests que temos 4 etapas possiveis de status:
- PENDING_VERIFICATION: quando o painel foi criado, mas o cliente ainda não apontou o DNS.
- PENDING_DEPLOYMENT: o DNS foi validado, com esse status estaremos preparando a infraestrutura do painel, esse processo pode demorar até 30 minutos.
- AVAILABLE: quando o painel do cliente já está disponível para ser acessado.
- FAILED : quando houve algum erro no processo de DNS.
Quando você precisar criar um novo painel para uma empresa cliente, basta enviar esses dados de acordo com as configurações do seu cliente.
\nVale mencionar, que o cliente do email enviado na request precisa já ter uma conta na increazy, ele será vinculado como DONO do painel criado. Podendo assim ver todos apps criados nesse novo painel, e convidar novos gerentes para acesso.
\n","urlObject":{"path":["whitelabel","managers"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"732e3cb5-d0e3-492c-b95e-d569fee962c7","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"mamedio@increazy.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/whitelabel/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Thu, 04 Jul 2024 19:54:53 GMT"},{"key":"Date","value":"Thu, 04 Jul 2024 19:54:53 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 6,\n \"count\": 2,\n \"total\": 2,\n \"list\": [\n {\n \"id\": 1,\n \"name\": \"Increazy Results\",\n \"email\": \"leonardo@increazy.com\",\n \"type\": \"owner\"\n },\n {\n \"id\": 106,\n \"name\": \"Guilherme Mamedio\",\n \"email\": \"mamedio@increazy.com\",\n \"type\": \"guest\"\n }\n ]\n}"},{"id":"0b6d35ff-77d0-4575-a074-d86c7288bda1","name":"Error","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"email\": \"usuarioconvidade@increazy.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/whitelabel/managers"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Thu, 04 Jul 2024 19:54:37 GMT"},{"key":"Date","value":"Thu, 04 Jul 2024 19:54:37 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"fail\",\n \"errors\": {\n \"email\": [\n \"There is no record with this field in the system..\"\n ]\n }\n}"}],"_postman_id":"3b1d171c-fb59-420d-97fd-46a572ed679b"},{"name":"Recuperar lista de administradores","id":"cba579f6-0617-44d8-9591-dd56ab1e16e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/whitelabel/managers","description":"Quando você precisar criar um novo painel para uma empresa cliente, basta enviar esses dados de acordo com as configurações do seu cliente.
\nVale mencionar, que o cliente do email enviado na request precisa já ter uma conta na increazy, ele será vinculado como DONO do painel criado. Podendo assim ver todos apps criados nesse novo painel, e convidar novos gerentes para acesso.
\n","urlObject":{"path":["whitelabel","managers"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"fa700bcc-e095-405a-9339-ec84be356347","name":"Success","originalRequest":{"method":"GET","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/whitelabel/managers"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Thu, 04 Jul 2024 19:56:39 GMT"},{"key":"Date","value":"Thu, 04 Jul 2024 19:56:39 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 6,\n \"count\": 2,\n \"total\": 2,\n \"list\": [\n {\n \"id\": 1,\n \"name\": \"Increazy Results\",\n \"email\": \"leonardo@increazy.com\",\n \"type\": \"owner\"\n },\n {\n \"id\": 106,\n \"name\": \"Guilherme Mamedio\",\n \"email\": \"mamedio@increazy.com\",\n \"type\": \"guest\"\n }\n ]\n}"}],"_postman_id":"cba579f6-0617-44d8-9591-dd56ab1e16e1"},{"name":"Remove um administrador","id":"c2e913b1-0401-48cc-bda1-8de45179f9a7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/whitelabel/managers/106","description":"Quando você precisar criar um novo painel para uma empresa cliente, basta enviar esses dados de acordo com as configurações do seu cliente.
\nVale mencionar, que o cliente do email enviado na request precisa já ter uma conta na increazy, ele será vinculado como DONO do painel criado. Podendo assim ver todos apps criados nesse novo painel, e convidar novos gerentes para acesso.
\n","urlObject":{"path":["whitelabel","managers","106"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"a47db203-95c6-4528-a74e-beaa54e635ce","name":"Success","originalRequest":{"method":"DELETE","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/whitelabel/managers/106"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Thu, 04 Jul 2024 20:00:10 GMT"},{"key":"Date","value":"Thu, 04 Jul 2024 20:00:10 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"current_page\": 1,\n \"last_page\": 1,\n \"per_page\": 6,\n \"count\": 1,\n \"total\": 1,\n \"list\": [\n {\n \"id\": 1,\n \"name\": \"Increazy Results\",\n \"email\": \"leonardo@increazy.com\",\n \"type\": \"owner\"\n }\n ]\n}"},{"id":"693cdd03-b3f5-4b69-b2c8-b7c7e2bb0627","name":"Error","originalRequest":{"method":"DELETE","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/whitelabel/managers/1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Thu, 04 Jul 2024 19:59:48 GMT"},{"key":"Date","value":"Thu, 04 Jul 2024 19:59:48 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Não é possível remover o dono do painel\"\n}"}],"_postman_id":"c2e913b1-0401-48cc-bda1-8de45179f9a7"}],"id":"dedcd80b-4ea2-4344-a6fb-5ceff787325d","_postman_id":"dedcd80b-4ea2-4344-a6fb-5ceff787325d","description":""},{"name":"Onboard","item":[{"name":"Criar um app","id":"864ae280-7cd5-45bd-8b0e-060b7e2e26f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Meu app\",\n \"owner\": \"mamedio@increazy.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/onboard/app","description":"Para criar um novo aplicativo no sistema basta nos enviar o nome dele, o owner é um dado opcional, caso passado, vai ser o usuário que inicialmente vai ter aceso ao gerenciamento desse app. Porém para isso, esse email já precisa ter conta na increazy ou no seu painel da increazy.
\nNOTA: salve o ID do aplicativo, caso queira continuar com outras etapas do onboard.
\n","urlObject":{"path":["onboard","app"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"e76b7480-2135-489a-b3b2-563ad658c72d","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}","type":"text"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Meu app\",\n \"owner\": \"mamedio@increazy.com\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/onboard/app"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Tue, 09 Jul 2024 13:05:53 GMT"},{"key":"Date","value":"Tue, 09 Jul 2024 13:05:53 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"name\": \"Meu app completo5 1720708187\",\n \"whitelabel_id\": 1,\n \"updated_at\": \"2024-07-11T14:29:49.000000Z\",\n \"created_at\": \"2024-07-11T14:29:49.000000Z\",\n \"id\": 270,\n \"platform\": {\n \"settings\": {\n \"name\": \"increazy\",\n \"app_id\": 270\n },\n \"master_id\": \"270\",\n \"code\": \"i1720708199\",\n \"updated_at\": \"2024-07-11T14:29:59.000000Z\",\n \"created_at\": \"2024-07-11T14:29:59.000000Z\",\n \"id\": 164\n },\n \"checkout\": {\n \"name\": \"increazy\",\n \"app_id\": \"270\",\n \"accept_corporate\": \"0\",\n \"accept_terms\": \"0\",\n \"has_birthdate\": \"0\",\n \"has_delivery\": \"1\",\n \"has_quantity_input\": \"0\",\n \"with_image\": \"0\",\n \"has_coupon_input\": \"0\",\n \"layout\": \"increazy-ux\",\n \"colors\": {\n \"primary\": \"#000000\",\n \"secondary\": \"#ffffff\"\n },\n \"title\": \"Meu app completo5 1720708187\",\n \"policies\": \"\",\n \"type\": \"ecommerce\",\n \"paymentTypes\": \"billet,pix,creditcard\",\n \"has_tax\": \"1\",\n \"has_multiples_cards\": \"0\",\n \"login_with_cpf\": \"0\",\n \"image\": \"\",\n \"favicon\": \"\"\n }\n}"}],"_postman_id":"864ae280-7cd5-45bd-8b0e-060b7e2e26f9"},{"name":"Criar um checkout dentro de um app","id":"5fd0d84e-041b-40ba-98b8-6d036ca53e1b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{user-token}}"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"app_id","value":"255","type":"text"},{"key":"accept_corporate","value":"1","type":"text"},{"key":"accept_terms","value":"1","type":"text"},{"key":"colors[primary]","value":"#ccc","type":"text"},{"key":"colors[secondary]","value":"#f8f8f8","type":"text"},{"key":"has_birthdate","value":"1","type":"text"},{"key":"has_coupon_input","value":"1","type":"text"},{"key":"has_delivery","value":"1","type":"text"},{"key":"has_quantity_input","value":"1","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/euleonardov/Downloads/—Pngtree—letter w logo png_6100847.png"],"src":"/Users/euleonardov/Downloads/—Pngtree—letter w logo png_6100847.png"},{"key":"layout","value":"increazy-ux","type":"text"},{"key":"title","value":"Meu checkout","type":"text"},{"key":"with_image","value":"1","type":"text"},{"key":"qty_complement","value":"30","type":"text"},{"key":"colors[primary]","value":"#ff0000","type":"text"},{"key":"colors[secondary]","value":"#ffffff","type":"text"},{"key":"policies[0][label]","value":"link 1","type":"text"},{"key":"policies[0][url]","value":"https://increazy.com","type":"text"}]},"url":"{{connect-api}}/onboard/checkout","description":"Nessa request você pode configurar a aparência do checkout do seu cliente, adicionando o nome, as cores, e outros detalhes para o mesmo, veja abaixo:
\n- app_id: o ID do aplicativo do cliente, criando na request anterior
\n- accept_corporate: se será aceito cadastros de CNPJ
\n- accept_terms: se marcado como true, antes de finalizar a compra, o cliente irá precisar marcar um checkbox indicando que ele leu os termos do cliente
\n- colors: cores primária e secundária do checkout
\n- has_birthdate: obriga o preenchimento da data de nascimento no cadastro de um novo cliente
\n- has_coupon_input: mostra o campo de inserir e remover cupom de desconto na lateral do checkout
\n- has_delivery: mostra a etapa de endereço no checkout, permitindo o cliente ter mais de um endereço no seu perfil
\n- has_quantity_input: permite que o cliente mude a quantidade dos produtos do carrinho
\n- image: upload de imagem que será mostrada no header do checkout
\n- title: titulo da janela do checkout que aparece na aba do navegador
\n- with_image: mostra as imagens dos produtos no carrinho, quando hovuer
\n- qty_complement: limita a quantidade de caracteres no campo de complemento do endereço
\n- policies: array com as politicas do lojista que irá vender no checkout, caso exista
\nNOTA: não é obrigatória, pois ao criar um aplicativo ele já terá um checkout preto, com uma logo de placeholder
\n","urlObject":{"path":["onboard","checkout"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"8df59f4c-7e5d-4328-b9fe-611f8fc3e63c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"app_id","value":"255","type":"text"},{"key":"accept_corporate","value":"1","type":"text"},{"key":"accept_terms","value":"1","type":"text"},{"key":"colors[primary]","value":"#ccc","type":"text"},{"key":"colors[secondary]","value":"#f8f8f8","type":"text"},{"key":"has_birthdate","value":"1","type":"text"},{"key":"has_coupon_input","value":"1","type":"text"},{"key":"has_delivery","value":"1","type":"text"},{"key":"has_multiples_cards","value":"0","type":"text"},{"key":"has_quantity_input","value":"1","type":"text"},{"key":"has_tax","value":"1","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/Users/euleonardov/Downloads/—Pngtree—letter w logo png_6100847.png"],"src":"/Users/euleonardov/Downloads/—Pngtree—letter w logo png_6100847.png"},{"key":"layout","value":"increazy-ux","type":"text","description":"increazy-ux ou step-by-step"},{"key":"paymentTypes","value":"billet,pix,creditcard","type":"text"},{"key":"title","value":"Meu checkout","type":"text"},{"key":"with_image","value":"1","type":"text","description":"opcional"},{"key":"qty_complement","value":"30","type":"text","description":"opcional"},{"key":"colors[primary]","value":"#ff0000","type":"text"},{"key":"colors[secondary]","value":"#ffffff","type":"text"},{"key":"policies[0][label]","value":"link 1","type":"text","description":"opcional"},{"key":"policies[0][url]","value":"https://increazy.com","type":"text","description":"opcional"}]},"url":"{{connect-api}}/onboard/checkout"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Tue, 09 Jul 2024 17:33:55 GMT"},{"key":"Date","value":"Tue, 09 Jul 2024 17:33:55 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"app_id\": \"255\",\n \"accept_corporate\": \"1\",\n \"accept_terms\": \"1\",\n \"colors\": {\n \"primary\": \"#ff0000\",\n \"secondary\": \"#ffffff\"\n },\n \"has_birthdate\": \"1\",\n \"has_coupon_input\": \"1\",\n \"has_delivery\": \"1\",\n \"has_multiples_cards\": \"0\",\n \"has_quantity_input\": \"1\",\n \"has_tax\": \"1\",\n \"layout\": \"increazy-ux\",\n \"login_with_cpf\": \"0\",\n \"paymentTypes\": \"billet,pix,creditcard\",\n \"title\": \"Meu checkout\",\n \"type\": \"ecommerce\",\n \"with_image\": \"1\",\n \"qty_complement\": \"30\",\n \"policies\": [\n {\n \"label\": \"link 1\",\n \"url\": \"https://increazy.com\"\n }\n ],\n \"image\": \"https://storage.increazy.com/applications/333/image-1720546434-668d748292db5.png\",\n \"favicon\": \"https://storage.increazy.com/applications/333/favicon-1720546434-668d7482d526f.png\"\n}"}],"_postman_id":"5fd0d84e-041b-40ba-98b8-6d036ca53e1b"},{"name":"Registrar uma plataforma","id":"165b96d0-d5f8-4af2-b464-61b22828c55e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"token","value":"{{user-token}}"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"app_id\": 255,\n \"name\": \"increazy\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/onboard/platform","description":"Registra que o aplicativo do cliente irá usar a plataforma da increazy.
\nNOTA: não é obrigatória, pois ao criar um aplicativo ele já será registrado na plataforma de increazy por padrão
\n","urlObject":{"path":["onboard","platform"],"host":["{{connect-api}}"],"query":[],"variable":[]}},"response":[{"id":"f1d0b4e7-7c6c-4c54-8722-77760617d0a2","name":"Success","originalRequest":{"method":"POST","header":[{"key":"token","value":"{{user-token}}"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"app_id\": 255,\n \"name\": \"increazy\"\n}","options":{"raw":{"language":"json"}}},"url":"{{connect-api}}/onboard/platform"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Host","value":"localhost:8006"},{"key":"Date","value":"Tue, 09 Jul 2024 18:22:10 GMT"},{"key":"Date","value":"Tue, 09 Jul 2024 18:22:10 GMT"},{"key":"Connection","value":"close"},{"key":"X-Powered-By","value":"PHP/8.0.30"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Content-Type","value":"application/json"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 154,\n \"settings\": {\n \"app_id\": 255,\n \"name\": \"increazy\"\n },\n \"master_id\": 255,\n \"created_at\": \"2024-07-09T17:53:40.000000Z\",\n \"updated_at\": \"2024-07-09T18:22:10.000000Z\",\n \"code\": \"i1720547620\",\n \"old_code\": null\n}"}],"_postman_id":"165b96d0-d5f8-4af2-b464-61b22828c55e"},{"name":"Recuperar lista de gateways","id":"2fdb5668-108c-463e-9c75-103411a4590a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"token","value":"{{user-token}}"},{"key":"whitelabel","value":"{{whitelabel-hash}}","type":"text"}],"url":"{{connect-api}}/onboard/payment-gateways/pix","description":"Recupera a lista de gateways disponiveis para o meio de pagamento indicado. Os meios de pagamentos atuais são: pix, billet e creditcard.
O retorno é precioso, pois o objeto credentials mostra os campos que cada gateway usa para ser considerado, esses dados devem ser usados na hora de registrar o meio de pagamento no app.
Seta as credenciais e gateway de um meio de pagamento no aplicativo. Essa request contém os dados dinâmicos, com exceção dos atributos a seguir:
\n- app_id: id do aplicativo criado
- gateway: nome do gateway a ser cadastrado, retornado na requets GET
- order: prioridade de ordem em que o pagamento será mostrado no checkout e retornado na API
Os demais dados são no formato indicado pelo atributo credentials retornado na requets de busca dos dados de integração (request GET).
Os meios de pagamentos disponíveis são: pix, billet e creditcard.
Você já quer fornecer um aplicativo todo configurado para que seu cliente já entre no painel podendo criar links de pagamento sem precisar configurar nada?
\nSe sim, essa pasta da API é para você! Aqui você poderá configurar tudo dentro de um aplicativo para que seja viável seu cliente já entrar nele pronto para uso.
\n","_postman_id":"823418f5-735f-4a94-9c5d-8fd501b97aec"}],"id":"336c8658-b24b-485e-b015-025688e68607","description":"Nessa pasta você encontra a documentação das requests para que você consiga gerenciar os whitelabels que sua empresa administra.
\nVocê é uma parceiro increazy e cria whitelabels para os seus clientes? Então essa integração é pra você!
\nPara autenticar, você precisará do token de API do usuário master ou gerenciadores da sua empresa, e também do hash do whitelabel criado para a sua empresa, esses dados estarão no painel da increazy. E você usará eles nos headers:
\n- whitelabel : hash do whitelabel criado pela increazy
- token : hash de token do usuário master ou convidado para gerir sua empresa na increazy