{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"a16f520a-648a-42f4-9d35-bd31195a0987","name":"MeuEcomm","description":"# 🧑‍💻 Início\n\nBem-vindo à documentação oficial da API do [**MeuEcomm**](https://meuecomm.com/). Com ela você integra o seu sistema (ERP, e-commerce, BI etc.) ao MeuEcomm.\n\nDúvidas? Fale com o nosso time de desenvolvimento: [developer@meuecomm.com](mailto:developer@meuecomm.com).\n\n### 🔗 URL base\n\n`https://api.meuecomm.com/`\n\nTodas as chamadas devem usar **HTTPS**.\n\n### 🔑 Autenticação\n\nEnvie o token da sua empresa em **todas** as requisições, no header:\n\n`Authorization: {{bearer_token_149p}}`\n\nPara gerar o token, acesse a plataforma do MeuEcomm, menu **Configurações › Dados gerais**. O acesso à API depende do seu plano.\n\n**🚨 Guarde o seu token em segurança.** Ele dá acesso de leitura e escrita aos dados da sua empresa.\n\nPara testar no Postman, preencha a variável `API_TOKEN` da collection só com o token, sem o prefixo `Bearer`.\n\n### 🔐 Comunicação\n\nA API segue o padrão REST e troca mensagens em JSON (exceto os envios de arquivo, que usam `multipart/form-data`).\n\nToda resposta tem:\n\n| Campo | Descrição |\n| --- | --- |\n| `status` | `success` ou `error` |\n| `data` | Os dados (objeto/lista) em caso de sucesso, ou a mensagem de erro |\n\nAlguns endpoints trazem campos extras na raiz da resposta, como `id_cliente` no cadastro ou `total` e `offset` nas listagens.\n\n⚠️ Erros de validação voltam com **HTTP 200** e `\"status\": \"error\"`. Sempre verifique o campo `status`. Token inválido ou ausente retorna **HTTP 401** com `\"data\": \"Token inválido.\"`.\n\n| Método | Uso |\n| --- | --- |\n| GET | Consultar registros |\n| POST | Cadastrar registros ou executar ações |\n| PUT | Alterar registros |\n| DELETE | Excluir registros |\n\n### 📄 Paginação\n\nAs listagens aceitam `limit` (padrão 30, **máximo 100**) e `offset`. A resposta traz `total`, com o total de registros do filtro, e `offset`. Para buscar tudo, repita a chamada somando `limit` ao `offset` até alcançar o `total`.\n\n### 🔄 Sincronização\n\nHá duas formas de manter os dois sistemas alinhados:\n\n- **Campo `integrado`:** todo registro criado ou alterado **na plataforma** do MeuEcomm fica com `integrado = 0`. Liste com `?integrado=0`, importe no seu sistema e marque como integrado pelos endpoints **Integrar** (ou enviando `\"integrado\": 1` no cadastro/alteração).\n- **Campo `data_alteracao`:** as listagens aceitam `?data_alteracao=<timestamp Unix>` e retornam só o que mudou depois desse instante.\n\nBoa codificação! 🚀","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"34696179","team":6199178,"collectionId":"a16f520a-648a-42f4-9d35-bd31195a0987","publishedId":"2sBYHUSfLt","public":true,"publicUrl":"https://documenter-api.postman.tech/view/34696179/2sBYHUSfLt","privateUrl":"https://go.postman.co/documentation/34696179-a16f520a-648a-42f4-9d35-bd31195a0987","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"9f1ae2"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":"Documentação oficial da API REST do MeuEcomm. Integre seu ERP ou e-commerce: clientes, produtos, preços, estoques, pedidos, formas de pagamento e títulos financeiros, com autenticação Bearer, exemplos em JSON e sincronização incremental.\n"},{"name":"title","value":"API MeuEcomm | Documentação de integração para ERP e e-commerce"}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"9f1ae2"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"9f1ae2"}}]}},"version":"8.12.8","publishDate":"2026-10-22T19:42:48.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"API MeuEcomm | Documentação de integração para ERP e e-commerce","description":"Documentação oficial da API REST do MeuEcomm. Integre seu ERP ou e-commerce: clientes, produtos, preços, estoques, pedidos, formas de pagamento e títulos financeiros, com autenticação Bearer, exemplos em JSON e sincronização incremental.\n"},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/c6480acc46866a52fe54badbaa1714ae2873f258df24136607af4a058bddfd63","favicon":""},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://documenter.gw.postman.com/view/metadata/2sBYHUSfLt"}