Esta documentação reúne tudo que Varejistas e Distribuidores precisam para integrar seus sistemas à nossa plataforma, mantendo estoque, preços e pedidos sincronizados em tempo real.
\nComo começar
Comece pelo Obter Token de Acesso: ele devolve o access_token, e a própria collection o guarda para você — os demais requests já saem autenticados, sem repetir o header. Ajuste também a variável url para o ambiente que você vai usar.
Cada endpoint traz o contrato completo — parâmetros, corpo, regras de negócio, resposta campo a campo e erros — com exemplos de requisição e resposta.
\nMaterial de Apoio
Para acessar guias e materiais de apoio para iniciar sua integração, clique aqui.
Canal para Dúvidas
Nossa equipe de suporte está disponível através do e-mail suporte-api@cws.digital.
Observação: ao nos contatar, você receberá uma resposta automática da nossa ferramenta de chamados (Jira), enviada pelo remetente jira@cwsdigital.atlassian.net.
Autentica um usuário da plataforma e devolve o access_token usado em todas as outras chamadas da API. É o único endpoint que não exige um token — e o único que traz o próprio header Authorization, com a credencial fixa do client de integração, já preenchida no request.
O access_token vale 12 horas (expires_in chega em 43199, em segundos). Quando ele expira, autentique novamente nesta mesma URL.
O header é Authorization: Bearer <access_token>, com o prefixo Bearer — sem ele a requisição é recusada com 401. Nesta collection isso já está pronto: este request grava o token na variável access_token e os demais herdam o header da collection, então você não precisa copiar nada.
O primeiro passo para consumir os serviços da API CWS é obter um token de acesso. Este token é necessário para autorizar todas as chamadas subsequentes.
\n","_postman_id":"d92da2f8-d59d-4ff9-b602-e897219edcca","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"02 - Estoque e Preço","item":[{"name":"Atualizar ou Criar Estoque em Lote","id":"6bb18a3d-020e-4f93-836a-e971eb58a549","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"warehouseId\": 1001,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n },\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-B-002\",\n \"warehouseId\": 1001,\n \"price\": 150.0,\n \"quantity\": 5,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch","description":"Cria ou atualiza o estoque e o preço de até 50 produtos por requisição, na sua própria loja. Cada item é processado de forma independente: o resultado de cada um vem no campo status da resposta, e um item recusado não impede os demais.
A loja é sempre a do token. Para enviar estoque de uma filial, use Atualizar ou Criar Estoque em Lote para Filial.
\nCada item precisa trazer uma das três formas, nesta ordem de precedência:
\nTodos os itens do mesmo lote precisam usar a mesma forma. Misturar formas numa requisição recusa o lote inteiro com 400 e a mensagem mixed request types in list — separe em uma requisição por forma.
Duas combinações são recusadas: leadTimeByRequest: true junto com leadTime maior que zero; e leadTimeByRequest: false com leadTime zerado ou ausente quando há virtualQuantity maior que zero.
leadTimeDate é convertida para o fuso da plataforma (-03:00) antes de ser gravada — 2026-09-10T00:00:00Z vira 09/09 às 21:00, um dia antes do que você quis. Envie sempre com o offset -03:00.
O formato precisa ser a data e hora completas: 2026-09-10 ou 10/09/2026 recusam a requisição inteira com 400, antes de qualquer item ser processado.
Com a data preenchida e a quantidade real em zero, o estoque virtual passa a ser oferecido — mesmo efeito de leadTime e de leadTimeByRequest.
Na atualização, os campos opcionais que você não reenviar são apagados: leadTimeDate, leadTimeByRequest, profitMargin, totalCost e targetMargin voltam a vazio. partnerPartCode e multipleQuantity não têm esse comportamento — só mudam quando você os envia. Reenvie o item inteiro a cada atualização.
Itens com o mesmo depósito e o mesmo identificador são deduplicados antes do processamento. Se as duplicatas trouxerem valores diferentes, o conflito não é processado — envie cada produto uma única vez por requisição.
\nCom partnerPartCodeUnique: true, os estoques do mesmo depósito que já têm aquele código gravado em partnerPartCode são zerados (preço, quantidade e estoque virtual) e o código antigo recebe o sufixo _i. Use quando você reaproveita um código de produto para outro SKU.
Lista com um objeto por item enviado, na mesma ordem do envio. Campos zerados ou vazios são omitidos — se virtualQuantity volta ausente, ele é 0.
Sempre que o envelope é válido — inclusive quando todos os itens falharam. Item recusado não impede os demais: o resultado de cada um vem no seu próprio status, e a recusa por campo faltando, valor fora de faixa ou produto não encontrado aparece como status: ERROR com o motivo em error. Percorra a lista sempre, mesmo com HTTP 200.
Recusa de item — campo faltando, valor fora de faixa, produto inexistente — não é erro de requisição: vem em 200, item a item. Veja Quando o lote responde 200.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}},"urlObject":{"path":["v1","stock","batch"],"host":["https://ws.autorei.net"],"query":[],"variable":[]}},"response":[{"id":"c262b2f1-3ca1-4afd-9302-40704c747281","name":"Sucesso — identificação por dados do fabricante","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"brand\": \"Fabricante Exemplo\",\n \"mfrPartCode\": \"FE-500101\",\n \"composition\": \"UNITARY\",\n \"warehouseId\": 1001,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4410001,\n \"productId\": 500101,\n \"warehouseId\": 1001,\n \"brand\": \"Fabricante Exemplo\",\n \"mfrPartCode\": \"FE-500101\",\n \"composition\": \"UNITARY\",\n \"price\": 58.62,\n \"quantity\": 1123,\n \"leadTime\": 2,\n \"status\": \"UPDATED\"\n }\n]"},{"id":"91652069-bfb5-4b07-907e-8b00f1d00d73","name":"Sucesso — identificação por atributo, com item recusado no lote","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"warehouseId\": 1001,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n },\n {\n \"warehouseId\": 1001,\n \"quantity\": 5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4410001,\n \"productId\": 500101,\n \"warehouseId\": 1001,\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"price\": 58.62,\n \"quantity\": 1123,\n \"leadTime\": 2,\n \"status\": \"UPDATED\"\n },\n {\n \"id\": 0,\n \"warehouseId\": 1001,\n \"price\": 0,\n \"quantity\": 5,\n \"status\": \"ERROR\",\n \"error\": \"price is required; virtualQuantity is required; leadTime is required; missing product identifier: provide productId OR (brand+mfrPartCode+composition) OR (skuAttributeName+skuAttributeValue)\"\n }\n]"}],"_postman_id":"6bb18a3d-020e-4f93-836a-e971eb58a549"},{"name":"Atualizar ou Criar Estoque em Lote para Filial","id":"940c8b5c-6573-44a5-932d-a1dab5c7f450","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"warehouseId\": 4970,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n },\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-B-002\",\n \"warehouseId\": 4970,\n \"price\": 150.0,\n \"quantity\": 5,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch/:partnerId","description":"Permite que uma conta matriz crie ou atualize o estoque e o preço de até 50 produtos por requisição em uma de suas filiais. Cada item é processado de forma independente: o resultado de cada um vem no campo status da resposta, e um item recusado não impede os demais.
O corpo e a resposta são idênticos aos do envio para a própria loja — a diferença é a filial de destino, que vem na rota e é validada contra os vínculos da sua matriz.
\nCada item precisa trazer uma das três formas, nesta ordem de precedência:
\nTodos os itens do mesmo lote precisam usar a mesma forma. Misturar formas numa requisição recusa o lote inteiro com 400 e a mensagem mixed request types in list — separe em uma requisição por forma.
Duas combinações são recusadas: leadTimeByRequest: true junto com leadTime maior que zero; e leadTimeByRequest: false com leadTime zerado ou ausente quando há virtualQuantity maior que zero.
leadTimeDate é convertida para o fuso da plataforma (-03:00) antes de ser gravada — 2026-09-10T00:00:00Z vira 09/09 às 21:00, um dia antes do que você quis. Envie sempre com o offset -03:00.
O formato precisa ser a data e hora completas: 2026-09-10 ou 10/09/2026 recusam a requisição inteira com 400, antes de qualquer item ser processado.
Com a data preenchida e a quantidade real em zero, o estoque virtual passa a ser oferecido — mesmo efeito de leadTime e de leadTimeByRequest.
Na atualização, os campos opcionais que você não reenviar são apagados: leadTimeDate, leadTimeByRequest, profitMargin, totalCost e targetMargin voltam a vazio. partnerPartCode e multipleQuantity não têm esse comportamento — só mudam quando você os envia. Reenvie o item inteiro a cada atualização.
Itens com o mesmo depósito e o mesmo identificador são deduplicados antes do processamento. Se as duplicatas trouxerem valores diferentes, o conflito não é processado — envie cada produto uma única vez por requisição.
\nCom partnerPartCodeUnique: true, os estoques do mesmo depósito que já têm aquele código gravado em partnerPartCode são zerados (preço, quantidade e estoque virtual) e o código antigo recebe o sufixo _i. Use quando você reaproveita um código de produto para outro SKU.
Lista com um objeto por item enviado, na mesma ordem do envio. Campos zerados ou vazios são omitidos — se virtualQuantity volta ausente, ele é 0.
Sempre que o envelope é válido — inclusive quando todos os itens falharam. Item recusado não impede os demais: o resultado de cada um vem no seu próprio status, e a recusa por campo faltando, valor fora de faixa ou produto não encontrado aparece como status: ERROR com o motivo em error. Percorra a lista sempre, mesmo com HTTP 200.
Recusa de item — campo faltando, valor fora de faixa, produto inexistente — não é erro de requisição: vem em 200, item a item. Veja Quando o lote responde 200.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}},"urlObject":{"path":["v1","stock","batch",":partnerId"],"host":["https://ws.autorei.net"],"query":[],"variable":[{"type":"any","value":"5057","key":"partnerId"}]}},"response":[{"id":"00d12650-ee46-4245-bdcf-17cea240f452","name":"Sucesso — identificação por dados do fabricante","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"brand\": \"Fabricante Exemplo\",\n \"mfrPartCode\": \"FE-500101\",\n \"composition\": \"UNITARY\",\n \"warehouseId\": 4970,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch/5057"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4410001,\n \"productId\": 500101,\n \"warehouseId\": 4970,\n \"brand\": \"Fabricante Exemplo\",\n \"mfrPartCode\": \"FE-500101\",\n \"composition\": \"UNITARY\",\n \"price\": 58.62,\n \"quantity\": 1123,\n \"leadTime\": 2,\n \"status\": \"UPDATED\"\n }\n]"},{"id":"23b38a21-c41f-4b7a-a267-da8ee34487f2","name":"Sucesso — identificação por atributo, com item recusado no lote","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"warehouseId\": 4970,\n \"price\": 58.62,\n \"quantity\": 1123,\n \"virtualQuantity\": 0,\n \"leadTime\": 2\n },\n {\n \"warehouseId\": 4970,\n \"quantity\": 5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/v1/stock/batch/5057"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 4410001,\n \"productId\": 500101,\n \"warehouseId\": 4970,\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"SKU-A-001\",\n \"price\": 58.62,\n \"quantity\": 1123,\n \"leadTime\": 2,\n \"status\": \"UPDATED\"\n },\n {\n \"id\": 0,\n \"warehouseId\": 4970,\n \"price\": 0,\n \"quantity\": 5,\n \"status\": \"ERROR\",\n \"error\": \"price is required; virtualQuantity is required; leadTime is required; missing product identifier: provide productId OR (brand+mfrPartCode+composition) OR (skuAttributeName+skuAttributeValue)\"\n }\n]"}],"_postman_id":"940c8b5c-6573-44a5-932d-a1dab5c7f450"}],"id":"a79dce08-79cc-49e5-bf04-7ed29f97fc5d","description":"Endpoints dedicados ao gerenciamento completo de estoque e preços dos produtos em seus depósitos.
\n","_postman_id":"a79dce08-79cc-49e5-bf04-7ed29f97fc5d","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"03 - Pedidos","item":[{"name":"Gestão loja","item":[{"name":"Listar Pedidos da Loja","id":"b0f2dc17-68ca-4017-9be9-973eddae2e4b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/partnerOrders/list?limit=5&offset=0","description":"Lista os pedidos em que a sua loja é a fornecedora — os que você recebeu para atender —, do mais recente para o mais antigo, com paginação e filtros.
\nA resposta é compacta: nove campos por pedido, o suficiente para montar uma fila de atendimento. O conteúdo completo vem em Buscar Detalhes do Pedido.
\nOs valores de status: PRE_ORDER · AWAITING_PAYMENT · PAYMENT_APPROVED · WITHOUT_CREDIT_LIMIT · READY · SHIPPED · DELIVERED · COMPLETED · CANCELED · STRAYED · RETURNED · STORE_PAYMENT.
Array de pedidos, ordenado por data de criação, do mais recente para o mais antigo. Os nove campos vêm sempre.
\nSem resultado, a resposta é um array vazio.
\nDevolve o pedido inteiro: valores, cliente, pagamentos, entregas com os produtos, e o histórico de status.
\nO id da rota é o do pedido do parceiro (partnerOrderId), o campo id da listagem — não o orderId. Confundir os dois é o erro mais comum desta família de rotas.
O payload é extenso. A tabela abaixo traz os blocos de topo; os blocos condicionais estão na seção seguinte.
\nCada item de deliveries[] traz três partes:
Cada produto de products[] traz: id (id do SKU) · partnerOrderLineId (id da linha do pedido) · name · mfrPartCode · partnerPartCode · partnerInternalPartCode · composition · quantity, realQuantity e virtualQuantity · price, stockPrice, realSalePrice, totalCost, netCost e os respectivos *Formats · leadTime e isLeadTimeByRequest · marginAfterDiscountPercentage, interestRate, anticipationRate, drivenPrice · warehouse (id, name, zipcode) · brand (id, name) · categoryId e categoryName · whoAddedItemToCart · customKey · specialRules · needsAgronomicRecipe · e os campos de unidade de venda (salesUnitOfMeasurement, salePriceByUnitOfMeasurement, unitaryQuantityInSalesUnitOfMeasurement, totalQuantityInSalesUnitOfMeasurement).
Aparecem só quando o pedido tem o dado correspondente: discounts · replicaOrdersCreated · workflowItemsAttributes · orderWorkflowReason · commodityExchange · orderDeliveryAttendantDiscount · supplierOrderId, supplierInvoiceNumber, supplierInvoiceSerie, supplierInvoiceKey e supplierInvoiceDate · orderName · partnerOrderCashBackInfo · orderCustomerThirdPartyReferral · couponCode · customAttributes · orderDocuments · fiscalNotes · os atributos external* · poTax · paymentDateVpvf.
Parte dos dados do cliente pode vir mascarada ou omitida, conforme o contrato de marketplace da loja, o vínculo de filial e a configuração de restrição de dados da loja de origem. O bloco customer existe sempre; o que varia é o preenchimento.
Move o pedido para o próximo status do fluxo de atendimento e grava, junto, os dados que aquele status exige — o número do pedido no seu ERP, a nota fiscal, o código de rastreio.
\nCada status de destino só é aceito a partir de um status atual específico, e alguns exigem campos próprios. As duas coisas estão em Para onde o pedido pode ir.
\nOs campos de nota fiscal só são gravados quando o pedido ainda não tem nota: reenviá-los num pedido que já foi marcado com nota não sobrescreve os valores.
\nO status de destino é aceito a partir de um status atual específico. Fora dessa combinação, a resposta é 422.
A aprovação de pagamento se envia como APPROVED, não como PAYMENT_APPROVED — o pedido é que passa a ficar em PAYMENT_APPROVED. Os demais valores do enum de status (PRE_ORDER, PAYMENT_APPROVED, COMPLETED, WITHOUT_CREDIT_LIMIT, STORE_PAYMENT) servem para filtrar a listagem, mas não são aceitos aqui: a requisição responde 422.
Num pedido com alçada (approvalWorkflow: true) ainda não aprovado, o único status aceito é CANCELED. Qualquer outro responde 422.
orderReasonCanceled recebe o id do motivo:
Quando o pedido nasceu em outra loja — você é o fornecedor, não a origem —, o cancelamento depende de a loja de origem ter habilitado o cancelamento pelo vendedor. É uma configuração dela, não sua: enquanto ela não liberar, o seu CANCELED responde 422, e quem cancela é a própria loja de origem. Com a permissão ligada, o cancelamento passa a valer normalmente. Pedido originado na sua própria loja não passa por essa checagem.
O pedido inteiro, no mesmo formato de Buscar Detalhes do Pedido, já com o status novo e o registro correspondente em orderStatusLogs.
Lista os produtos do pedido cujo prazo de entrega ficou sob consulta e ainda não foi preenchido. É a fila de itens que dependem de você informar o prazo antes de o pedido seguir.
\nPara informar os prazos, use Atualizar Lead Time dos Itens.
\nArray com os itens pendentes de prazo. Com todos os prazos já preenchidos, a resposta é um array vazio.
\nInforma o prazo de preparo dos itens que ficaram com o prazo sob consulta. É este envio que libera o pedido para o pagamento: respondidos os prazos, o cliente é avisado de que o pedido está disponível.
\nOs itens pendentes estão em Listar Itens com Lead Time Sob Consulta.
\nA requisição precisa trazer todos os itens do pedido que estão com o prazo pendente. Faltando um, nada é gravado e a resposta é 422. Não existe envio parcial: consulte a lista, responda a lista inteira.
\nSó aceita pedido que nasceu com prazo sob consulta e que ainda não teve os prazos respondidos. Respondido uma vez, o prazo não se edita de novo por aqui.
\nO pedido precisa estar em PRE_ORDER, AWAITING_PAYMENT ou PAYMENT_APPROVED. Em qualquer outro status a atualização é recusada.
Gravados os prazos, três coisas acontecem de uma vez: o prazo de preparo da entrega passa a somar o maior prazo informado — e, em lojas configuradas para isso, o prazo de frete também soma; o pedido é marcado como respondido; e o cliente é notificado de que o pedido está disponível para pagamento.
\nArray com as linhas do pedido, já com os prazos gravados.
\nAnexa o XML da nota fiscal ao pedido. O corpo da requisição é o próprio arquivo, enviado como conteúdo binário — o stream cru dos bytes do .xml. Não é multipart/form-data, não há campo de formulário e o XML não vai dentro de um JSON.
A nota precisa ser uma NF-e real e válida: a plataforma lê o arquivo e extrai dele os dados da nota. Veja O que é lido do arquivo.
\nOs bytes do arquivo .xml da NF-e, sem envelope. Envie Content-Type: application/xml.
A plataforma faz o parse do XML e extrai a chave de acesso, o número, a série, a data de emissão e o valor total da nota. É por isso que o arquivo precisa ser uma NF-e de verdade: um XML bem formado mas que não seja uma nota não traz esses dados. O arquivo é guardado com o nome da chave de acesso.
\nSão aceitos os dois formatos usuais — o XML processado, com o envelope da nota, e o XML só com o bloco da nota.
\nArquivo vazio ou que não é XML válido é recusado, e nada é gravado.
\nSó aceita nota em pedido que já passou da aprovação de pagamento. Antes disso a requisição é recusada e nada é gravado.
\nPor padrão o pedido guarda um arquivo, e cada envio substitui o anterior. Lojas configuradas para múltiplas notas acumulam os arquivos: cada envio acrescenta mais um. A configuração é da loja e é feita pela CWS.
\nOs dados da nota anexada ao pedido.
\nInforma, item a item, em que situação está cada produto do pedido — o que já saiu, o que está sendo preparado, o que ficou pendente. É o acompanhamento que o cliente vê durante o atendimento.
\nO escopo do envio é o item, não o pedido: cada requisição substitui o acompanhamento das peças que ela cita e deixa as demais intactas. Você pode enviar um produto de cada vez, sem reenviar o pedido inteiro.
\nReenviar um item exatamente igual ao que já está gravado não recria o registro: ele é preservado como está.
\npartnerPartCode pode repetir no mesmo envio, uma vez por situação — é assim que você informa três unidades enviadas e duas em preparação do mesmo produto. As quantidades somam; os registros não competem entre si.
Para um mesmo produto, a soma das quantidades informadas não pode ultrapassar a quantidade daquele item no pedido. Passando, a requisição é recusada e nada é gravado.
\nO partnerPartCode é resolvido contra as linhas daquele pedido. Código que não corresponde a nenhuma linha, ou que corresponde a mais de uma, recusa a requisição — e a resposta diz qual código causou a recusa.
O eco do que você enviou, com o veredito de cada item. Para o conjunto que está gravado no pedido, use Consultar Acompanhamento dos Itens.
\nA recusa por regra de negócio responde 422 com a mesma estrutura do sucesso, mais status e message no topo: os itens que causaram a recusa vêm com status: \"invalid\" e os demais com valid, e message reúne os motivos, um por linha. Nada é gravado — a recusa vale para a requisição inteira. Assim você localiza o item problemático sem cruzar a mensagem com a posição no array.
Devolve o acompanhamento dos itens que está gravado no pedido — o conjunto ativo.
\nNum pedido sem acompanhamento a resposta traz só orderId e partnerOrderId: a chave skus fica de fora.
Apaga o acompanhamento dos itens do pedido, inteiro — todas as peças, todas as situações. O pedido volta a não ter acompanhamento nenhum.
\nPara corrigir a situação de um produto sem apagar o resto, reenvie só aquele item em Enviar Acompanhamento dos Itens: o envio alcança apenas as peças que cita.
\nLista os pedidos originados na sua loja — os que os seus clientes fizeram, incluindo os que serão atendidos por outros parceiros —, do mais recente para o mais antigo, com paginação e filtros.
\nO escopo é o que diferencia esta rota da listagem da loja: aqui o critério é a loja de origem do pedido, lá é o parceiro fornecedor. A resposta e os filtros são idênticos.
\nOs valores de status: PRE_ORDER · AWAITING_PAYMENT · PAYMENT_APPROVED · WITHOUT_CREDIT_LIMIT · READY · SHIPPED · DELIVERED · COMPLETED · CANCELED · STRAYED · RETURNED · STORE_PAYMENT.
Array de pedidos, ordenado por data de criação, do mais recente para o mais antigo. Os nove campos vêm sempre.
\nSem resultado, a resposta é um array vazio.
\nDevolve o pedido inteiro de um pedido originado na sua loja: valores, cliente, pagamentos, entregas com os produtos, e o histórico de status.
\nO id da rota é o do pedido do parceiro (partnerOrderId), o campo id da listagem — não o orderId. O payload é o mesmo da rota da loja; muda o escopo de quem pode ler.
O payload é extenso. A tabela abaixo traz os blocos de topo; os blocos condicionais estão na seção seguinte.
\nCada item de deliveries[] traz três partes:
Cada produto de products[] traz: id (id do SKU) · partnerOrderLineId (id da linha do pedido) · name · mfrPartCode · partnerPartCode · partnerInternalPartCode · composition · quantity, realQuantity e virtualQuantity · price, stockPrice, realSalePrice, totalCost, netCost e os respectivos *Formats · leadTime e isLeadTimeByRequest · marginAfterDiscountPercentage, interestRate, anticipationRate, drivenPrice · warehouse (id, name, zipcode) · brand (id, name) · categoryId e categoryName · whoAddedItemToCart · customKey · specialRules · needsAgronomicRecipe · e os campos de unidade de venda (salesUnitOfMeasurement, salePriceByUnitOfMeasurement, unitaryQuantityInSalesUnitOfMeasurement, totalQuantityInSalesUnitOfMeasurement).
Aparecem só quando o pedido tem o dado correspondente: discounts · replicaOrdersCreated · workflowItemsAttributes · orderWorkflowReason · commodityExchange · orderDeliveryAttendantDiscount · supplierOrderId, supplierInvoiceNumber, supplierInvoiceSerie, supplierInvoiceKey e supplierInvoiceDate · orderName · partnerOrderCashBackInfo · orderCustomerThirdPartyReferral · couponCode · customAttributes · orderDocuments · fiscalNotes · os atributos external* · poTax · paymentDateVpvf.
Parte dos dados do cliente pode vir mascarada ou omitida, conforme o contrato de marketplace da loja, o vínculo de filial e a configuração de restrição de dados da loja de origem. O bloco customer existe sempre; o que varia é o preenchimento.
Lista os pedidos de parceiro que nasceram de um mesmo pedido do cliente. Um pedido com itens de fornecedores diferentes é dividido em um pedido de parceiro por fornecedor, e é essa divisão que esta rota devolve.
\nArray de pedidos, cada um no mesmo formato de Buscar Detalhes do Pedido - Marketplace. Um pedido atendido por um único fornecedor devolve um array de um item.
\nPermite que a loja de origem mova para o próximo status um pedido que nasceu nela, gravando junto os dados que aquele status exige.
\nO corpo, as transições e a resposta são idênticos aos da rota da loja. A diferença é o escopo e um pré-requisito de configuração — veja A loja precisa estar habilitada.
\nOs campos de nota fiscal só são gravados quando o pedido ainda não tem nota: reenviá-los num pedido que já foi marcado com nota não sobrescreve os valores.
\nO status de destino é aceito a partir de um status atual específico. Fora dessa combinação, a resposta é 422.
A aprovação de pagamento se envia como APPROVED, não como PAYMENT_APPROVED — o pedido é que passa a ficar em PAYMENT_APPROVED. Os demais valores do enum de status (PRE_ORDER, PAYMENT_APPROVED, COMPLETED, WITHOUT_CREDIT_LIMIT, STORE_PAYMENT) servem para filtrar a listagem, mas não são aceitos aqui: a requisição responde 422.
Num pedido com alçada (approvalWorkflow: true) ainda não aprovado, o único status aceito é CANCELED. Qualquer outro responde 422.
orderReasonCanceled recebe o id do motivo:
Quando o pedido nasceu em outra loja — você é o fornecedor, não a origem —, o cancelamento depende de a loja de origem ter habilitado o cancelamento pelo vendedor. É uma configuração dela, não sua: enquanto ela não liberar, o seu CANCELED responde 422, e quem cancela é a própria loja de origem. Com a permissão ligada, o cancelamento passa a valer normalmente. Pedido originado na sua própria loja não passa por essa checagem.
O pedido inteiro, no mesmo formato de Buscar Detalhes do Pedido, já com o status novo e o registro correspondente em orderStatusLogs.
A atualização de pedidos pela loja de origem depende de uma configuração da própria loja. Sem ela, a requisição responde 422 sem tocar no pedido. A liberação é feita pela CWS.
\nPermite que a loja de origem anexe o XML da nota fiscal a um pedido que nasceu nela. O corpo da requisição é o próprio arquivo, enviado como conteúdo binário — o stream cru dos bytes do .xml. Não é multipart/form-data, não há campo de formulário e o XML não vai dentro de um JSON.
A nota precisa ser uma NF-e real e válida. O corpo e as regras são idênticos aos da rota da loja; muda o escopo de quem envia.
\nOs bytes do arquivo .xml da NF-e, sem envelope. Envie Content-Type: application/xml.
A plataforma faz o parse do XML e extrai a chave de acesso, o número, a série, a data de emissão e o valor total da nota. É por isso que o arquivo precisa ser uma NF-e de verdade: um XML bem formado mas que não seja uma nota não traz esses dados. O arquivo é guardado com o nome da chave de acesso.
\nSão aceitos os dois formatos usuais — o XML processado, com o envelope da nota, e o XML só com o bloco da nota.
\nArquivo vazio ou que não é XML válido é recusado, e nada é gravado.
\nSó aceita nota em pedido que já passou da aprovação de pagamento. Antes disso a requisição é recusada e nada é gravado.
\nPor padrão o pedido guarda um arquivo, e cada envio substitui o anterior. Lojas configuradas para múltiplas notas acumulam os arquivos: cada envio acrescenta mais um. A configuração é da loja e é feita pela CWS.
\nOs dados da nota anexada ao pedido.
\nPermite que a loja de origem informe, item a item, em que situação está cada produto de um pedido que nasceu nela.
\nO corpo e a resposta são idênticos aos da rota da loja; muda o escopo de quem envia.
\nO escopo do envio é o item, não o pedido: cada requisição substitui o acompanhamento das peças que ela cita e deixa as demais intactas. Você pode enviar um produto de cada vez, sem reenviar o pedido inteiro.
\nReenviar um item exatamente igual ao que já está gravado não recria o registro: ele é preservado como está.
\npartnerPartCode pode repetir no mesmo envio, uma vez por situação — é assim que você informa três unidades enviadas e duas em preparação do mesmo produto. As quantidades somam; os registros não competem entre si.
Para um mesmo produto, a soma das quantidades informadas não pode ultrapassar a quantidade daquele item no pedido. Passando, a requisição é recusada e nada é gravado.
\nO partnerPartCode é resolvido contra as linhas daquele pedido. Código que não corresponde a nenhuma linha, ou que corresponde a mais de uma, recusa a requisição — e a resposta diz qual código causou a recusa.
O eco do que você enviou, com o veredito de cada item. Para o conjunto que está gravado no pedido, use Consultar Acompanhamento dos Itens.
\nA recusa por regra de negócio responde 422 com a mesma estrutura do sucesso, mais status e message no topo: os itens que causaram a recusa vêm com status: \"invalid\" e os demais com valid, e message reúne os motivos, um por linha. Nada é gravado — a recusa vale para a requisição inteira. Assim você localiza o item problemático sem cruzar a mensagem com a posição no array.
Devolve o acompanhamento dos itens de um pedido originado na sua loja — o conjunto ativo.
\nA resposta é idêntica à da rota da loja; muda o escopo de quem consulta.
\nNum pedido sem acompanhamento a resposta traz só orderId e partnerOrderId: a chave skus fica de fora.
Apaga, inteiro, o acompanhamento dos itens de um pedido originado na sua loja.
\nO comportamento é idêntico ao da rota da loja; muda o escopo de quem remove.
\nServiços para consulta e gerenciamento de pedidos.
\n","_postman_id":"84602d8b-275e-4e0a-b7f3-0beb482970c4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"04 - Clientes","item":[{"name":"Gestão de Clientes","item":[{"name":"Buscar Cliente por Documento","id":"77eabc1b-9355-4f62-a6db-8ceb7e74a295","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/v1/customer/document/:document","description":"Busca um cliente da sua loja pelo documento e devolve o cadastro completo, com endereços e vínculos de preço.
\nEnvie só os dígitos: 70041364856, não 700.413.648-56. Um CNPJ pontuado carrega uma barra (29.893.264/0001-01), que parte o caminho em dois segmentos — a requisição não chega a este endpoint e você recebe 404 {\"status\":\"NOT_FOUND\",\"message\":\"Serviço não encontrado\"}, que é a resposta de rota inexistente, não de cliente inexistente.
A resposta vem envelopada em customer — {\"customer\": { ... }}.
Cadastra um cliente na sua loja, com o endereço e, opcionalmente, os vínculos de tipo, grupo e tag de preço. O cliente criado já pode acessar a loja com o username e a senha informados.
Endereço (customerRegistrationAddress e cada item de addressList):
customerRegistrationAddress e addressList guardam coisas diferentesOs dois são endereço, mas vão para lugares distintos e enviar só um tem efeitos diferentes:
\nA recusa é Property [address] with value [] does not pass validation.
O endereço é resolvido pelos Correios a partir do zipcode, e o que os Correios devolvem substitui o que você enviou em street, quarter, city e state. Do seu payload sobrevivem apenas number e complement — que os Correios não têm.
Os campos que você envia funcionam como reserva: cada um é usado só quando os Correios não trazem aquele dado para o CEP. Depois do merge, street e quarter não podem ficar vazios — se ficarem, a criação é recusada.
CEP não encontrado também é recusado, a menos que a sua loja tenha a validação de CEP desabilitada.
\naddressType inválido não é recusadoUm valor fora de RESIDENTIAL/BUSINESS cai no padrão RESIDENTIAL, sem erro.
O cliente criado, na raiz (sem o envelope customer). O código é 200, não 201.
Atualiza o cadastro de um cliente da sua loja. É uma atualização parcial: envie só os campos que quer mudar.
\nTodos os campos são opcionais — campo omitido não é alterado.
\nactive aqui faz o mesmo que o endpoint de statusEnviar active nesta rota tem o mesmo efeito de PUT /customer/updateStatus/:document/:active. Os dois caminhos existem e mudam a mesma coisa.
{} responde 200 com o cadastro atual, sem alterar nada. Não é erro.
O cliente atualizado, na raiz (sem o envelope customer).
Ativa ou inativa um cliente da sua loja. Cliente inativo não acessa a loja nem finaliza compra.
\n202 Accepted.
\nLista os endereços de um cliente da sua loja.
\nArray com um objeto por endereço. Vem [] quando o cliente não tem endereço.
Acrescenta um endereço ao cadastro de um cliente da sua loja.
\nO endereço é resolvido pelos Correios a partir do zipcode, e o que os Correios devolvem substitui o que você enviou em street, quarter, city e state. Do seu payload sobrevivem apenas number e complement.
Os campos que você envia funcionam como reserva: cada um é usado só quando os Correios não trazem aquele dado para o CEP. Depois do merge, street e quarter não podem ficar vazios — se ficarem, o endereço é recusado.
CEP não encontrado também é recusado, a menos que a sua loja tenha a validação de CEP desabilitada.
\naddressType só aceita dois valoresRESIDENTIAL ou BUSINESS, em qualquer caixa. Qualquer outro valor é recusado com Property addressType is type-mismatched.
O endereço criado. O código é 200, não 201.
\nRemove um endereço do cadastro de um cliente da sua loja.
\nRemove todos os endereços de um cliente da sua loja de uma vez.
\nNão há endpoint para restaurar endereços removidos. O cliente fica sem endereço até que um novo seja cadastrado.
\nConsulta grupos de cliente da sua loja por nome ou por id externo.
\nname e externalId têm de ser arrays, mesmo para um único valor: {\"name\": [\"Atacado\"]}. Valor escalar é recusado.
Objeto com a chave groups — array com um objeto por grupo encontrado. Sem correspondência, vem {\"groups\": []}.
Os três campos de details devolvem a mesma chave que você enviou na criação do grupo.
Cria um grupo de clientes da sua loja. O grupo define a que tipo de documento se aplica e quais formas de entrega e de pagamento ficam restritas para quem estiver nele.
\nChaves aceitas em cada um dos três objetos:
\ntrue em cada objetoNos três objetos, uma e só uma chave pode vir true. Nenhuma e mais de uma são recusadas, com mensagens diferentes — Pelo menos uma das opções ... deve ser definida como true. e Somente uma das opções ... deve ser definida como true.
groupTypeId e groupTypeName não criam um tipo de grupo: eles referenciam um que já esteja cadastrado na sua loja. Valor sem correspondência é recusado com Tipo Grupo de id X e name Y não cadastrado!. Enviando os dois, os dois têm de apontar para o mesmo tipo.
A recusa vem no mesmo envelope da operação, com status: \"ERROR\", e o message traz o código HTTP como prefixo:
{\"status\":\"ERROR\",\"message\":\"400 BAD_REQUEST: O campo 'name' é de preenchimento obrigatório.\",\n \"action\":\"CREATE\",\"dateHour\":\"2026-09-04T12:14:15Z\",\n \"responsable\":{\"user\":\"integracao@lojaexemplo.com.br\",\"origin\":\"API\"}}\nQuando há mais de um motivo, eles vêm no mesmo message, separados por , .
Exclui um grupo de clientes da sua loja. Os clientes que estavam no grupo continuam cadastrados — o que sai é o grupo e os vínculos com ele.
\nO mesmo envelope da criação, com action: \"DELETE\" e a mensagem Grupo deletado com sucesso.
Vincula um tipo de preço ao cliente. É o que faz o cliente passar a receber a tabela de preços daquele tipo.
\nEnvie só os dígitos: 70041364856, não 700.413.648-56. Um CNPJ pontuado carrega uma barra, que parte o caminho em dois segmentos — a requisição não chega a este endpoint.
Se o cliente já estava vinculado àquele tipo de preço, a resposta é 200 com a mensagem de que o vínculo já existe. O estado final é o mesmo.
\nDesfaz o vínculo entre um cliente e um tipo de preço. O cliente deixa de receber a tabela de preços daquele tipo.
\nEnvie só os dígitos: 70041364856, não 700.413.648-56. Um CNPJ pontuado carrega uma barra, que parte o caminho em dois segmentos — a requisição não chega a este endpoint.
Serviços para gerenciamento completo dos dados cadastrais de clientes, seus endereços e grupos.
\n","_postman_id":"a89cb23e-20dd-41ef-a3e0-1fc5184f71e2","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"05 - Limite de Crédito","item":[{"name":"Criar Tipo de Limite de Crédito","id":"1a3e95c0-a371-4dbb-8bbe-3bf3b7e20cbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Crédito Padrão\",\n \"code\": \"CREDITO-PADRAO\"\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/creditLimit/saveTypeCreditLimit","description":"Cria um tipo de limite de crédito, que depois é associado a um ou mais clientes em Definir ou Atualizar Limite de Crédito para Cliente. O tipo representa a modalidade de crédito da sua loja — por exemplo, À Vista, Boleto 30 dias ou Crédito Especial.
A resposta 200 devolve o corpo do serviço de crédito como ele veio, inclusive quando o serviço recusou a criação — por exemplo com um code que já existe na sua loja. Confira o corpo: em caso de sucesso ele traz code, name e date_created.
Cria ou atualiza o limite de crédito de um cliente já cadastrado na plataforma, para um dos tipos criados em Criar Tipo de Limite de Crédito. Reenviar para o mesmo cliente e tipo atualiza o limite existente.
\nOs seis campos são obrigatórios. 0 e false são valores válidos — só null e string vazia contam como ausentes.
Lista os limites de crédito da sua loja, com opção de filtrar por cliente.
\nQuando há limites, a resposta é um array. Quando não há nenhum, ela é um objeto vazio ({}). Trate os dois formatos: iterar direto sobre a resposta quebra no caso vazio.
Array com um objeto por limite de crédito.
\nEndpoints para criar e gerenciar tipos de limite de crédito e atribuí-los aos clientes.
\n","_postman_id":"491b2479-a2f3-40c1-8b32-7e4bd7bab6a1","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"06 - Contratos","item":[{"name":"Gestão loja","item":[{"name":"Criar Contrato","id":"c853d744-9f45-4527-a8c6-e748029ab0d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Tabela Atacado 2026\",\n \"startDate\": \"2026-09-01\",\n \"endDate\": \"2026-12-31\",\n \"allCustomers\": false,\n \"allPartners\": false,\n \"active\": true,\n \"priority\": 10,\n \"contractType\": \"BASIC\",\n \"isDiscountBlockedByAttendant\": false,\n \"stateList\": [\n \"SP\",\n \"MG\"\n ],\n \"customerGroupList\": [\n {\n \"externalId\": \"GRUPO-ATACADO\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/priceContract","description":"Cria um contrato de preço: a tabela de preços especiais que a loja aplica a um conjunto de clientes durante um período. A criação grava o cabeçalho do contrato — vigência, abrangência e filtros de aplicação. Os clientes e os produtos entram depois, por Adicionar Clientes ao Contrato e Adicionar Produtos ao Contrato.
\nA loja é sempre a do token. Para criar o contrato de uma filial, use Criar Contrato da Filial.
\nstartDate e endDate aceitam quatro formatos: 2026-09-01, 2026-09-01 08:30, 2026-09-01T08:30:00 e 2026-09-01T08:30:00Z. Enviada só a data, a vigência começa e termina à meia-noite.
allCustomers: true aplica o contrato a todos os clientes da loja, e o contrato passa a recusar a inclusão de cliente avulso com 400. Com allCustomers: false, o contrato vale só para os clientes que você adicionar depois, um a um.
Quando mais de um contrato ativo alcança o mesmo produto para o mesmo cliente, vence o de maior priority. Empatada a prioridade, vence o contrato restrito a clientes específicos sobre o que vale para todos os clientes. Persistindo o empate, vence o contrato mais antigo.
contractType: COUNTDOWN marca o contrato como oferta regressiva: o preço devolvido passa a carregar o desconto e a data final da oferta. O contrato regressivo só entra no cálculo de preço com priceBeforeAfter: true.
Atualiza parte do cabeçalho de um contrato: status, vigência, abrangência e filtros de aplicação. É uma atualização parcial — envie só os campos que quer mudar, e ao menos um deles.
\nServe também para esvaziar o contrato de uma vez, com deleteAllItems e deleteAllCustomers.
Todos os campos são opcionais, mas o corpo precisa trazer ao menos um deles preenchido.
\nO nome, o tipo e os produtos e clientes do contrato não fazem parte deste corpo: a vigência se atualiza por dateStart e dateEnd, e clientes e produtos pelos endpoints próprios de cada um.
Com replaceFilters: false (o default), as UFs, filiais e grupos enviados são acrescentados aos que o contrato já tem. Com replaceFilters: true, os filtros do contrato passam a ser exatamente os que você enviou.
Lista os contratos de preço da sua loja, do mais recente para o mais antigo, com paginação.
\nA listagem devolve o cabeçalho de cada contrato. Os clientes e os produtos de um contrato não vêm aqui.
\nArray de contratos, cada um no mesmo formato da resposta da criação.
\nAdiciona clientes a um contrato, pelo documento de cada um. Os clientes passam a receber os preços do contrato.
\nEnvie de 1 a 100 documentos por requisição. Os que não forem localizados voltam em notFound, sem impedir os demais.
Um contrato criado com allCustomers: true já vale para todos os clientes da loja e recusa a inclusão com 400 e priceContract.customers.addNotAllowed. Para montar uma lista de clientes, o contrato precisa estar com allCustomers: false.
notFoundO cliente precisa existir na plataforma, mas não precisa ter comprado da sua loja. O documento que não resolve não interrompe a requisição: ele volta em notFound.customers e os demais são gravados. A resposta é 200 mesmo quando nenhum documento resolveu.
Remove clientes de um contrato, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.
\nEnvie de 1 a 100 documentos por requisição. Os que não estiverem no contrato voltam em notFound, sem impedir os demais.
notFoundO documento que não está vinculado ao contrato não interrompe a requisição: ele volta em notFound.customers e os demais são removidos. A resposta é 200 mesmo quando nenhum documento foi removido.
Para esvaziar a lista inteira de uma vez, use deleteAllCustomers em Atualizar Contrato.
Adiciona produtos ao contrato com o preço de cada um, ou atualiza o preço dos que já estão nele. Cada produto é processado de forma independente: o resultado de cada um vem no campo status da resposta.
Envie de 1 a 100 produtos por requisição.
\nitems[].value é o nome legado de items[].price e continua aceito, com o mesmo efeito. Enviando os dois no mesmo item, vale price.
Cada produto precisa trazer uma das duas formas, nesta ordem de precedência:
\nAo contrário do envio de estoque, formas diferentes podem conviver no mesmo envio: cada produto é resolvido pela forma que trouxer.
\nO produto é resolvido dentro do catálogo da loja dona do contrato. O que não resolve volta em notFound.items e os demais são gravados.
Dois produtos do mesmo envio que resolvem para o mesmo SKU — pelo código repetido ou pelo atributo — vão os dois para notFound.items e nenhum é gravado. Envie cada produto uma única vez por requisição.
Preço negativo, custo negativo, margem fora de 0 a 100 e produto sem nenhuma forma de identificação são recusados item a item: o produto volta em items com status: ERROR e o motivo em error, e os demais são gravados. A resposta é 200.
Remove produtos do contrato. Os produtos voltam a ser vendidos pelo preço de tabela da loja.
\nEnvie de 1 a 100 produtos por requisição, identificados da mesma forma que na adição. O preço não é enviado na remoção.
\nCada produto precisa trazer uma das duas formas, nesta ordem de precedência:
\nnotFoundO produto que não está no contrato não interrompe a requisição: ele volta em notFound.items e os demais são removidos. A resposta é 200 mesmo quando nenhum produto foi removido.
Para esvaziar a lista inteira de uma vez, use deleteAllItems em Atualizar Contrato.
Permite que uma conta matriz crie um contrato de preço em uma de suas filiais. A criação grava o cabeçalho do contrato — vigência, abrangência e filtros de aplicação. Os clientes e os produtos entram depois, por Adicionar Clientes ao Contrato da Filial e Adicionar Produtos ao Contrato da Filial.
\nO corpo e a resposta são idênticos aos da criação na própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nstartDate e endDate aceitam quatro formatos: 2026-09-01, 2026-09-01 08:30, 2026-09-01T08:30:00 e 2026-09-01T08:30:00Z. Enviada só a data, a vigência começa e termina à meia-noite.
allCustomers: true aplica o contrato a todos os clientes da loja, e o contrato passa a recusar a inclusão de cliente avulso com 400. Com allCustomers: false, o contrato vale só para os clientes que você adicionar depois, um a um.
Quando mais de um contrato ativo alcança o mesmo produto para o mesmo cliente, vence o de maior priority. Empatada a prioridade, vence o contrato restrito a clientes específicos sobre o que vale para todos os clientes. Persistindo o empate, vence o contrato mais antigo.
contractType: COUNTDOWN marca o contrato como oferta regressiva: o preço devolvido passa a carregar o desconto e a data final da oferta. O contrato regressivo só entra no cálculo de preço com priceBeforeAfter: true.
Permite que uma conta matriz atualize parte do cabeçalho de um contrato de uma de suas filiais: status, vigência, abrangência e filtros de aplicação. É uma atualização parcial — envie só os campos que quer mudar, e ao menos um deles.
\nO corpo e a resposta são idênticos aos da atualização na própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nTodos os campos são opcionais, mas o corpo precisa trazer ao menos um deles preenchido.
\nO nome, o tipo e os produtos e clientes do contrato não fazem parte deste corpo: a vigência se atualiza por dateStart e dateEnd, e clientes e produtos pelos endpoints próprios de cada um.
Com replaceFilters: false (o default), as UFs, filiais e grupos enviados são acrescentados aos que o contrato já tem. Com replaceFilters: true, os filtros do contrato passam a ser exatamente os que você enviou.
Permite que uma conta matriz liste os contratos de preço de uma de suas filiais, do mais recente para o mais antigo, com paginação.
\nA resposta é idêntica à da listagem da própria loja — a diferença é a filial consultada, que vem na rota e é validada contra os vínculos da sua matriz.
\nArray de contratos, cada um no mesmo formato da resposta da criação.
\nPermite que uma conta matriz adicione clientes a um contrato de uma de suas filiais, pelo documento de cada um. Os clientes passam a receber os preços do contrato.
\nO corpo e a resposta são idênticos aos da adição na própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nUm contrato criado com allCustomers: true já vale para todos os clientes da filial e recusa a inclusão com 400 e priceContract.customers.addNotAllowed. Para montar uma lista de clientes, o contrato precisa estar com allCustomers: false.
notFoundO cliente precisa existir na plataforma, mas não precisa ter comprado da sua loja. O documento que não resolve não interrompe a requisição: ele volta em notFound.customers e os demais são gravados. A resposta é 200 mesmo quando nenhum documento resolveu.
Permite que uma conta matriz remova clientes de um contrato de uma de suas filiais, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.
\nO corpo e a resposta são idênticos aos da remoção na própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nnotFoundO documento que não está vinculado ao contrato não interrompe a requisição: ele volta em notFound.customers e os demais são removidos. A resposta é 200 mesmo quando nenhum documento foi removido.
Para esvaziar a lista inteira de uma vez, use deleteAllCustomers em Atualizar Contrato.
Permite que uma conta matriz adicione produtos ao contrato de uma de suas filiais com o preço de cada um, ou atualize o preço dos que já estão nele. Cada produto é processado de forma independente: o resultado de cada um vem no campo status da resposta.
O corpo e a resposta são idênticos aos do envio para a própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nitems[].value é o nome legado de items[].price e continua aceito, com o mesmo efeito. Enviando os dois no mesmo item, vale price.
Cada produto precisa trazer uma das duas formas, nesta ordem de precedência:
\nAo contrário do envio de estoque, formas diferentes podem conviver no mesmo envio: cada produto é resolvido pela forma que trouxer.
\nO produto é resolvido dentro do catálogo da loja dona do contrato. O que não resolve volta em notFound.items e os demais são gravados.
Dois produtos do mesmo envio que resolvem para o mesmo SKU — pelo código repetido ou pelo atributo — vão os dois para notFound.items e nenhum é gravado. Envie cada produto uma única vez por requisição.
Preço negativo, custo negativo, margem fora de 0 a 100 e produto sem nenhuma forma de identificação são recusados item a item: o produto volta em items com status: ERROR e o motivo em error, e os demais são gravados. A resposta é 200.
Permite que uma conta matriz remova produtos do contrato de uma de suas filiais. Os produtos voltam a ser vendidos pelo preço de tabela da filial.
\nO corpo e a resposta são idênticos aos da remoção na própria loja — a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.
\nCada produto precisa trazer uma das duas formas, nesta ordem de precedência:
\nnotFoundO produto que não está no contrato não interrompe a requisição: ele volta em notFound.items e os demais são removidos. A resposta é 200 mesmo quando nenhum produto foi removido.
Para esvaziar a lista inteira de uma vez, use deleteAllItems em Atualizar Contrato.
Endpoints para gerenciar contratos de preço fixo para clientes ou grupos de clientes.
\n","_postman_id":"30d73683-013b-4ee6-8f5c-483bf41d52ae","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"07 - Regra de Preço","item":[{"name":"Listar Regras de Preço","id":"59c55a2f-d25f-4571-840c-b4212a6dcfd1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/v1/priceRule?name=Desconto Atacado&limit=5","description":"Lista as regras de preço ativas da sua loja. Regra desativada não aparece aqui.
\nname compara o nome inteiro, não um trecho: ?name=Desconto não encontra a regra Desconto Atacado. Envie o nome completo, com os mesmos espaços e acentos do cadastro.
Array com uma regra por item, e [] quando nada casa com o filtro.
Cria uma regra de preço da sua loja. A regra passa a ser avaliada em toda cotação de preço: quando o produto e o cliente atendem a todos os critérios configurados, o valor é aplicado.
\nNúmeros e booleanos também são aceitos como string (\"priority\": \"10\", \"cumulative\": \"true\").
Cada campo opcional que você preenche estreita a regra: ela só é aplicada quando o produto e o cliente atendem a todos eles. Deixe de fora o que não é condição.
\nSe o valor da regra levaria o preço a zero ou a um número negativo, ela é ignorada na cotação — o preço não fica negativo e nenhum erro é gerado.
\nPrimeiro as regras não promocionais, depois as não cumulativas, depois a priority (menor primeiro) e, em empate, a mais antiga.
A regra criada. O código é 201 Created, não 200. promotionalBeforeAfter é gravado, mas não volta na resposta.
Desativa uma regra de preço. É uma exclusão lógica: a regra deixa de ser aplicada nas cotações e sai da listagem, mas o histórico é preservado — não há como reativá-la por esta API.
\n202 Accepted, com corpo vazio. Não espere um JSON de confirmação: o 202 é a confirmação.
\nServiços para criação e gerenciamento de regras de preço.
\n","_postman_id":"701d004f-08b4-4b7d-a8a3-53771060e496","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"08 - Orçamentos","item":[{"name":"Listar Orçamentos Pendentes","id":"b3382dc2-ec29-4532-a0d6-7f2edf1cb33c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/partnerBudgets/pending?limit=5&offset=0","description":"Lista as solicitações de orçamento em aberto para a sua loja — pedidos de cotação que clientes fizeram para produtos que você vende e que ainda não foram respondidos. Cada item traz o produto, a quantidade pedida e a praça do cliente, que é o que você precisa para precificar.
\nQuando não há nada a responder, a resposta é 422 com a mensagem Não existem orçamentos pendentes. É também o que você recebe quando o offset passa do último orçamento.
Array com um objeto por orçamento pendente.
\nRetorna um orçamento pela sua identificação, com o estado atual: se ainda está pendente, se você já respondeu e quanto informou, e se ele virou pedido.
\nO orçamento. Os campos marcados aparecem só na condição indicada.
\nO preço, o prazo e o código do produto aparecem em dois lugares no orçamento respondido: dentro de stock e também na raiz do objeto. São o mesmo valor — leia de onde preferir, e não trate a raiz como um segundo dado.
Retorna os orçamentos que originaram um pedido. Use quando receber um pedido e precisar rastrear de qual cotação ele veio — o preço e o prazo que você informou no orçamento estão aqui.
\nUm pedido pode ter nascido de mais de um orçamento — um por item cotado. Espere um array mesmo quando houver só um.
\nArray com um objeto por orçamento. Todos vêm com os campos de orçamento respondido preenchidos, já que geraram pedido.
\nO preço, o prazo e o código do produto aparecem em dois lugares no orçamento respondido: dentro de stock e também na raiz do objeto. São o mesmo valor — leia de onde preferir, e não trate a raiz como um segundo dado.
Responde um orçamento pendente: você informa o preço, o prazo de entrega e o seu código do produto, e a CWS cria o estoque correspondente e apresenta a sua oferta ao cliente.
\nA resposta não é só uma cotação: a CWS grava um estoque com o preço, o prazo e o código que você informou, na quantidade que o cliente pediu, e vincula esse estoque ao orçamento. É por isso que partnerPartCode é obrigatório — é o código pelo qual você vai reconhecer o item quando o pedido chegar.
O estoque criado é associado ao primeiro depósito da sua loja, não a um depósito de sua escolha — esta rota não recebe warehouseId.
Orçamento que já tem resposta é recusado com Orcamento já respondido.
A solicitação do cliente aceita respostas de vários parceiros. Na primeira resposta o cliente é avisado de que encontrou o produto; a partir da quinta, a solicitação é encerrada e os orçamentos ainda não respondidos são descartados.
\nO orçamento, agora com os campos de orçamento respondido preenchidos. A resposta traz também o cabeçalho Location com a URL do orçamento.
O preço, o prazo e o código do produto aparecem em dois lugares no orçamento respondido: dentro de stock e também na raiz do objeto. São o mesmo valor — leia de onde preferir, e não trate a raiz como um segundo dado.
Recusa um orçamento pendente: informa à CWS que você não vai cotar aquele produto. O orçamento sai da sua lista de pendentes e o cliente não recebe oferta sua.
\nNão há endpoint para reverter: orçamento recusado não volta para a lista de pendentes e não pode mais ser respondido. Se houver chance de cotar, deixe pendente em vez de recusar.
\n204 No Content, sem corpo. Não espere um JSON de confirmação: o 204 é a confirmação.
\nServiços para consulta e resposta de orçamentos solicitados por clientes.
\n","_postman_id":"fcf6939b-a682-4a4a-9317-6521ef298197","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"09 - Carrinho Personalizado","item":[{"name":"Criar Carrinho Personalizado","id":"c9c49887-d411-4c40-ae9f-6c114a6a3fdf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cartName\": \"Proposta Ana Paula — setembro\",\n \"document\": \"700.413.648-56\",\n \"sellerEmail\": \"integracao@lojaexemplo.com.br\",\n \"products\": [\n {\n \"stockId\": 4410001,\n \"quantity\": 2\n },\n {\n \"stockId\": 4410002,\n \"quantity\": 1\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://ws.autorei.net/customCart/create","description":"Cria um carrinho com produtos pré-selecionados para um cliente e devolve o link de acesso ao carrinho, para você enviar ao cliente. O cliente abre o link e finaliza a compra com os itens já montados.
\nDentro de cada item de products:
messageA resposta não tem um campo próprio para a URL: o link chega em message. O trecho final do link é a chave do carrinho — é ela que aparece nas consultas como access_hash.
Aplica novos itens a um carrinho já criado, sem gerar outro link: o cartId e a URL continuam os mesmos.
Dentro de cada item de products:
updateTypecomplement procura o item pelo stockId e soma a quantidade enviada à que já estava lá; os metadados novos são juntados aos antigos. replacement apaga os itens que estavam no carrinho e grava só os que você enviou; os metadados também são substituídos.
Os valores são comparados exatamente, em minúsculas. Qualquer outro texto não entra em nenhum dos dois caminhos: o item enviado vira uma linha nova no carrinho e os antigos continuam lá.
\nMesma estrutura da criação — status, message com a URL e cartId. O cartId e a URL são os do carrinho que você alterou, não de um novo.
Exclui um carrinho personalizado. O link deixa de funcionar para o cliente.
\n{\"status\":\"OK\"}
Endpoints para criar, editar e deletar carrinhos de compra personalizados para clientes.
\n","_postman_id":"c575e5c4-ed54-40b8-ac9a-c94ceefb7051","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"10 - Módulo Vendedor","item":[{"name":"Listar Vendedores","id":"ca7b2e74-a8b2-4f90-bfe8-3c8888eea98d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/sellerModule/listSellers?limit=20&offset=0","description":"Lista os vendedores da sua loja, com as permissões de cada um. É por aqui que você descobre o id do vendedor, que as demais rotas do módulo pedem.
Array com um objeto por vendedor. Vem [] quando não há vendedor, ou quando o offset passa do último.
Cadastra um vendedor da sua loja a partir de uma conta que já existe: você identifica a conta e define as permissões que ela passa a ter no atendimento.
\nO vendedor não é criado do zero: a rota procura uma conta ativa da sua loja pelo username ou pelo document e a promove a vendedor. Conta inexistente, desativada ou de outra loja é recusada.
enableDiscountBranch e enableDiscountSeller só são considerados quando enableDiscountItemValue ou enableAddItemValue é true. Sem isso, os dois são gravados como false, mesmo que você os envie como true.
Envie profileCode ou profileName, nunca os dois. Não enviar nenhum significa ficar sem perfil — e lojas configuradas para exigir perfil no cadastro recusam esse caso.
accessStartTime e accessEndTime são um par. Enviar só um é recusado; enviar os dois exige o formato HH:mm e valores diferentes entre si. Não enviar nenhum deixa o vendedor sem restrição de horário.
Cada partnerId informado precisa ter parceria autorizada com a sua loja; o mesmo vale para o parceiro resolvido a partir de um externalId. Na criação, exatamente um dos parceiros tem de vir com defaultPartner: true.
O vendedor criado, com as permissões efetivas. O campo de identificação volta como você enviou: username quando você usou o e-mail, document quando usou o documento.
Remove um vendedor da sua loja. A conta continua existindo — o que sai é o vínculo de vendedor e as permissões de atendimento.
\nLista a carteira de clientes de um vendedor — os clientes que estão vinculados a ele.
\nArray com um objeto por vínculo. Vem [] quando o vendedor não tem cliente na carteira, e também quando o id informado não corresponde a nenhum vendedor.
Vincula um cliente à carteira de um vendedor. A partir do vínculo, o cliente passa a ser atendido por esse vendedor.
\nO vínculo só é criado para cliente já cadastrado na loja autenticada. Cliente de outra loja, ou documento sem cadastro, é recusado.
\nO vínculo criado. Os campos de identificação refletem o que você enviou: só username, só document, ou os dois.
Desfaz o vínculo entre um cliente e um vendedor. O cliente sai da carteira daquele vendedor; o cadastro do cliente não é afetado.
\nMonta a carteira de um vendedor em lote: vincula, desvincula ou substitui a lista de clientes numa única chamada, em vez de uma requisição por cliente.
\nNão envie attendantId nem storeId: os dois são resolvidos pelo backend, a partir do path e do seu token.
A resposta 200 confirma que a CWS recebeu a lista, não que os vínculos foram criados. O processamento acontece em segundo plano e não há rota para consultar o resultado — confira a carteira depois com GET /sellerModule/listCustomers/:id.
REPLACE apaga o que não está na listaCom REPLACE, a carteira passa a ser exatamente a lista enviada: quem estava vinculado e não aparece em users é desvinculado.
Endpoints para gerenciar vendedores e suas carteiras de clientes.
\n","_postman_id":"a3dc0f97-493b-4888-bc5e-e506776a829e","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"11 - Prioridade de SKU","item":[{"name":"Buscar Prioridade por ID","id":"a32e2a37-306e-4ccd-b3a2-052bb66cd12a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/searchSkuPriority/:id","description":"Consulta uma prioridade de busca pelo id do registro, dentro da sua loja.
\nConsulta a prioridade de busca de um produto identificado pela composição do produto.
\nQuando os três não vêm completos, ou quando o produto não é encontrado, a resposta é 404 com Sku não encontrado.
Define o nível de prioridade de um produto nas buscas da sua loja. Cada produto tem uma prioridade por loja: para mudar o nível de um produto que já tem prioridade, use Atualizar Prioridade de Produto.
\nQuando os três não vêm completos, ou quando o produto não é encontrado, a resposta é 404 com Sku não encontrado.
O registro criado. O código é 201 Created, não 200.
\nAltera o nível de prioridade de um produto que já tem prioridade na sua loja. O produto é identificado no corpo, como na criação — não pelo id do registro.
\nQuando os três não vêm completos, ou quando o produto não é encontrado, a resposta é 404 com Sku não encontrado.
O registro atualizado, com lastUpdated novo e o mesmo id.
Remove a prioridade de um produto. Ele volta ao comportamento padrão de busca da loja, e o produto continua disponível — só a prioridade sai.
\n204 No Content, sem corpo.
\nEndpoints para gerenciar a prioridade de exibição de produtos (SKUs) nos resultados de busca.
\n","_postman_id":"bd936335-8920-49bb-873f-bbd0a19738df","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"12 - CashBack","item":[{"name":"Consultar Saldo Total de Cashback do Marketplace","id":"f29eac84-2060-4c81-a900-274dc7dd5df9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://ws.autorei.net/loyaltyProgram/total","description":"Retorna o saldo de cashback da sua loja, somado por tipo e por status. É a visão consolidada: um número por status, sem detalhe por cliente ou por pedido.
\nDois objetos, credit e debit. Em cada um, a chave é o status e o valor é o total naquele status — não há campos fixos: só aparece o status que tem saldo. Uma loja sem nenhum débito devolve \"debit\": {}.
Status possíveis nas chaves:
\nOs valores são string, não número — duas casas decimais e ponto como separador (\"220971.17\"). Converta antes de somar.
Lista o saldo de cashback da sua loja cliente por cliente, com os totais por status de cada um. Use quando precisar do saldo individual; para o consolidado da loja, use GET /loyaltyProgram/total.
limit e offset são aplicados aos lançamentos de cashback, e a resposta agrupa esses lançamentos por cliente. Como um cliente costuma ter mais de um lançamento, a página devolve menos clientes do que o limit — limit=20 pode voltar 17 clientes. Não use a quantidade de itens da resposta para decidir se chegou ao fim. Não existe página vazia: quando o offset passa do último lançamento, a resposta é 400 com no record found — é esse 400 que encerra a paginação.
Array com um objeto por cliente.
\nOs status possíveis nas chaves de credit e debit são os mesmos de GET /loyaltyProgram/total: TO_RELEASE, RELEASED, CANCELLED, INVALID_EXPIRED, IN_USE, USED, EXPIRED. Os valores são string com duas casas decimais e ponto como separador (\"11.80\").
Lista o extrato de cashback de um cliente da sua loja: um item por lançamento, ganho ou gasto, do mais recente para o mais antigo.
\nValores aceitos em status: TO_RELEASE, RELEASED, CANCELLED, INVALID_EXPIRED (lançamentos de crédito) e IN_USE, USED, EXPIRED (lançamentos de débito).
Um valor fora da lista não gera erro de validação: ele simplesmente não casa com nenhum lançamento. O resultado é a resposta de \"sem registros\" (400), igual a um filtro que não encontrou nada.
Não há como distinguir, pela resposta, \"este cliente nunca teve cashback\" de \"este cliente não tem lançamento no status filtrado\" — as duas situações devolvem 400 com no record found.
Array com um objeto por lançamento.
\nConcede cashback a um cliente a partir de um pedido que aconteceu fora da plataforma CWS — uma venda no seu balcão, no seu e-commerce próprio ou em outro canal. Você informa quem comprou, o número do pedido no seu sistema e os itens; o programa de fidelidade calcula quanto cada item rende e registra o crédito.
\nEnvie um dos dois. O cliente precisa já existir na loja autenticada: cliente de outra loja, ou documento sem cadastro, é recusado. Se você mandar os dois, o cpfCnpj é quem vale.
externalOrderId é a chave contra crédito em dobroO número do pedido externo é único por parceiro. Uma segunda chamada com o mesmo externalOrderId é recusada, não duplicada — é o que protege a integração de conceder cashback duas vezes quando uma entrega é reprocessada. Use o número real do pedido no seu sistema, não um valor gerado a cada tentativa.
documentPartner e a venda de marketplaceO documento informado em cada item define quem vendeu aquele item. Quando é o documento do próprio parceiro autenticado, nada mais é exigido. Quando é o documento de outro parceiro, precisa existir uma parceria de marketplace autorizada entre a sua loja e ele — caso contrário o item é recusado.
\nVocê informa quantidade e valor unitário; quanto isso rende é decidido pelas regras do programa de fidelidade da loja (categoria e fabricante do produto, percentual configurado). Item que não se encaixa em nenhuma regra é registrado com valor zero — não gera erro e não impede o restante do pedido.
\nQualquer item recusado derruba a requisição inteira e nada é gravado — não existe resultado parcial. Quando a recusa é produto não encontrado, a mensagem lista de uma vez todos os itens que não foram localizados, para você não descobrir um por chamada.
\nArray com um objeto por item aceito, na ordem em que você os enviou.
\nA recusa vem como uma lista de mensagens:
\n{\"total\":1,\"errors\":[{\"message\":\"Número de pedido externo já está associado a outro cashback concedido.\"}]}\nLeia o motivo em errors[].message; total é a quantidade de mensagens.
Altera um cashback já concedido por pedido externo: libera o crédito que estava em carência, cancela a concessão, corrige o valor ou a data de entrega. O pedido é identificado pelo mesmo externalOrderId usado na concessão.
Não envie partnerId: ele é resolvido pelo backend a partir do documentPartner.
A atualização alcança apenas os lançamentos que ainda estão em TO_RELEASE. Um pedido cujo cashback já foi liberado, cancelado ou expirado responde 404 — mesmo existindo. Na prática: a janela para corrigir a concessão é a carência.
Um pedido externo com vários itens gerou um lançamento por item, e a atualização é aplicada a todos eles de uma vez. Não há como alterar só um item do pedido por esta rota.
\nearning é o total do pedido, dividido entre os itensO valor informado em earning é o cashback do pedido, não de cada item: num pedido de dois itens, \"earning\": 10 grava 5 em cada lançamento. Omita o campo quando não for corrigir o valor — o cashback calculado na concessão é preservado.
Array com um objeto por lançamento atualizado — um por item do pedido externo. Omitir status mantém o status atual e aplica só os demais campos enviados.
A recusa vem como uma lista de mensagens:
\n{\"total\":1,\"errors\":[{\"message\":\"Nenhum registro encontrado com o número do pedido externo informado.\"}]}\nLeia o motivo em errors[].message; total é a quantidade de mensagens.
Endpoints para consulta de saldos e gerenciamento de cashback de clientes.
\n","_postman_id":"06b0535f-213f-43b3-8371-aa39078e6b81","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"API CWS Platform","type":"collection"}}},{"name":"13 - Callbacks e Webhooks","item":[{"name":"Cálculo de Impostos (Síncrono)","item":[{"name":"[DOC] Autenticação (O que sua loja precisa fornecer)","id":"b54be8b3-9ade-48f3-9e12-5e0f656bb275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"Para proteger seu endpoint de cálculo de impostos, a CWS utilizará um token de acesso obtido do seu sistema. Antes de chamar seu endpoint de impostos, faremos uma requisição ao seu endpoint de autenticação para obter um access_token.
Você deve fornecer à equipe CWS as informações necessárias para que possamos nos autenticar no seu sistema (URL do endpoint de token, credenciais, etc.).
\nA resposta do seu endpoint de token deve seguir o padrão OAuth2:
\n{\n \"access_token\": \"SEU_TOKEN_GERADO\",\n \"expires_in\": 3600\n}\nAbaixo estão três exemplos reais de como seu endpoint de token pode ser configurado.
\nclient_credentials com Basic AuthComo funciona: Suas credenciais (clientId e clientSecret) são combinadas, codificadas em Base64 e enviadas no Header Authorization.
Requisição que a CWS fará para seu endpoint de token:
\ncurl --location '[https://api.exemplo-cliente.com/oauth/access-token](https://api.exemplo-cliente.com/oauth/access-token)' \\\n--header 'Authorization: Basic [SUAS_CREDENCIAS_EM_BASE64]' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials'\nclientId e clientSecret no BodyComo funciona: Suas credenciais são enviadas diretamente no corpo (body) da requisição em formato JSON.
\nRequisição que a CWS fará para seu endpoint de token:
\ncurl --location '[https://api.exemplo-cliente.com/v1/token](https://api.exemplo-cliente.com/v1/token)' \\\n--header 'User-Agent: CWS Digital' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"clientId\": \"SEU_CLIENT_ID\",\n \"clientSecret\": \"SEU_CLIENT_SECRET\"\n}'\nEste método mais simples não requer um endpoint de token. Um token fixo (API Key) pré-combinado é enviado diretamente no corpo de cada requisição principal.
\nRequisição que a CWS fará para seu endpoint de Cálculo de Impostos:
\ncurl --location '[https://api.exemplo-cliente.com/wscwstax/calcular](https://api.exemplo-cliente.com/wscwstax/calcular)' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"cliente\": \"03.558.351/0001-00\",\n \"itens\": [...],\n \"token\": \"SEU_TOKEN_ESTATICO_PRE_ACORDADO\",\n ...\n}'\nEste é um exemplo completo da requisição que a CWS enviará para o seu endpoint de Cálculo de Impostos.
\nSeu sistema deve retornar uma resposta 200 OK com o seguinte corpo:
{\n \"empresa\": \"12.377.080/0001-88\",\n \"num_pedido\": \"0\",\n \"cliente\": \"03.558.351/0001-00\",\n \"mensagem\": \"sucesso\",\n \"status\": \"ok\",\n \"itens\": [\n {\n \"item\": \"123456\",\n \"st\": \"0.000000\",\n \"ipi\": \"11.120000\",\n \"icms\": 0,\n \"pis\": 0,\n \"cofins\": 0\n },\n {\n \"item\": \"7891011\",\n \"st\": \"0.000000\",\n \"ipi\": \"0.000000\",\n \"icms\": 0,\n \"pis\": 0,\n \"cofins\": 0\n }\n ]\n}\nPara que a CWS possa enviar notificações de Webhook (Pedidos e Clientes) de forma segura, nosso sistema primeiro se autenticará no seu para obter um token de acesso.
\nVocê deve nos fornecer os detalhes do seu endpoint de autenticação para que possamos configurá-lo.
\nVocê precisará construir um endpoint POST (ex: /token) que, ao receber as credenciais corretas, retorne um token de acesso. A resposta deve seguir o padrão OAuth2:
{\n \"access_token\": \"SEU_TOKEN_GERADO\",\n \"expires_in\": 3600\n}\nAbaixo estão três exemplos reais de como seu endpoint de token pode ser configurado.
\nclient_credentials com Basic AuthComo funciona: Suas credenciais (clientId e clientSecret) são combinadas, codificadas em Base64 e enviadas no Header Authorization.
Requisição que a CWS fará para seu endpoint de token:
\ncurl --location '[https://api.cliente.com.br/oauth/access-token](https://api.cliente.com.br/oauth/access-token)' \\\n--header 'Authorization: Basic [SUAS_CREDENCIAS_EM_BASE64]' \\\n--header 'Content-Type: application/x-www-form-urlencoded' \\\n--data-urlencode 'grant_type=client_credentials'\nclientId e clientSecret no BodyComo funciona: Suas credenciais são enviadas diretamente no corpo (body) da requisição em formato JSON.
\nRequisição que a CWS fará para seu endpoint de token:
\ncurl --location '[https://api.cliente.com.br/v1/token](https://api.cliente.com.br/v1/token)' \\\n--header 'User-Agent: CWS Digital' \\\n--header 'Content-Type: application/json' \\\n--data '{\n \"clientId\": \"SEU_CLIENT_ID\",\n \"clientSecret\": \"SEU_CLIENT_SECRET\"\n}'\nComo funciona: Um modelo não padrão onde o usuário e a senha são enviados em headers específicos, em vez de usar Authorization ou o corpo da requisição.
Requisição que a CWS fará para seu endpoint de token:
\ncurl --location --request POST '[https://api.cliente.com.br/rest/api/oauth2/v1/token?grant_type=password](https://api.cliente.com.br/rest/api/oauth2/v1/token?grant_type=password)' \\\n--header 'username: SEU_USUARIO' \\\n--header 'password: SUA_SENHA'\nEste é um exemplo de payload para o Webhook de Pedidos na versão simplificada. Sua loja recebe esta notificação e pode usar o id para buscar os detalhes completos na API da CWS.
Este é um exemplo de payload para o Webhook de Pedidos na versão completa, contendo todos os detalhes da transação.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","name":"13 - Callbacks e Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["webhook","pedido-completo"],"host":["api","exemplo-cliente","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"1c8d3a7c-31b2-4b45-a276-47d3f8f58184"},{"name":"[EXEMPLO] Payload de Webhook de Clientes","id":"dbee5f5b-5bcf-4ff2-8b1c-56441773d0ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": 547322,\n \"document\": \"29.701.244/0001-83\",\n \"name\": \"TEste meu S/A\",\n \"tradingName\": \"abacate 8\",\n \"contactName\": \"John Doe\",\n \"documentType\": \"pj\",\n \"dateCreated\": \"2023-01-25T19:59:58Z\",\n \"email\": \"vrpvip@gmail.com\",\n \"phone\": \"(11) 99999-9990\",\n \"address\": [\n {\n \"id\": 1060461,\n \"name\": \"Endereço de cadastro\",\n \"street\": \"Rua Eugênio Lorenzetti\",\n \"number\": \"111\",\n \"complement\": \"teste\",\n \"quarter\": \"Jardim Íris\",\n \"city\": \"São Paulo\",\n \"state\": \"SP\",\n \"zipcode\": \"05144-000\",\n \"principal\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.exemplo-cliente.com.br/webhook/clientes","description":"Este é um exemplo de payload para o Webhook de Clientes, enviado quando um cliente é criado ou atualizado na plataforma CWS.
\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","name":"13 - Callbacks e Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["webhook","clientes"],"host":["api","exemplo-cliente","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"dbee5f5b-5bcf-4ff2-8b1c-56441773d0ce"}],"id":"81c3aaeb-ea2a-416e-9f5c-f5a845a36ec7","description":"Esta pasta contém exemplos práticos de requisições que a CWS envia para o sistema do cliente. Eles servem como modelo para a construção dos seus endpoints de Webhooks.
\n","_postman_id":"81c3aaeb-ea2a-416e-9f5c-f5a845a36ec7","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","name":"13 - Callbacks e Webhooks","type":"folder"}}}],"id":"96f7805e-a8e3-4c52-84f4-ae2adf4d183c","description":"Esta seção documenta as integrações onde a plataforma CWS inicia a comunicação e envia dados para o sistema da sua loja. Diferente das outras seções desta coleção, aqui descrevemos os endpoints que você precisará construir para receber nossas chamadas.
\nExistem dois tipos de comunicação iniciada pela CWS:
\nSíncronas (Callbacks): A CWS faz uma chamada e aguarda uma resposta imediata para continuar um processo. Ex: Cálculo de Impostos.
\nAssíncronas (Webhooks): A CWS envia uma notificação sobre um evento ocorrido e não aguarda uma resposta para continuar seus processos. Ex: Notificação de novos pedidos e clientes.
\n