Lista de coleções que visam trazer todas as formas de interação com os dados na plataforma.
\nExplicação das seguintes informações presentes nos endpoints:
\n{{url_base}} => Url base da API, informado junto a implantação
\n{{token}} => Token de identificação do cliente, informado junto a implantação
\nEste endpoint permite o gerenciamento dos dados de produtos, assim como, caracteristicas, preços, estoques e demais informações.
\nPara que o produto seja efetivamente enviado completo para a loja, são necessários outros cadastros dos dados, sendo eles:
\nAtributos - /products_attributes - Criação dos atributos que serão utilizados nos produtos
Classes - /class - Criação de classe e vinculo dos atributos que foram criados no endpoint de atributos.
Categorias - /categories - Criação das categorias para o produto
Após o cadastro das informações acima é possível enviar o produto para a loja
\nO endpoint de preços visa possibilitar o gerenciamento dos dados referentes a listas de preços para os produtos de forma separada a requisição de produtos.
\nProdutos - endpoint /products - É necessário que já existam os produtos cadastrados na API para que seja possível realizar o envio dos preços separadamente
\nObservação: Para a utilização desse endpoint é necessário primeiro solicitar a ativação interna junto a F1.
\nEste endpoint permite o gerenciamento de uma lista de preço para todos os produtos.
Após o envio do payload o sistema irá armazenar o processo do conteúdo enviado para que seja processado de forma sincrona e será retornado o ID do processo interno, que deve ser armazenado pelo cliente para que possa ser realizado a verificação do andamento do processo.
O ID do processo pode ser enviado via payload no campo process_id, conforme exemplo de envio abaixo, o process_id deve ser unico, o sistema não irá aceitar envios com o mesmo processo.
\nClique aqui para ver dados das colunas
\n","urlObject":{"path":["price_list_bulk"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"84ae8005-3529-4eaf-871c-b5f0a3974a7e"},{"name":"consultar processos de atualizacao de lista","id":"c4370a06-9928-4a7d-b904-da16261e5f53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/async/pricelist/{{identificador_processo}}","urlObject":{"path":["async","pricelist","{{identificador_processo}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4370a06-9928-4a7d-b904-da16261e5f53"}],"id":"449b2c6a-e384-417b-9eeb-772f8c19ea80","_postman_id":"449b2c6a-e384-417b-9eeb-772f8c19ea80","description":""},{"name":"PRODUTOS ESTOQUE","item":[{"name":"cadastrar estoque para um produto existente","id":"bf2a143b-b5e0-4e41-9a26-29a16f9ef0ba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data\":[\n\t\t{\n\t\t\t\"segmentation\":\"alternative\",\n\t\t\t\"qty_reservation\":\"50\",\n\t\t\t\"qty_stock\":\"190\",\n\t\t\t\"ressuply_deadline\":\"15\"\n\t\t},\n\t\t{\n\t\t\t\"segmentation\":\"alternativ1\",\n\t\t\t\"qty_reservation\":\"66\",\n\t\t\t\"qty_stock\":\"540\",\n\t\t\t\"ressuply_deadline\":\"15\"\n\t\t}\n\t]\n}\n\n"},"url":"{{url_base}}/products/{{codigo_produto_erp}}/stock","urlObject":{"path":["products","{{codigo_produto_erp}}","stock"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"bf2a143b-b5e0-4e41-9a26-29a16f9ef0ba"},{"name":"Informações sobre o endpoint de stock_bulk(lote)","id":"6a788d8e-3797-477f-9074-a1689d803687","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"description":"O endpoint de estoque em lote permite enviar uma lista de saldos de estoque para produtos já cadastrados na plataforma. O processamento é assíncrono: a API recebe o payload,
grava a solicitação na fila de importação e retorna um identificador de processo para consulta posterior.
Produtos - endpoint /products - É necessário que já existam os produtos cadastrados na API para que seja possível realizar o envio dos estoques.
\nEste endpoint permite gerenciar os códigos alternativos dos produtos para clientes, sendo possível enviar atualizações quando a requisição possuir os mesmos dados de cliente e produto.
\nCampos
\nParâmetros para consultas
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"2609b7f1-f5d1-4e87-b757-22c8c0875098"},{"name":"cadastrar código alternativo para produto por cliente","id":"99cb56f9-38a3-4776-9b19-3e6d2bca20b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"data\": [\r\n {\r\n \"cpf_cnpj\": \"00000000000001\",\r\n \"product_code\": \"CODPROD01\",\r\n \"product_alternate_code\": \"CODPRODALT01\",\r\n \"to_delete\": 0\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/products_crm_codes","urlObject":{"path":["products_crm_codes"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"99cb56f9-38a3-4776-9b19-3e6d2bca20b3"},{"name":"consultar produtos com código alternativo por data","id":"bbce2136-dffb-4f2e-831c-1d6dc48b653f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url_base}}/products_crm_codes?filterStartDate='2025-11-14 00:00:00'&filterEndDate='2025-11-14 23:59:59'","urlObject":{"path":["products_crm_codes"],"host":["{{url_base}}"],"query":[{"key":"filterStartDate","value":"'2025-11-14 00:00:00'"},{"key":"filterEndDate","value":"'2025-11-14 23:59:59'"}],"variable":[]}},"response":[],"_postman_id":"bbce2136-dffb-4f2e-831c-1d6dc48b653f"},{"name":"exemplo consulta com filtro de cliente e produto","id":"0fcf8518-601c-438d-8861-a9be145d61ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{url_base}}/products_crm_codes?cpf_cnpj={{cpf_cnpj_cliente}}&product_code={{cod_produto}}","urlObject":{"path":["products_crm_codes"],"host":["{{url_base}}"],"query":[{"key":"cpf_cnpj","value":"{{cpf_cnpj_cliente}}"},{"key":"product_code","value":"{{cod_produto}}"}],"variable":[]}},"response":[],"_postman_id":"0fcf8518-601c-438d-8861-a9be145d61ac"}],"id":"31e63375-ce01-405b-a55e-5993a1fc4d04","_postman_id":"31e63375-ce01-405b-a55e-5993a1fc4d04","description":""},{"name":"IMPOSTOS REGIME TRIBUTÁRIO","item":[{"name":"cadastrar regime tributario","id":"af667d9a-6480-4b73-a72d-e7b52dc6cd1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{ \n \"data\":[ \n { \n\t\t\"code\":\"code002\",\n\t\t\"name\":\"regime name\",\n\t\t\"modified\":1,\n\t\t\"export_date'\":\"2019-04-21\"\n\t }\n\t]\n}\n"},"url":"{{url_base}}/tax_regime","urlObject":{"path":["tax_regime"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"af667d9a-6480-4b73-a72d-e7b52dc6cd1a"},{"name":"atualizar regime tributario","id":"6f0e0620-b362-425d-9aa5-e3e4e769eb03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\"code\":\"code002\",\n\"name\":\"regime name 2\",\n\"modified\":1,\n\"export_date'\":\"2019-04-21\"\n}\n"},"url":"{{url_base}}/tax_regime/code002","urlObject":{"path":["tax_regime","code002"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6f0e0620-b362-425d-9aa5-e3e4e769eb03"},{"name":"deletar regime tributario (Não Usar)","id":"247648ac-25b1-4888-8205-4878b6759398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{url_base}}/tax_regime/AABB","urlObject":{"path":["tax_regime","AABB"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"247648ac-25b1-4888-8205-4878b6759398"},{"name":"listar regime tributario","id":"8eef3000-9aad-4fe1-9b9d-16e67d2e4e12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_regime","urlObject":{"path":["tax_regime"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8eef3000-9aad-4fe1-9b9d-16e67d2e4e12"},{"name":"obter regime tributario","id":"61e03e0d-4263-4f85-afe8-689be3269a0c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_regime/code002","urlObject":{"path":["tax_regime","code002"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"61e03e0d-4263-4f85-afe8-689be3269a0c"}],"id":"3d5717f3-e17c-4c74-b1d0-02ec85644558","_postman_id":"3d5717f3-e17c-4c74-b1d0-02ec85644558","description":""},{"name":"IMPOSTOS MATRIZ TRIBUTÁRIA","item":[{"name":"Informações sobre o endpoint","id":"8e917663-c362-4dc3-bea8-8cf65c1de393","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"description":"Endpoint para gerenciamento dos registros de matriz tributária
\n/tax_regime -> Os códigos dos regimes tributários que serão enviados no campo 'tax_regime' precisam primeiramente terem sido cadastrados no endpoint de regimes tributários ou diretamente na loja
\nImportante: A matriz na loja sempre deve ser unica, então as colunas (ncm, tax_regime, product_origin, home_state, destination_state, item_code, client_cnpj, city_destination, nature_operation) que formam a chave da matriz na loja, não devem ser repetidas em mais do que 1 registro de matriz.
\nObservação: Os valores da coluna Valor Padrão são uma indicação dos valores que devem ser informados sempre que o campo sendo enviado não esteja preenchido com alguma informação do ERP, isso irá sinalizar que a matriz deve tratar como regra generica para aquela coluna e a linha de matriz poderá ser aplicada a todos os valores possíveis da coluna (isso se aplica somente a colunas que não sejam do tipo decimal)
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"8e917663-c362-4dc3-bea8-8cf65c1de393"},{"name":"cadastrar ou atualizar matriz tributaria","id":"9b7d73c5-e442-43b7-af78-5a9e5748efd8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"code\": \"codigo_unico_matriz\",\n \"ncm\": \"04022110\",\n \"tax_regime\": \"code_regime_01\",\n \"home_state\": \"RS\",\n \"destination_state\": \"SP\",\n \"icms_type\": \"*\",\n \"intern_icms\": 134.55,\n \"extern_icms\": 95.05,\n \"product_origin\": 1,\n \"st\": 15.8,\n \"item_code\": \"PR000-1\",\n \"client_cnpj\": \"*\",\n \"icms_internal_destination\": 18.0,\n \"icms_reduction\": 0,\n \"fcp_st\": 0,\n \"fcp_base\": 0,\n \"sell_type\": \"*\",\n \"nature_operation\": \"*\",\n \"city_destination\": \"*\",\n \"external_order_type\": 0,\n \"distribution_center_code\": \"*\",\n \"freight_aliquot\": 0,\n \"tax_guideline_value\": 0,\n \"tax_guideline_perc\": 0\n }\n ]\n}"},"url":"{{url_base}}/tax_matrix","urlObject":{"path":["tax_matrix"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b7d73c5-e442-43b7-af78-5a9e5748efd8"},{"name":"listar matriz tributaria","id":"5742b535-a66e-4c0c-a32b-31e8fcbe60a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_matrix","urlObject":{"path":["tax_matrix"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5742b535-a66e-4c0c-a32b-31e8fcbe60a3"},{"name":"obter matriz tributaria","id":"a2abbf2f-2d12-45d3-9a34-075f6bef7148","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_matrix/ncmteste19222004RSRJ","urlObject":{"path":["tax_matrix","ncmteste19222004RSRJ"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a2abbf2f-2d12-45d3-9a34-075f6bef7148"}],"id":"af7f6907-6e77-4257-8bbc-3981f0b3af38","_postman_id":"af7f6907-6e77-4257-8bbc-3981f0b3af38","description":""},{"name":"IMPOSTOS (IPI) MATRIZ TRIBUTÁRIA DE IPI","item":[{"name":"cadastrar matriz tributaria IPI","id":"1cac2049-6b12-4aeb-b4b1-68b5817968a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"item_code\": \"*\",\n \"ncm\": \"84804100\",\n \"client_cnpj\": \"*\",\n \"city_destination\": \"*\",\n \"home_state\": \"*\",\n \"destination_state\": \"*\",\n \"product_origin\": \"*\",\n \"tax_regime\": \"*\",\n \"sell_type\": \"*\",\n \"nature_operation\": \"*\",\n \"ipi\": \"0\",\n \"external_order_type\": \"001 - Revenda\",\n \"distribution_center_code\": \"*\"\n }\n ]\n}"},"url":"{{url_base}}/tax_matrix_ipi","urlObject":{"path":["tax_matrix_ipi"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1cac2049-6b12-4aeb-b4b1-68b5817968a5"},{"name":"listar matriz tributaria IPI","id":"c2c68730-a01a-43ab-b398-4e1251cc42ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_matrix_ipi","urlObject":{"path":["tax_matrix_ipi"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2c68730-a01a-43ab-b398-4e1251cc42ad"},{"name":"obter matriz tributaria IPI","id":"38daf1c1-eac1-4ffc-a3f0-a3231c38a451","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/tax_matrix_ipi/B64_ODQ4MDQxMDAvKi8qLyovKi8qLyovKi8q","urlObject":{"path":["tax_matrix_ipi","B64_ODQ4MDQxMDAvKi8qLyovKi8qLyovKi8q"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"38daf1c1-eac1-4ffc-a3f0-a3231c38a451"}],"id":"a1c275a6-d703-4c29-b076-ded79a674e62","_postman_id":"a1c275a6-d703-4c29-b076-ded79a674e62","description":""},{"name":"VENDEDORES / REPRESENTANTES","item":[{"name":"Informações sobre o endpoint","id":"8eaed42a-283a-4fd8-8059-b98bce37f69d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"url":"","description":"Este endpoint é utilizado para que sejam feito o gerenciamento dos vendedores/representantes comerciais dos clientes
\nCarteiras (/wallets) - É necessário que as carteiras já tenham sido criadas no sistema para que seja possível vincular o representante a carteira
\nO node de wallets serve para que no momento da requisição do vendedor, já possa ser feito o vinculo a carteiras que já existem, quando o node wallets é informado.
\nO node de productlines é um node opcional e serve para que no momento da requisição do vendedor, já possa ser feito o vinculo com as linhas de produtos (bandeiras) permitidas.
\nImportante: Essa funcionalidade só pode ser utilizada via ativação do modulo necessário
\n","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"8eaed42a-283a-4fd8-8059-b98bce37f69d"},{"name":"cadastar vendedores","id":"67141371-eb2d-48cb-889f-66acb6973858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": [\n {\n \"code\": \"1\",\n \"name\": \"Vendedor 1\",\n \"email\": \"email_vendedor@seller.com.br\",\n \"active\": 1\n },\n {\n \"code\": \"2\",\n \"name\": \"Vendedor 2 com carteiras\",\n \"email\": \"wallet@seller.com.br\",\n \"active\": 1,\n \"wallets\": [\n {\n \"code\": \"codigo_carteira_1\"\n },\n {\n \"code\": \"codigo_carteira_2\"\n }\n ],\n \"productlines\": [\n {\n \"code\": \"IDENTIFICADOR_BANDEIRA\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/sellers","urlObject":{"path":["sellers"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"67141371-eb2d-48cb-889f-66acb6973858"},{"name":"atualizar vendedores","id":"ee0b9128-7787-4d41-b686-d0377a9edd24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"code\": \"1\",\n \"active\": 1,\n \"name\": \"Vendedor Teste\",\n \"email\": \"seller@test.com.br\",\n \"productlines\": [\n {\n \"code\": \"IDENTIFICADOR_BANDEIRA\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/sellers/{{codigo_vendedor}}","urlObject":{"path":["sellers","{{codigo_vendedor}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee0b9128-7787-4d41-b686-d0377a9edd24"},{"name":"listar vendedores","id":"4d104fdd-d96e-4bd3-a477-20789a2e4bda","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"{{url_base}}/sellers","urlObject":{"path":["sellers"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4d104fdd-d96e-4bd3-a477-20789a2e4bda"},{"name":"obter vendedores","id":"46b890ea-212d-4a5a-a320-d9ae2403e371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/sellers/{codigo_vendedor}","urlObject":{"path":["sellers","{codigo_vendedor}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"46b890ea-212d-4a5a-a320-d9ae2403e371"},{"name":"remover vendedor (Não Usar)","id":"84791853-b18b-4d5e-9ba9-b1e6ee8d7475","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{url_base}}/sellers/{codigo_vendedor}","urlObject":{"path":["sellers","{codigo_vendedor}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"84791853-b18b-4d5e-9ba9-b1e6ee8d7475"}],"id":"9a7769d0-0169-4e4b-8e3c-3002572d88c1","_postman_id":"9a7769d0-0169-4e4b-8e3c-3002572d88c1","description":""},{"name":"CARTEIRAS","item":[{"name":"Informações sobre o endpoint","id":"ba212e21-21d2-4280-aa9d-bd4cbae0dbe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"description":"Este endpoint é utilizado para que seja feito o gerenciamento das carteiras, as carteiras são um vinculo entre clientes e vendedores/representantes comerciais.
\nN/A
\nEste endpoint permite o gerenciamento dos clientes (consumidores) que serão cadastrados na loja
\nSegmentos (/crmsegment) - É possível vincular os clientes a segmentos, mas é necessário que o segmento tenha sido criado primeiro na API para que depois ele seja vinculado ao cliente
\nO node de productlines é um node opcional e serve para que no momento da requisição do vendedor, já possa ser feito o vinculo com as linhas de produtos (bandeiras) permitidas.
Importante: Essa funcionalidade só pode ser utilizada via ativação do modulo necessário
Caso o node com o vinculo dos clientes seja informado na requisição, estes campos devem ser informados
\n","_postman_id":"0c98abcb-6219-4b89-941c-9b0eaa4ec313"},{"name":"CLIENTES CONTATOS","item":[{"name":"listar crm contatos","id":"23cb56df-dd71-4657-8e0e-8250c3d03e01","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/crmcontacts","urlObject":{"path":["crmcontacts"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"23cb56df-dd71-4657-8e0e-8250c3d03e01"},{"name":"cadastrar crm contatos","id":"2347fe44-092c-4135-bf18-625d38ab967c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \n \"active\": 1,\n \"sector\":\"Responsavel\",\n \"name\":\"Contato Teste POST\",\n \"mail\":\"mail3@mail.com\",\n \"is_telesales\": 5,\n \"purchasing_limit\": 12000.00,\n \"visualize_only_owned_orders\": 1,\n \"permission_place_orders\":1,\n \"permission_open_rma\":0,\n \"permission_get_orders\":1,\n \"permission_visualize_prices\":1,\n \"permission_allow_orders_ignoring_purchasing_limit\":0,\n \"crms\":[\n {\n \"cgc\":\"73286827000187\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/crmcontacts","urlObject":{"path":["crmcontacts"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2347fe44-092c-4135-bf18-625d38ab967c"},{"name":"obter crm contatos","id":"6cd68e02-5196-4ce6-a7cb-5381966efdba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/crmcontacts/{{email_contato}}","urlObject":{"path":["crmcontacts","{{email_contato}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6cd68e02-5196-4ce6-a7cb-5381966efdba"},{"name":"atualizar crm contatos","id":"1628f510-6f03-45c4-81cc-32b6359aa35f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \n \"sector\": \"RESPONSIBLE\",\n \"name\": \"Contato Teste PUT\",\n \"mail\": \"testemail@mail.com\",\n \"is_telesales\": 1,\n \"purchasing_limit\": 14000.00,\n \"visualize_only_owned_orders\": 2,\n \"permission_place_orders\": 2,\n \"permission_open_rma\": 2,\n \"permission_get_orders\": 2,\n \"permission_visualize_prices\": 2,\n \"permission_allow_orders_ignoring_purchasing_limit\": 2,\n \"crms\": [\n {\n \"cgc\": \"00000000000001\"\n },\n {\n \"cgc\": \"00000000000002\"\n }\n \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/crmcontacts/{{email_contato}}","urlObject":{"path":["crmcontacts","{{email_contato}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"1628f510-6f03-45c4-81cc-32b6359aa35f"},{"name":"remover crm contato (Não Usar)","id":"4bad1ae4-9881-49f1-862f-6b3820143b9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{url_base}}/crmcontacts/{{email_contato}}","urlObject":{"path":["crmcontacts","{{email_contato}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4bad1ae4-9881-49f1-862f-6b3820143b9b"}],"id":"23e2a3b5-5d56-48aa-ba14-7718658fd23f","_postman_id":"23e2a3b5-5d56-48aa-ba14-7718658fd23f","description":""},{"name":"PEDIDOS","item":[{"name":"listar pedidos","id":"98eaa725-7dcc-4bfd-8d65-b79ec84a08fa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/orders","description":"Este endpoint de atualização de pedidos permite que sejam enviadas as informações de evolução do pedido que ocorrem no ERP para a loja.
\nEste exemplo de requisição mostra como deve ser enviado uma atualização de pedido para a loja caso o cliente possua o modulo de cancelamento parcial de itens do pedido ativo.
\nO endpoint de notas fiscais permite gerenciar as notas para os pedidos realizados na plataforma.
\nPedidos - endpoint /orders - É necessário que já existam os pedidos cadastrados na API para que seja possível realizar o envio das notas fiscais
\n{{codigo_pedido}} -> Código atual do pedido na API, este campo pode ser verificado realizando uma consulta do pedido que irá receber a nota fiscal, verificando o valor atual do campo \"code\".
\n","urlObject":{"path":["orders","{{codigo_pedido}}","invoices"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"4f5e8709-39f1-4162-82ff-53b4ff1aa05f"},{"name":"listar notas","id":"8eebff70-d494-4b9c-8827-14d58b35b4d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/orders/{{codigo_pedido}}/invoices","description":"Lista todas as notas fiscais de um pedido.
\n{{codigo_pedido}} -> Código atual do pedido na API, este campo pode ser verificado realizando uma consulta do pedido que irá receber a nota fiscal, verificando o valor atual do campo \"code\".
\n","urlObject":{"path":["orders","{{codigo_pedido}}","invoices"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8eebff70-d494-4b9c-8827-14d58b35b4d4"},{"name":"obter nota","id":"8325c56c-461a-4a13-a647-c76d72a67193","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/orders/invoices/{{codigo_nota_fiscal}}","description":"Lista informações da nota fiscal informada na URL
\n{{codigo_nota_fiscal}} -> Código atual da nota fiscal na API, o valor desta variavel é o valor informado no campo \"code\" da nota fiscal enviada na API
\n","urlObject":{"path":["orders","invoices","{{codigo_nota_fiscal}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8325c56c-461a-4a13-a647-c76d72a67193"},{"name":"atualizar nota ","id":"3a0ba663-480e-4ef6-97b3-b947b389eaf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":" { \n\t\t\"type\": \"SALE\",\n\t\t\"distribution_center_code\": \"13\",\n\t\t\"number\":\"77\",\n\t\t\"serie\":\"27\",\n\t\t\"key\":\"77-8\",\n\t\t\"invoice_date\":\"2020-02-05 13:00:00\",\n\t\t\"tracking_code\":\"aa11\",\n\t\t\"tracking_url\":\"http://ulr.rastreio.com\",\n\t\t\"transport_code\":\"Q\",\n\t\t\"transport_name\":\"TRANSPORTADORA QQ\",\n\t\t\"delivery_date\":\"2020-02-05 17:00:00\",\n\t\t\"billing_type\":\"MONEY\",\n \"items\":[\n {\n \"product_code\": \"SR485/2C\",\n \"attended_quantity\": \"10\"\n }\n ]\n\t\t\n\t }","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/orders/invoices/{{codigo_nota_fiscal}}","description":"Atualiza os dados da nota fiscal informada na URL.
\n{{codigo_nota_fiscal}} -> Código atual da nota fiscal na API, o valor desta variavel é o valor informado no campo \"code\" da nota fiscal enviada na API
\n","urlObject":{"path":["orders","invoices","{{codigo_nota_fiscal}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"3a0ba663-480e-4ef6-97b3-b947b389eaf3"},{"name":"remover nota (Não Usar)","id":"c4516c38-0934-4bd8-805b-6401e02d3d82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"DELETE","header":[],"url":"{{url_base}}/orders/invoices/{{codigo_nota_fiscal}}","urlObject":{"path":["orders","invoices","{{codigo_nota_fiscal}}"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c4516c38-0934-4bd8-805b-6401e02d3d82"}],"id":"ea4fde8b-2ba5-4606-8701-2f0f9f48f51e","_postman_id":"ea4fde8b-2ba5-4606-8701-2f0f9f48f51e","description":""},{"name":"PEDIDOS CARRINHOS ABANDONADOS","item":[{"name":"listar carrinhos abandonados","id":"15a7bbfc-7413-4551-9552-b8c343b0be67","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{url_base}}/stock_reservations/abandoned_baskets","description":"Parâmetros Aceitos
\nTodos os parâmetros são opcionais:
\nLógica dos filtros de data
\nSem parâmetros: Aplica filtro padrão de 30 dias (30 dias atrás até hoje)
Com parâmetros específicos: Ignora filtro padrão e utiliza apenas parâmetros informados
O cadastro de relatórios de comissões permite que você informe e gerencie os dados das comissões a serem utilizados na plataforma.
\nNão possuí
\nRequisição para registrar um relatório de comissão, as requisições são controladas pela chave unica que fica no campo \"code\" e consiste dos valores preenchidos nos campos (seller_cnpj-seller_external_code-invoice_number-installment-order_code) encriptados em base 64. Caso sejam enviadas duas requisições com os mesmos dados que compõem o campo \"code\", o retorno dessa requisição será em branco, Colchetes ( [ ] ).
\nPara informação sobre os campos clique Aqui.
\n","urlObject":{"path":["report","commissions"],"host":["{{url_base}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fb414263-69b6-4b41-855c-c31f87abd112"}],"id":"d22f02a3-1a59-4733-bf5f-56c3582364b2","_postman_id":"d22f02a3-1a59-4733-bf5f-56c3582364b2","description":""},{"name":"CONDIÇÕES DE PAGAMENTO","item":[{"name":"Informações sobre o endpoint de condições de pagamento","id":"b7e039a3-c638-4e67-aa69-207cf68d3ba1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"INFO","header":[],"description":"Este endpoint permite que sejam gerenciadas as condições de pagamento.
\nNão possuí
\nEndpoint criado para cadastro, edição, consulta e remoção de pedidos externos (histórico financeiro).
\nParâmetros da consulta
\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"85c56e00-dcd4-4a48-ae33-32f60e2a9533"},{"name":"Consulta Produtos Geral","id":"f229d0a1-b6d3-4d25-a078-bb1eab34f2f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url_base}}/store_info/products?page=1&per_page=10","description":"