{"info":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","description":"

Bem-vindo à API da CWS!

Esta documentação fornece a Varejistas e Distribuidores todas as informações técnicas necessárias para uma integração bem-sucedida, garantindo que seus dados de estoque, preços e pedidos estejam sempre sincronizados em tempo real com a nossa plataforma.

Material 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) através do remetente _jira@cwsdigital.atlassian.net_.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"124238","collectionId":"50f0524e-205e-4b92-a12e-be9686666536","publishedId":"2sB3QNp8Mi","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-07-07T14:43:56.000Z"},"item":[{"name":"01 - Autenticação","item":[{"name":"Obter Token de Acesso","event":[{"listen":"test","script":{"id":"8a6b300a-1a27-4771-be0d-a5894dcd7859","exec":["var jsonData = JSON.parse(responseBody);","","postman.setEnvironmentVariable(\"access_token\", \"Bearer \" + jsonData.access_token);","postman.setEnvironmentVariable(\"refresh_token\", jsonData.refresh_token);","postman.setEnvironmentVariable(\"authorization_secret\", jsonData.access_token);"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"2a9dc867-5cf8-44ae-9d6b-63132a8a65d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"Basic YXBpLXdzOnBhc3N3b3JkLW1hc3Rlcg=="}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"trust","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"teste.teste@teste.com.br","type":"text"},{"key":"password","value":"@Teste01","type":"text"}]},"url":"{{url}}/oauth/token","description":"

Descrição

Este endpoint realiza a autenticação do usuário e retorna um token de acesso (access_token) para autorização nas demais chamadas da API.

Importante: O access_token expira a cada 12 horas. Após a expiração, uma nova autenticação deve ser realizada.

Corpo da Requisição (Form-URL-Encoded)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`grant_type`	`string`	Sim	Tipo de concessão de acesso. Deve ser sempre `'password'`.
`scope`	`string`	Sim	Escopo da requisição. Deve ser sempre `'trust'`.
`username`	`string`	Sim	E-mail de usuário da plataforma CWS.
`password`	`string`	Sim	Senha do usuário da plataforma CWS.

Estrutura da Resposta (`200 OK`)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
`access_token`	`string`	Token de acesso para ser usado no header `Authorization` das próximas requisições (Ex: `Bearer` ).
`refresh_token`	`string`	Token utilizado para renovar o `access_token` sem a necessidade de um novo login.
`token_type`	`string`	Tipo do token. Ex: `bearer`.
`expires_in`	`integer`	Tempo de vida do token em segundos (43199s = 12h).
`scope`	`string`	Escopo retornado pela autenticação.

","urlObject":{"path":["oauth","token"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"c71b38ef-175b-42fc-87d9-5f6f1d0e7aa1","name":"1.1 - Autenticar","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Authorization","value":"{{basic_auth}}"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"scope","value":"trust","type":"text"},{"key":"grant_type","value":"password","type":"text"},{"key":"username","value":"teste.teste@teste.com.br","type":"text"},{"key":"password","value":"@Teste01","type":"text"}]},"url":"{{url}}/oauth/token"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"56bb7fef-8a7c-4a97-be7b-05f44e423f08\",\n \"token_type\": \"bearer\",\n \"refresh_token\": \"b550ae00-8f43-4c86-9765-443039880be5\",\n \"expires_in\": 43199,\n \"scope\": \"trust\"\n}"}],"_postman_id":"2a9dc867-5cf8-44ae-9d6b-63132a8a65d7"}],"id":"6f2e7ac5-a12d-4a85-9b2d-73a1e955b073","description":"

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":"6f2e7ac5-a12d-4a85-9b2d-73a1e955b073","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"02 - Estoque e Preço","item":[{"name":"Gestão de Estoque da Loja","item":[{"name":"Atualizar ou Criar Estoque em Lote","id":"77ec2582-2f5a-4aa6-abf0-3c74e39f0fb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"PROD-001\",\n \"warehouseId\": 6775,\n \"quantity\": 10,\n \"price\": 2297.56\n },\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"PROD-002\",\n \"warehouseId\": 6775,\n \"quantity\": 5,\n \"price\": 150.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/v1/stock/batch","description":"

Descrição

Permite criar ou atualizar múltiplos itens de estoque (em lote, até 50 por vez) para a sua própria loja. A identificação do produto é feita por um atributo customizado (SKU interno).

Corpo da Requisição (JSON)

O corpo da requisição é um objeto contendo a chave stockRequest, que é uma lista de até 50 itens de estoque.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro (por item)	Tipo	Obrigatório	Descrição
`skuAttributeName`	`string`	Sim	Nome do atributo de vínculo do SKU (definido no projeto).
`skuAttributeValue`	`string`	Sim	Valor do atributo (código interno do produto).
`warehouseId`	`integer`	Sim	ID do depósito onde o estoque será alocado.
`quantity`	`integer`	Sim	Quantidade em estoque.
`price`	`number`	Sim	Preço de venda.
`leadTime`	`integer`	Não	Tempo de preparação (em dias).
`byRequest`	`boolean`	Não	Disponível apenas para orçamento.
`virtualQuantity`	`integer`	Não	Estoque virtual.

Estrutura da Resposta (`200 OK`)

Retorna uma lista com o resultado do processamento de cada item enviado.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo (por item)	Tipo	Descrição
`id`	`integer`	ID do estoque criado/atualizado. Será `0` em caso de erro.
`status`	`string`	Status da operação: `CREATED`, `UPDATED` ou `ERROR`.
`error`	`string`	Mensagem de erro (presente apenas se `status` for `ERROR`).
`...`	`...`	Outros campos do item enviado na requisição.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/stocks/:stockId/priceRuleTagId/:priceRuleTagId","description":"

Descrição

Associa uma tag de regra de preço (PriceRuleTag) a um produto. A tag é aplicada globalmente ao produto, afetando todos os seus estoques em todos os depósitos.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`stockId`	`integer`	Sim	ID de qualquer um dos estoques associados ao produto.
`priceRuleTagId`	`integer`	Sim	ID da tag de regra de preço a ser vinculada.

Estrutura da Resposta (`200 OK`)

Retorna um objeto confirmando a associação.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/stocks/:stockId/priceRuleTagId/:priceRuleTagId","description":"

Descrição

Remove uma única tag de regra de preço associada a um produto. A remoção é global para o produto, independentemente do stockId informado.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`stockId`	`integer`	Sim	ID de qualquer um dos estoques associados ao produto.
`priceRuleTagId`	`integer`	Sim	ID da tag de regra de preço a ser removida.

Resposta (`202 Accepted`)

A solicitação foi aceita e a remoção será processada de forma assíncrona. Nenhum corpo de resposta é retornado.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/stocks/:stockId/priceRuleTag","description":"

Descrição

Remove todas as tags de regra de preço associadas a um produto. A ação é aplicada globalmente ao produto, afetando todos os seus estoques.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`stockId`	`integer`	Sim	ID de qualquer um dos estoques associados ao produto.

Resposta (`202 Accepted`)

A solicitação foi aceita e a remoção será processada de forma assíncrona. Nenhum corpo de resposta é retornado.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["stocks",":stockId","priceRuleTag"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"37257771","key":"stockId"}]}},"response":[],"_postman_id":"4b325608-b004-4548-a8e4-a221980ed584"}],"id":"11213e7d-c2bf-45d8-b76e-6342a4de7ca8","_postman_id":"11213e7d-c2bf-45d8-b76e-6342a4de7ca8","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"Gestão de Estoque pela Matriz (Filiais)","item":[{"name":"Adicionar ou Atualizar Estoque em Filial","id":"ee88a9f5-2455-453c-8a35-5b3e7700f515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"brand\": \"Mirador\",\n \"composition\": \"UNITARY\",\n \"mfrPartCode\": \"PD001\",\n \"warehouseId\": 4970,\n \"quantity\": 10,\n \"price\": 2297.56,\n \"virtualQuantity\": 0,\n \"leadTime\": 7,\n \"byRequest\": false,\n \"partCode\": \"802702\"\n}"},"url":"{{url}}/stocks/store/:partnerId","description":"

Descrição

Permite que uma conta Matriz adicione ou atualize o estoque em uma loja Filial vinculada.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`partnerId`	`integer`	Sim	ID da loja Filial que terá o estoque gerenciado.

Corpo da Requisição (JSON)

(Os parâmetros são idênticos ao endpoint \"Adicionar ou Atualizar Estoque por Parâmetros\").

Estrutura da Resposta (`200 OK`)

Retorna o objeto de estoque criado ou atualizado na loja filial.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"quantity\": 15,\n \"price\": 1999.90,\n \"leadTime\": 5\n}"},"url":"{{url}}/stocks/store/:partnerId/:id","description":"

Descrição

Permite que uma conta Matriz atualize um item de estoque específico em uma loja Filial.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`partnerId`	`integer`	Sim	ID da loja Filial.
`id`	`integer`	Sim	ID do estoque a ser atualizado na filial.

Corpo da Requisição (JSON)

(Os parâmetros são idênticos ao endpoint \"Atualizar Estoque por ID\").

Estrutura da Resposta (`200 OK`)

Retorna o objeto de estoque atualizado na loja filial.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"stockRequest\": [\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"PROD-001\",\n \"warehouseId\": 4970,\n \"quantity\": 10,\n \"price\": 2297.56\n },\n {\n \"skuAttributeName\": \"codigo-interno\",\n \"skuAttributeValue\": \"PROD-002\",\n \"warehouseId\": 4970,\n \"quantity\": 5,\n \"price\": 150.00\n }\n ]\n}\n"},"url":"{{url}}/v1/stock/batch/:partnerId","description":"

Descrição

Permite que uma conta Matriz crie ou atualize múltiplos itens de estoque (em lote, até 50 por vez) para uma loja Filial. A identificação do produto é feita por um atributo customizado.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`partnerId`	`integer`	Sim	ID da loja Filial.

Corpo da Requisição (JSON)

O corpo da requisição é um objeto contendo a chave stockRequest, que é uma lista de até 50 itens de estoque.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro (por item)	Tipo	Obrigatório	Descrição
`skuAttributeName`	`string`	Sim	Nome do atributo de vínculo do SKU (definido no projeto).
`skuAttributeValue`	`string`	Sim	Valor do atributo (código interno do produto).
`warehouseId`	`integer`	Sim	ID do depósito na loja filial.
`quantity`	`integer`	Sim	Quantidade em estoque.
`price`	`number`	Sim	Preço de venda.
`leadTime`	`integer`	Não	Tempo de preparação (em dias).
`byRequest`	`boolean`	Não	Disponível apenas para orçamento.
`virtualQuantity`	`integer`	Não	Estoque virtual.

Estrutura da Resposta (`200 OK`)

Retorna uma lista com o resultado do processamento de cada item enviado.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo (por item)	Tipo	Descrição
`id`	`integer`	ID do estoque criado/atualizado. Será `0` em caso de erro.
`status`	`string`	Status da operação: `CREATED`, `UPDATED` ou `ERROR`.
`error`	`string`	Mensagem de erro (presente apenas se `status` for `ERROR`).
`...`	`...`	Outros campos do item enviado na requisição.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["v1","stock","batch",":partnerId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"5057","key":"partnerId"}]}},"response":[],"_postman_id":"098cdea0-39ab-453c-8e97-851bc5903ff5"}],"id":"bcb845e7-da52-44a1-87d1-be32596e73d6","_postman_id":"bcb845e7-da52-44a1-87d1-be32596e73d6","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}}],"id":"49923570-0f5a-4180-bad0-7d3a05f783ae","description":"

Endpoints dedicados ao gerenciamento completo de estoque e preços dos produtos em seus depósitos.

\n","_postman_id":"49923570-0f5a-4180-bad0-7d3a05f783ae","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"03 - Pedidos","item":[{"name":"Listar Pedidos da Loja","id":"d0cd9c09-a7d7-4246-ba3c-8c3c222d8589","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/list/?limit=10&status=PAYMENT_APPROVED","description":"

Descrição

Retorna uma lista paginada dos pedidos recebidos pela sua loja, ordenados dos mais recentes para os mais antigos. Este endpoint suporta diversos filtros para refinar a busca.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Define a quantidade de pedidos retornados (Padrão: 5, Máximo: 25).
`offset`	`integer`	Não	Define o ponto de partida da busca para paginação.
`status`	`string`	Não	Filtra pedidos por um status específico.
`createdFrom`	`string`	Não	Data de início (criação) para o filtro. Formato `YYYY-MM-DDTHH:mm:ssZ`.
`createdTo`	`string`	Não	Data final (criação) para o filtro. Formato `YYYY-MM-DDTHH:mm:ssZ`.
`updatedFrom`	`string`	Não	Data de início (atualização) para o filtro. Formato `YYYY-MM-DDTHH:mm:ssZ`.
`updatedTo`	`string`	Não	Data final (atualização) para o filtro. Formato `YYYY-MM-DDTHH:mm:ssZ`.

Valores permitidos para status: PRE_ORDER, AWAITING_PAYMENT, PAYMENT_APPROVED, READY, SHIPPED, DELIVERED, COMPLETED, CANCELED, STRAYED, RETURNED.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de objetos de pedido, cada um contendo id, status, total, dateCreated, lastUpdated, e informações de customer e partner.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["partnerOrders","list",""],"host":["{{url}}"],"query":[{"disabled":true,"key":"offset","value":"0"},{"disabled":true,"key":"limit","value":"20"},{"disabled":true,"key":"createdFrom","value":"2021-07-16T00:00:00Z"},{"disabled":true,"key":"createdTo","value":"2021-07-15T00:00:00Z"},{"disabled":true,"key":"updatedFrom","value":"2021-07-15T23:59:59Z"},{"disabled":true,"key":"updatedTo","value":"2022-01-27T12:59:59Z"},{"key":"status","value":"PAYMENT_APPROVED"}],"variable":[]}},"response":[],"_postman_id":"d0cd9c09-a7d7-4246-ba3c-8c3c222d8589"},{"name":"Listar Pedidos do Marketplace","id":"5cd0728d-1dca-43d4-a8e8-69e81c5d05b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/list/store?limit=10","description":"

Descrição

Retorna uma lista paginada de todos os pedidos do marketplace (visão de marketplace/matriz). Os parâmetros e a estrutura da resposta são idênticos ao endpoint \"Listar Pedidos da Loja\".

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/:id","description":"

Descrição

Consulta e retorna todos os dados detalhados de um pedido específico da sua loja, identificado pelo seu id.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`) a ser consultado.

Estrutura da Resposta (`200 OK`)

Retorna um objeto JSON completo com todos os detalhes do pedido, incluindo dados do cliente, produtos, pagamentos, entregas, impostos e histórico de status.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/store/:id","description":"

Descrição

Consulta e retorna todos os dados detalhados de um pedido específico (visão de marketplace/matriz). A estrutura da resposta é idêntica ao endpoint \"Buscar Detalhes do Pedido - Loja\".

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`) a ser consultado.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["partnerOrders","store",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"613515","key":"id"}]}},"response":[],"_postman_id":"e1749563-bcc0-47c9-b9ee-eea65cd5c900"},{"name":"Listar Pedidos Filhos por Pedido Pai","id":"5eac81ef-a8d4-46ee-8c50-4d30f8e80dad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/store/order/:id","description":"

Descrição

Lista todos os pedidos filhos (partnerOrder) vinculados a um pedido pai (order), identificado pelo seu ID.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido pai (`orderId`).

Estrutura da Resposta (`200 OK`)

Retorna uma lista de objetos, onde cada objeto representa um pedido filho com seus detalhes completos.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"status\": \"READY\",\n \"supplierOrderId\": \"PED-INT-12345\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/partnerOrders/:id","description":"

Descrição

Permite atualizar o status de um pedido em diferentes etapas do fluxo. Campos adicionais podem ser necessários dependendo do status.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`) a ser atualizado.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Status	Campos Obrigatórios no Body
`READY`	`status`, `supplierOrderId` (código do pedido interno)
`SHIPPED`	`status`. Opcionais: `trackingCode`, `urlTrackingCode`, `ownCarrier`, `supplierInvoiceNumber`, etc.
`CANCELED`	`status`, `orderReasonCanceled` (ID numérico do motivo)
`DELIVERED`	`status`
`RETURNED`	`status`
`STRAYED`	`status`

Tabela de Motivos para Cancelamento (orderReasonCanceled):

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Motivo
2	Arrependimento 7 dias
8	Furo de estoque
17	Atraso no envio

(Consulte a documentação original para a lista completa)

Estrutura da Resposta (`200 OK`)

Retorna o objeto completo e atualizado do pedido.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"status\": \"SHIPPED\",\n \"trackingCode\": \"BR123456789BR\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/partnerOrders/store/:id","description":"

Descrição

Permite que uma conta Marketplace/Matriz atualize o status de um pedido. A lógica de funcionamento, parâmetros e resposta são idênticos ao endpoint \"Atualizar Status do Pedido - Loja\".

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"status\": \"APPROVED\",\n \"payments\": [\n {\n \"value\": 2692.09,\n \"paymentConditionInternalCode\": \"313\",\n \"paymentConditionTermsInternalCode\": \"8\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/partnerOrders/order/:orderId","description":"

Descrição

Permite aprovar um pedido diretamente através do ID da order (pedido pai), atualizando seu status para APPROVED. É útil para cenários de pagamento offline ou faturado.

Parâmetros da Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`orderId`	`integer`	Sim	ID do pedido pai (`order`).

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`status`	`string`	Sim	Deve ser `APPROVED`.
`payments`	`array`	Sim	Lista de objetos de pagamento.

Estrutura de cada objeto payments:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`value`	`number`	Sim	Valor do pagamento.
`paymentConditionInternalCode`	`string`	Não	Código interno da forma de pagamento.
`paymentConditionTermsInternalCode`	`string`	Não	Código interno da condição de pagamento.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["partnerOrders","order",":orderId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"73341","key":"orderId"}]}},"response":[],"_postman_id":"6d5ab029-20db-455b-9a99-c44eb006a700"},{"name":"Listar Itens com Lead Time Sob Consulta","id":"93e2f36f-0dcc-42dc-a08f-eeb201d43579","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/:id/partnerOrderLines","description":"

Descrição

Permite consultar os produtos de um pedido que ainda possuem leadTime sob consulta pendente de preenchimento.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Estrutura da Resposta (`200 OK`)

Retorna uma lista contendo apenas os itens do pedido com leadTime sob consulta não preenchido. Se todos os produtos já tiverem o leadTime definido, a resposta será uma lista vazia.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Descrição
`id`	`integer`	ID do item do pedido (`partnerOrderLine`).
`name`	`string`	Nome do produto.
`brand`	`string`	Marca do produto.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["partnerOrders",":id","partnerOrderLines"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"12345","key":"id"}]}},"response":[],"_postman_id":"93e2f36f-0dcc-42dc-a08f-eeb201d43579"},{"name":"Upload de XML da Nota Fiscal - Loja","id":"bcec9cbb-307f-49d2-9145-25ae367ad761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"file","file":{"src":""}},"url":"{{url}}/partnerOrders/:id/invoice","description":"

Descrição

Realiza o upload do arquivo XML da Nota Fiscal Eletrônica (NF-e) para um pedido específico.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Corpo da Requisição (form-data)

O corpo da requisição deve ser do tipo multipart/form-data, contendo o arquivo XML.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"file","file":{}},"url":"{{url}}/partnerOrders/store/:id/invoice","description":"

Descrição

Permite que uma conta Marketplace/Matriz realize o upload do arquivo XML da NF-e para um pedido. A lógica de funcionamento é idêntica ao endpoint \"Upload de XML da Nota Fiscal - Loja\".

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"orderId\": 149580,\n \"partnerOrderId\": 98765,\n \"skus\": [\n { \"sku\": 556871, \"quantity\": 5, \"situation\": \"Enviado\" },\n { \"sku\": 556871, \"quantity\": 3, \"situation\": \"Preparando\" }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/partnerOrders/:id/complementaryInfo","description":"

Descrição

Envia/substitui as informações complementares de acompanhamento dos itens do pedido (seção \"Acompanhamento dos Itens\" no Minha Conta). Cada envio é uma sobrescrita total do conjunto ativo do pedido.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Obrigatório	Descrição
`orderId`	`integer`	Sim	ID do pedido pai (Order).
`partnerOrderId`	`integer`	Sim	ID do pedido (`partnerOrder`).
`skus`	`array`	Sim	Lista não-vazia de itens.
`skus[].sku`	`integer`	Sim	`sku_id` interno (deve existir na base).
`skus[].quantity`	`integer`	Sim	Quantidade (numérica).
`skus[].situation`	`string`	Sim	Situação (texto livre).

Validações (retornam `422`; nada é gravado)

skus vazio ou ausente;
quantity não-numérico;
sku inexistente na base;
orderId ou partnerOrderId ausentes;
pedido não pertence ao Order informado.

Resposta

200 com o conjunto ativo resultante (cada item com productName derivado de sku.name).

access_token retornado na resposta do serviço 1.1 - autenticar

Descrição

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Campo	Tipo	Obrigatório	Descrição
`orderId`	`integer`	Sim	ID do pedido pai (Order).
`partnerOrderId`	`integer`	Sim	ID do pedido (`partnerOrder`).
`skus`	`array`	Sim	Lista não-vazia de itens.
`skus[].sku`	`integer`	Sim	`sku_id` interno (deve existir na base).
`skus[].quantity`	`integer`	Sim	Quantidade (numérica).
`skus[].situation`	`string`	Sim	Situação (texto livre).

Validações (retornam `422`; nada é gravado)

skus vazio ou ausente;
quantity não-numérico;
sku inexistente na base;
orderId ou partnerOrderId ausentes;
pedido não pertence ao Order informado.

Resposta

200 com o conjunto ativo resultante (cada item com productName derivado de sku.name).

Observação (Marketplace)

A conta Marketplace/Matriz (dona do Order) pode operar qualquer pedido filho do Order. A escrita (envio/remoção) exige o atributo de loja isEnableMarketPlaceUpdatePartnerOrder = 'true'.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/:id/complementaryInfo","description":"

Descrição

Consulta as informações complementares ativas do pedido.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Resposta

{ orderId, partnerOrderId, skus: [ { sku, productName, quantity, situation } ] }.

Sem dados ativos, retorna { orderId, partnerOrderId } sem o bloco skus.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/store/:id/complementaryInfo","description":"

Descrição

Consulta as informações complementares ativas do pedido.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Resposta

{ orderId, partnerOrderId, skus: [ { sku, productName, quantity, situation } ] }.

Sem dados ativos, retorna { orderId, partnerOrderId } sem o bloco skus.

Observação (Marketplace)

A conta Marketplace/Matriz (dona do Order) pode operar qualquer pedido filho do Order. A escrita (envio/remoção) exige o atributo de loja isEnableMarketPlaceUpdatePartnerOrder = 'true'.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/:id/complementaryInfo","description":"

Descrição

Remove (soft delete) todas as informações complementares ativas do pedido. Após a remoção, a consulta não retorna skus; o histórico é preservado (deletedAt).

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["partnerOrders",":id","complementaryInfo"],"host":["{{url}}"],"query":[],"variable":[{"id":"ade15fc3-e1da-4efb-8ae5-e7515b9e1c0f","type":"any","value":"1021306","key":"id"}]}},"response":[],"_postman_id":"8d454177-e087-4aa0-a349-f1fbeb3dff6d"},{"name":"Remover Acompanhamento dos Itens - Marketplace","id":"d7f9e266-0181-447a-8cc7-29f2044c6787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerOrders/store/:id/complementaryInfo","description":"

Descrição

Remove (soft delete) todas as informações complementares ativas do pedido. Após a remoção, a consulta não retorna skus; o histórico é preservado (deletedAt).

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do pedido (`partnerOrder`).

Observação (Marketplace)

A conta Marketplace/Matriz (dona do Order) pode operar qualquer pedido filho do Order. A escrita (envio/remoção) exige o atributo de loja isEnableMarketPlaceUpdatePartnerOrder = 'true'.

Serviços para consulta e gerenciamento de pedidos.

\n","_postman_id":"7731c6a0-2121-4031-97df-8a4ed967e373","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"04 - Clientes","item":[{"name":"Gestão de Clientes","item":[{"name":"Buscar Cliente por Documento","id":"cebf223e-cff5-4be1-89aa-76abe6ac2e53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/:document/document","description":"

Descrição

Consulta os dados completos de um cliente a partir do seu CPF ou CNPJ.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.

Estrutura da Resposta (`200 OK`)

Retorna um objeto com os dados cadastrais do cliente, incluindo id, name, email, phone, address (lista de endereços) e registrationAddress (endereço de cadastro).

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"username\":\"cliente.novo@teste.com.br\",\n \"password1\":\"Senha@Forte123\",\n \"password2\":\"Senha@Forte123\",\n \"document\":\"17896923000176\",\n \"documentType\":\"pj\",\n \"name\":\"Razão Social Exemplo\",\n \"tradingName\":\"Nome Fantasia Exemplo\", \n \"phone\":\"11912345678\",\n \"contactName\":\"Contato Exemplo\",\n \"customerRegistrationAddress\": {\n \"street\":\"Rua Principal\",\n \"number\":\"100\",\n \"quarter\":\"Centro\",\n \"zipcode\":\"01000000\",\n \"city\":\"São Paulo\",\n \"state\":\"SP\"\n }\n}"},"url":"{{url}}/customer/","description":"

Descrição

Adiciona um novo cliente (Pessoa Física ou Jurídica) à plataforma.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`username`	`string`	Sim	E-mail do cliente (será o login).
`password1`	`string`	Sim	Senha do cliente. Requisitos: min. 8 caracteres, maiúscula, minúscula, número e caractere especial.
`password2`	`string`	Sim	Confirmação da senha.
`document`	`string`	Sim	CPF ou CNPJ, somente números.
`documentType`	`string`	Sim	`cpf` para Pessoa Física, `pj` para Pessoa Jurídica.
`name`	`string`	Sim	Nome completo (CPF) ou Razão Social (PJ).
`phone`	`string`	Sim	Telefone com DDD, somente números.
`tradingName`	`string`	Se `documentType`=`pj`	Nome Fantasia.
`contactName`	`string`	Se `documentType`=`pj`	Nome do contato principal na empresa.
`customerRegistrationAddress`	`object`	Sim	Objeto com os dados do endereço de cadastro/faturamento.
`addressList`	`array`	Não	Lista de endereços de entrega adicionais.

Estrutura da Resposta (`201 Created`)

Retorna o objeto completo do cliente recém-criado, incluindo o id gerado.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"name\":\"editar nome\",\n \"tradingName\":\"editar nome\", \n \"phone\":\"11999999999\",\n \"contactName\":\"sr.Testes\",\n \"forceChangePassword\":true,\n \"customerRegistrationAddress\": { \t\n \"complement\": \"BUSINESS\",\n \"name\":\"Matriz\",\n \"street\":\"rua A\",\n \"number\":\"123\",\n \"quarter\":\"bairro\",\n \"zipcode\":\"09360-000\",\n \"city\":\"Maua\",\n \"state\":\"SP\"\n \n }\n}"},"url":"{{url}}/customer/:document","description":"

Descrição

Atualiza os dados cadastrais de um cliente. Atenção: este endpoint não gerencia a lista de endereços de entrega. Utilize os endpoints específicos para endereços.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.

Corpo da Requisição (JSON)

name – Nome do cliente (obrigatório)
phone – Telefone do cliente (obrigatório)
tradingName – Razão Social do cliente (obrigatório)
contactName – Nome do responsável pela empresa (obrigatório)
cnae – Código da CNAE
stateRegistration – Inscrição estadual (caso não informada, considera-se isento)
birthdate – Data de nascimento (formato dd/MM/yyyy)
paysIcms – Cliente contribuinte de ICMS (default: true se houver inscrição estadual)
politicallyExposedPerson – Pessoa politicamente exposta
federalEmployee – Funcionário público federal
active – Status do cliente (true ou false, permanece inalterado se omitido)
customerRegistrationAddress – Endereço de registro (não afeta endereços de entrega)
name – Nome do endereço (ex: casa, trabalho, matriz, etc.)
street – Rua
number – Número
complement – Complemento
quarter – Bairro
city – Cidade
state – Estado
zipcode – CEP
addressType – Tipo de endereço (BUSINESS ou RESIDENTIAL)

priceRuleTags – Lista de tags de preço
name – Nome da tag

customerAttributes – Lista de atributos customizáveis do cliente
name – Nome do atributo
value – Valor do atributo

customerGroupList – Grupo de clientes
id – ID do grupo
ou
name – Nome do grupo

Estrutura da Resposta (`200 OK`)

Retorna o objeto completo do cliente com os dados atualizados.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/updateStatus/:document/:active","description":"

Descrição

Altera o status de um cliente para ativo ou inativo na plataforma.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.
`active`	`boolean`	Sim	Novo status do cliente (`true` para ativar, `false` para inativar).

Estrutura da Resposta (`200 OK`)

Retorna um objeto confirmando a alteração.

{\n    \"status\": \"ACCEPTED\",\n    \"message\": \"Status do cliente atualizado com sucesso.\"\n}\n

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["customer","updateStatus",":document",":active"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"00155045067","key":"document"},{"type":"any","value":"true","key":"active"}]}},"response":[],"_postman_id":"f4523c58-e96e-45b2-bbb3-e8c17b65c5dc"}],"id":"3371df27-7686-424b-a8c3-28a241da8b46","_postman_id":"3371df27-7686-424b-a8c3-28a241da8b46","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"Endereços","item":[{"name":"Listar Endereços do Cliente","id":"dbfaab31-5a83-49b9-ac0e-609861cdf7ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/addressess/:document","description":"

Descrição

Retorna a lista de todos os endereços de entrega cadastrados para um cliente.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de objetos de endereço.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n\t\"name\":\"Endereço de Entrega 2\",\n \"street\":\"Avenida Secundária\",\n \"number\":\"500\",\n \"quarter\":\"Vila Nova\",\n \"zipcode\":\"02000000\",\n \"city\":\"São Paulo\",\n \"state\":\"SP\",\n \"principal\": 0, \n \"addressType\" : \"BUSINESS\"\n}"},"url":"{{url}}/customer/:document/address","description":"

Descrição

Adiciona um novo endereço de entrega para um cliente.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	Nome de identificação do endereço (Ex: 'Casa', 'Escritório').
`street`	`string`	Sim	Logradouro.
`number`	`string`	Sim	Número.
`quarter`	`string`	Sim	Bairro.
`zipcode`	`string`	Sim	CEP, somente números.
`city`	`string`	Sim	Cidade.
`state`	`string`	Sim	Sigla do estado (UF).
`principal`	`boolean`	Sim	`true` se este for o endereço principal, `false` caso contrário.
`addressType`	`string`	Sim	Tipo do endereço. Ex: `BUSINESS`, `RESIDENTIAL`.

Estrutura da Resposta (`201 Created`)

Retorna o objeto do endereço recém-criado, incluindo o id gerado.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/:document/address/:addressId","description":"

Descrição

Remove um endereço de entrega específico de um cliente.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.
`addressId`	`integer`	Sim	ID do endereço a ser removido.

Resposta (`200 OK`)

Retorna uma confirmação de sucesso.

{\n    \"status\": \"ACCEPTED\"\n}\n

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/deleteAllCustomerAddress/:document/","description":"

Descrição

⚠️ Atenção: Remove todos os endereços de entrega de um cliente. Após esta ação, será necessário cadastrar um novo endereço para que o cliente possa realizar compras.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF ou CNPJ do cliente, sem pontos ou traços.

Resposta (`200 OK`)

Retorna uma confirmação de sucesso.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["deleteAllCustomerAddress",":document",""],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"88149939040","key":"document"}]}},"response":[],"_postman_id":"eba66aa5-c669-4d90-8f11-4c8f1200ca0d"}],"id":"80781f55-0e61-41a7-ac53-555912f8b390","_postman_id":"80781f55-0e61-41a7-ac53-555912f8b390","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"Grupo de Clientes","item":[{"name":"Listar Grupos de Cliente","id":"4357fb1b-9273-4022-be7d-f5145637fdc5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"id\": [\n 20886,\n 19776\n ],\n \"name\": [\n \"Grupo Cliente 1\",\n \"Grupo Cliente 2\"\n ],\n \"externalId\": [\n \"teste\",\n \"EXT02\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/group/byGroup","description":"

Descrição

Permite consultar grupos de clientes utilizando filtros como IDs internos, nomes ou IDs externos.

Corpo da Requisição (JSON)

Pelo menos um dos arrays abaixo deve ser enviado.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`array`	Condicional	Lista de IDs internos dos grupos. Ex: `[20886, 19776]`.
`name`	`array`	Condicional	Lista de nomes dos grupos. Ex: `[\"Grupo A\"]`.
`externalId`	`array`	Condicional	Lista de IDs externos dos grupos. Ex: `[\"EXT01\"]`.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Grupo Varejo SP\",\n \"externalId\": \"GRP-VSP-01\",\n \"enableGroupDisplayInRegistration\": true,\n \"enableGroupDisplayInMyAccount\": true,\n \"showToSeller\": true,\n \"restrictionPaymentType\": {\n \"no_restriction\": true\n },\n \"restrictionDeliveryType\": {\n \"no_restriction\": true\n },\n \"applicationGroupDocumentType\": {\n \"pf\": true,\n \"pj\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/group","description":"

Descrição

Cadastra um novo grupo de clientes com regras específicas de visibilidade e restrições.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	Nome do grupo.
`externalId`	`string`	Não	ID externo para integração.
`showToSeller`	`boolean`	Sim	Torna o grupo visível para o vendedor.
`restrictionPaymentType`	`object`	Sim	Objeto com uma chave `true` (ex: `{\"no_restriction\": true}`).
`restrictionDeliveryType`	`object`	Sim	Objeto com uma chave `true` (ex: `{\"no_restriction\": true}`).
`applicationGroupDocumentType`	`object`	Sim	Tipos de documentos permitidos (ex: `{\"pf\": true}`).

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{ \n \"id\":20885\n}\n ","options":{"raw":{"language":"json"}}},"url":"{{url}}/customer/group","description":"

Descrição

Exclui um grupo de clientes a partir do seu ID interno ou externo.

Corpo da Requisição (JSON)

Pelo menos um dos campos abaixo deve ser informado.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Condicional	ID interno do grupo.
`externalId`	`string`	Condicional	ID externo do grupo.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/:document/priceType/:customerGroupId","description":"

Descrição

Associa um cliente a um grupo de clientes específico.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	Documento do cliente (sem pontuação).
`customerGroupId`	`integer`	Sim	ID do grupo de clientes.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["customer",":document","priceType",":customerGroupId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"88149939040","key":"document"},{"type":"any","value":"20883","key":"customerGroupId"}]}},"response":[],"_postman_id":"11330732-5359-4407-aab6-f3ced134e5a9"},{"name":"Desvincular cliente de um grupo","id":"a0669432-90a3-4afe-8fce-8874b414048e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customer/:document/priceType/:customerGroupId","description":"

Descrição

Desvincula um cliente a um grupo de clientes específico.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	Documento do cliente (sem pontuação).
`customerGroupId`	`integer`	Sim	ID do grupo de clientes.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["customer",":document","priceType",":customerGroupId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"88149939040","key":"document"},{"type":"any","value":"20883","key":"customerGroupId"}]}},"response":[],"_postman_id":"a0669432-90a3-4afe-8fce-8874b414048e"}],"id":"337475ae-86ba-41c7-8eaa-93f747f3ac92","_postman_id":"337475ae-86ba-41c7-8eaa-93f747f3ac92","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}}],"id":"e06b1e53-0805-484b-9098-3d62cf1aecac","description":"

Serviços para gerenciamento completo dos dados cadastrais de clientes, seus endereços e grupos.

\n","_postman_id":"e06b1e53-0805-484b-9098-3d62cf1aecac","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"05 - Limite de Crédito","item":[{"name":"Criar Tipo de Limite de Crédito","id":"86b7483a-35c5-4758-8850-33d3450bf384","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"Crédito Padrão\",\n \"code\": \"CREDITO-PADRAO\"\n}"},"url":"{{url}}/creditLimit/saveTypeCreditLimit","description":"

Descrição

Cria um novo tipo de limite de crédito que poderá ser posteriormente associado a um ou mais clientes. Ex: \"À Vista\", \"Boleto 30 dias\", \"Crédito Especial\".

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	Nome do tipo de limite a ser criado.
`code`	`string`	Sim	Código único para integração. Será usado para associar o limite ao cliente.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"document\": \"37202495000141\",\n \"credit_type\": \"CREDITO-PADRAO\",\n \"value\": 5000.00,\n \"balance\": 5000.00,\n \"active\": true,\n \"without_credit_limit\": false\n}"},"url":"{{url}}/creditLimit/save","description":"

Descrição

Cria ou atualiza o limite de crédito de um tipo específico para um cliente já cadastrado na plataforma.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF/CNPJ do cliente.
`credit_type`	`string`	Sim	Código do tipo de limite (criado no endpoint anterior).
`value`	`number`	Sim	Valor total do limite de crédito.
`balance`	`number`	Sim	Saldo atual do limite de crédito.
`active`	`boolean`	Sim	`true` se o crédito está ativo, `false` caso contrário.
`without_credit_limit`	`boolean`	Sim	`true` se o cliente pode comprar mesmo sem saldo. `false` caso contrário.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/creditLimit/list?document=37202495000141&limit=5","description":"

Descrição

Lista os limites de crédito da loja, com opção de filtrar por um cliente específico.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Não	Filtra a busca por um CPF/CNPJ de cliente específico.
`limit`	`integer`	Não	Quantidade de registros por página (Padrão: 5, Máximo: 25).
`offset`	`integer`	Não	Ponto de partida para paginação.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de objetos, cada um representando o limite de crédito de um cliente.

Endpoints para criar e gerenciar tipos de limite de crédito e atribuí-los aos clientes.

\n","_postman_id":"55ccf414-eeee-4651-94ea-333969d86373","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"06 - Contratos","item":[{"name":"Listar Contratos","id":"b9bbc51c-ba02-4bb4-a253-70442d919029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/pricing/contract/list?limit=10&offset=0","description":"

Descrição

Retorna uma lista paginada dos contratos de preço da sua loja.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Sim	Quantidade de contratos por página (Máximo: 50).
`offset`	`integer`	Sim	Ponto de partida para paginação.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de contratos, cada um contendo id, name, active, priority, dateStart, dateEnd, etc.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/pricing/contract/:contractId","description":"

Descrição

Consulta todos os dados de um contrato específico, incluindo clientes e produtos vinculados.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`contractId`	`integer`	Sim	ID do contrato.

Estrutura da Resposta (`200 OK`)

Retorna o objeto completo do contrato, incluindo as listas customers (clientes) e items (produtos).

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\":\"Contrato Exemplo API\",\n \"startDate\":\"2025-01-01\",\n \"endDate\":\"2025-12-31\",\n \"allCustomers\": false,\n \"priority\": 1,\n \"customers\":[\n \"00000000000\"\n ],\n \"items\":[\n {\n \"skuId\":\"7491085\",\n \"value\":99.99\n }\n ]\n}"},"url":"{{url}}/priceContract","description":"

Descrição

Cria um novo contrato com regras de aplicação para clientes, parceiros, estados ou grupos.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	Nome do contrato.
`startDate`	`string`	Sim	Data de início da vigência (`YYYY-MM-DD`).
`endDate`	`string`	Sim	Data de fim da vigência (`YYYY-MM-DD`).
`priority`	`integer`	Sim	Prioridade de aplicação.
`allCustomers`	`boolean`	Sim	`true` se aplica a todos os clientes. `false` para especificar.
`customers`	`array`	Se `allCustomers=false`	Lista de documentos (string) dos clientes.
`items`	`array`	Não	Lista de produtos com preço fixo no contrato.

Dentro de cada objeto items:

skuId ou partnerPartCode (integer ou string): ID do produto (SKU) ou seu código interno.
value (number): Preço do produto no contrato.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"active\": true,\n \"stateList\": [\"SP\", \"RJ\"],\n \"replaceFilters\": true\n}"},"url":"{{url}}/pricing/contract/:contractId","description":"

Descrição

Atualiza dados de um contrato, como status, vigência e filtros de aplicação.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`contractId`	`integer`	Sim	ID do contrato.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`active`	`boolean`	Não	`true` para ativar, `false` para inativar o contrato.
`replaceFilters`	`boolean`	Não	Se `true`, substitui os filtros existentes (clientes, produtos, etc.) pelos enviados na requisição. Se `false` (padrão), apenas adiciona.
`...`	`...`	Não	Outros campos como `name`, `startDate`, `endDate`, `customers`, `items`, etc., também podem ser atualizados.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["pricing","contract",":contractId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"182764","key":"contractId"}]}},"response":[],"_postman_id":"6fd2fd7e-d370-455a-8d3c-bc269ad7f6d5"},{"name":"Adicionar Clientes ao Contrato","id":"0769fd6d-72c7-4753-a956-28b82b7d044f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"customers\": [\n\t \"00000000000\",\n\t \"11111111111\"\n\t]\n}"},"url":"{{url}}/pricing/contract/:id/customers","description":"

Descrição

Adiciona uma lista de clientes a um contrato existente.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`customers`	`array`	Sim	Lista de documentos (string) dos clientes.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["pricing","contract",":id","customers"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"180128","key":"id"}]}},"response":[],"_postman_id":"0769fd6d-72c7-4753-a956-28b82b7d044f"},{"name":"Remover Clientes do Contrato","id":"3237f078-102e-4f16-90dd-54685fc0ca94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"customers\": [\n \"00000000000\"\n ]\n}"},"url":"{{url}}/pricing/contract/:contractId/customers","description":"

Descrição

Remove clientes de um contrato com base em seus documentos.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`customers`	`array`	Sim	Lista de documentos (string) dos clientes a serem removidos.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["pricing","contract",":contractId","customers"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"180128","key":"contractId"}]}},"response":[],"_postman_id":"3237f078-102e-4f16-90dd-54685fc0ca94"},{"name":"Adicionar Produtos ao Contrato","id":"1e30238b-fdfa-45b9-9d73-26e9d5b57086","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"items\": [\n {\n \"partnerPartCode\": \"SKU-INTERNO-001\",\n \"value\": 150.50\n },\n {\n \"skuId\": 4529568,\n \"value\": 25.75\n }\n ]\n}"},"url":"{{url}}/pricing/contract/:contractId/items","description":"

Descrição

Adiciona ou atualiza até 100 produtos em um contrato por requisição.

Corpo da Requisição (JSON)

O corpo é um objeto com uma chave items, que é uma lista de produtos.

Dentro de cada objeto items:

skuId ou partnerPartCode (integer ou string): ID do produto (SKU) ou seu código interno.
value (number): Preço do produto no contrato.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"items\": [\n\t {\n \"partnerPartCode\": \"SKU-INTERNO-001\"\n },\n {\n \"skuId\": 4529568\n }\n\t]\n}"},"url":"{{url}}/pricing/contract/:id/items","description":"

Descrição

Remove até 100 produtos de um contrato por requisição.

Corpo da Requisição (JSON)

O corpo é um objeto com uma chave items, que é uma lista de produtos a serem removidos.

Dentro de cada objeto items:

skuId ou partnerPartCode (integer ou string): ID do produto (SKU) ou seu código interno para identificação.

Endpoints para gerenciar contratos de preço fixo para clientes ou grupos de clientes.

\n","_postman_id":"b5540d9a-925f-46c3-984e-b724c7eb1d92","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"07 - Regra de Preço","item":[{"name":"Listar Regras de Preço","id":"2c5ac1fd-1a27-4eaa-8249-4991da3d14a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/priceRule","description":"

Descrição

Permite consultar as regras de preço cadastradas, com suporte a filtros e paginação.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de regras por página (Padrão: 5, Máximo: 25).
`offset`	`integer`	Não	Ponto de partida para paginação.
`name`	`string`	Não	Filtra pelo nome da regra.
`type`	`string`	Não	Tipo da regra. Valores: `PERCENT` ou `REAL`.
`cumulative`	`boolean`	Não	Filtra por regras cumulativas (`true` ou `false`).

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["priceRule"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2c5ac1fd-1a27-4eaa-8249-4991da3d14a8"},{"name":"Criar Regra de Preço","id":"8e488bb6-a33c-4be7-b0bd-6ec3cc101f4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\":\"desconto\",\n \"priority\": 1,\n \"type\":\"PERCENT\",\n \"value\":-50,\n \"cumulative\":\"true\",\n \"promotionalBeforeAfter\": true,\n \"quantity\": 100,\n \"customerHasStateRegistration\": false\n}"},"url":"{{url}}/priceRule","description":"

Descrição

Cadastra uma nova regra de preço com critérios específicos para aplicação sobre produtos e clientes.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`name`	`string`	Sim	Nome da regra de preço.
`priority`	`integer`	Sim	Prioridade de aplicação da regra (menor = mais prioritário).
`type`	`string`	Sim	Tipo de valor da regra. Valores: `PERCENT` ou `REAL`.
`value`	`number`	Sim	Valor a ser aplicado (negativo para desconto, positivo para acréscimo).
`cumulative`	`boolean`	Sim	Se `true`, a regra pode ser somada a outras.
`customerHasStateRegistration`	`boolean`	Não	Exige que o cliente tenha Inscrição Estadual.
`warehouseState`	`string`	Não	Sigla (UF) do estado do depósito para aplicar a regra.
`customerState`	`string`	Não	Sigla (UF) do estado de entrega do cliente.
`customerTagId`	`integer`	Não	ID da tag de cliente para aplicar a regra.
`skuPartnerTagId`	`integer`	Não	ID da tag de produto para aplicar a regra.

","urlObject":{"path":["priceRule"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8e488bb6-a33c-4be7-b0bd-6ec3cc101f4e"},{"name":"Deletar Regra de Preço","id":"30430fc2-029b-4cd3-96a6-2e61f3f74c12","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/priceRule/:id","description":"

Descrição

Exclui uma regra de preço previamente cadastrada, utilizando seu ID.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID da regra de preço a ser removida.

Resposta (`202 Accepted`)

A solicitação de exclusão foi aceita.

Serviços para criação e gerenciamento de regras de preço.

\n","_postman_id":"0cc793d1-27b2-4b84-96ac-62c32e18d8aa","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"08 - Orçamentos","item":[{"name":"Listar Orçamentos Pendentes","id":"595d00be-655a-4bf2-b15a-1de8c6a6840f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerBudgets/pending?limit=5&offset=0","description":"

Descrição

Lista todos os orçamentos que estão pendentes de uma resposta (preço, prazo, etc.).

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de orçamentos por página (Padrão: 5, Máximo: 25).
`offset`	`integer`	Não	Ponto de partida para paginação.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de orçamentos, cada um contendo id, quantity, dateCreated, e dados do product e customer.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerBudgets/:id","description":"

Descrição

Consulta os detalhes completos de um orçamento específico, seja ele pendente ou já respondido.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do orçamento a ser consultado.

Estrutura da Resposta (`200 OK`)

Retorna o objeto completo do orçamento, incluindo dados do produto, cliente, e, se já respondido, o price e leadTime.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerBudgetsByPartnerOrder/:partnerOrderId","description":"

Descrição

Consulta os detalhes de um orçamento a partir do ID do pedido (partnerOrder) que foi gerado a partir dele.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`partnerOrderId`	`integer`	Sim	ID do pedido (`partnerOrder`) originado do orçamento.

Estrutura da Resposta (`200 OK`)

Retorna o objeto completo do orçamento.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"price\": 3.50, \"leadTime\": 4, \"partnerPartCode\": \"666-222\"}","options":{"raw":{"language":"json"}}},"url":"{{url}}/partnerBudgets/:id","description":"

Descrição

Envia a resposta para um orçamento pendente, definindo o preço, prazo de entrega e o código interno do produto.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do orçamento a ser respondido.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`price`	`number`	Sim	Preço de venda do produto.
`leadTime`	`integer`	Sim	Prazo de entrega em dias.
`partnerPartCode`	`string`	Sim	Seu código interno (SKU) para o produto.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/partnerBudgets/:id","description":"

Descrição

Recusa um orçamento, indicando que o produto não será fornecido.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do orçamento a ser recusado.

Resposta (`204 No Content`)

A solicitação foi bem-sucedida e não há conteúdo a ser retornado.

Serviços para consulta e resposta de orçamentos solicitados por clientes.

\n","_postman_id":"041a0331-0f4a-4ce1-a076-f86cbb4c753a","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"09 - Carrinho Personalizado","item":[{"name":"Criar Carrinho Personalizado","id":"16d75c27-27c7-487f-bb22-9cb829ca2e71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cartName\":\"Carrinho de Teste API\",\n \"document\":\"11122233344\",\n \"products\":[\n {\n \"stockId\":47772924,\n \"quantity\":2\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customCart/create","description":"

Descrição

Cria um carrinho de compras personalizado com produtos pré-selecionados para um cliente específico e retorna um link de acesso direto a esse carrinho.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`cartName`	`string`	Sim	Nome para identificação do carrinho.
`document`	`string`	Sim	CPF/CNPJ do cliente.
`products`	`array`	Sim	Lista de produtos a serem adicionados.

Dentro de cada objeto products:

stockId (integer): ID do estoque do produto.
quantity (integer): Quantidade do produto.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"cartId\": 23801,\n \"actionType\": \"Complement\",\n \"products\":[\n {\n \"stockId\":47772925,\n \"quantity\":5\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/customCart/edit","description":"

Descrição

Edita um carrinho personalizado existente, adicionando ou substituindo os produtos.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`cartId`	`integer`	Sim	ID do carrinho a ser editado.
`actionType`	`string`	Sim	`Complement` para adicionar produtos, `Substitution` para substituir todos os produtos pelos novos.
`products`	`array`	Sim	Lista de produtos.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/customCart/deleteById/:id","description":"

Descrição

Exclui permanentemente um carrinho personalizado.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID do carrinho personalizado a ser excluído.

Endpoints para criar, editar e deletar carrinhos de compra personalizados para clientes.

\n","_postman_id":"3eb0e616-3c6b-44f6-b45a-2c2d08ff53e6","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"10 - Módulo Vendedor","item":[{"name":"Listar Vendedores","id":"67df5681-5333-4aff-b7f0-0c2548e5d552","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/sellerModule/listSellers?limit=20&offset=0","description":"

Descrição

Retorna uma lista paginada com todos os vendedores cadastrados na sua loja.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de vendedores por página.
`offset`	`integer`	Não	Ponto de partida para paginação.
`name`	`string`	Não	Filtra vendedores por nome.
`email`	`string`	Não	Filtra vendedores por email.
`restrictedCustomers`	`boolean`	Não	Filtra vendedores que possuem (`true`) ou não (`false`) carteira restrita.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["sellerModule","listSellers"],"host":["{{url}}"],"query":[{"key":"limit","value":"20"},{"key":"offset","value":"0"},{"disabled":true,"key":"name","value":""},{"disabled":true,"key":"restrictedCustomers","value":"false"}],"variable":[]}},"response":[],"_postman_id":"67df5681-5333-4aff-b7f0-0c2548e5d552"},{"name":"Adicionar Vendedor","id":"bd7790b3-b917-48ce-968f-74e6616125ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"username\": \"vendedor.novo@cws.digital\",\n \"document\": \"11122233344\",\n \"restrictedCustomers\": false\n}"},"url":"{{url}}/sellerModule/addSeller","description":"

Descrição

Adiciona um usuário já existente na plataforma como um vendedor da sua loja.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`username`	`string`	Condicional	Email do usuário a ser adicionado como vendedor.
`document`	`string`	Condicional	CPF/CNPJ do usuário. (Deve ser informado `username` ou `document`).
`restrictedCustomers`	`boolean`	Sim	Se `true`, o vendedor só poderá atender clientes da sua carteira.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/sellerModule/deleteSeller/:id","description":"

Descrição

Remove o vínculo de vendedor de um usuário na sua loja.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`string`	Sim	ID do vendedor a ser removido.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["sellerModule","deleteSeller",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"id"}]}},"response":[],"_postman_id":"ab250f5e-9716-4128-bd3a-608274862c7e"},{"name":"Listar Carteira de Clientes do Vendedor","id":"2f73a26b-3e89-4793-a7ff-5ea1e422d2bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/sellerModule/listCustomers/:id?limit=20&offset=0","description":"

Descrição

Lista todos os clientes que estão na carteira de um vendedor específico.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`string`	Sim	ID do vendedor.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de clientes por página.
`offset`	`integer`	Não	Ponto de partida para paginação.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["sellerModule","listCustomers",":id"],"host":["{{url}}"],"query":[{"key":"limit","value":"20"},{"key":"offset","value":"0"}],"variable":[{"type":"any","value":"5d639efc-604c-4eaf-bc33-442f526d9086","key":"id"}]}},"response":[],"_postman_id":"2f73a26b-3e89-4793-a7ff-5ea1e422d2bd"},{"name":"Vincular Cliente ao Vendedor","id":"fb9c97ae-86f1-480e-99e3-06d89c421b4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"document\" : \"33322211196\"\n}"},"url":"{{url}}/sellerModule/addCustomer/:attendantIdOrDocument/?uniqueAttendant=false","description":"

Descrição

Vincula um cliente à carteira de um vendedor.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`attendantIdOrDocument`	`string`	Sim	ID ou Documento (sem pontuação) do vendedor.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`uniqueAttendant`	`boolean`	Não	Se `true`, este se tornará o único vendedor do cliente, removendo outros vínculos. Padrão: `false`.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`username`	`string`	Condicional	Email do cliente.
`document`	`string`	Condicional	CPF/CNPJ do cliente. (Deve ser informado `username` ou `document`).

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["sellerModule","addCustomer",":attendantIdOrDocument",""],"host":["{{url}}"],"query":[{"key":"uniqueAttendant","value":"false"}],"variable":[{"type":"any","value":"19111119100","key":"attendantIdOrDocument"}]}},"response":[],"_postman_id":"fb9c97ae-86f1-480e-99e3-06d89c421b4a"},{"name":"Desvincular Cliente do Vendedor","id":"07e364e6-8c5e-4b24-af0e-49631a4c952e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/sellerModule/deleteCustomer/:idAttendant/:idCustomer","description":"

Descrição

Remove um cliente da carteira de um vendedor.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`idAttendant`	`string`	Sim	ID do vendedor.
`idCustomer`	`string`	Sim	ID do cliente.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["sellerModule","deleteCustomer",":idAttendant",":idCustomer"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"","key":"idAttendant"},{"type":"any","value":"","key":"idCustomer"}]}},"response":[],"_postman_id":"07e364e6-8c5e-4b24-af0e-49631a4c952e"},{"name":"Gerenciar Carteira em Lote","id":"462a7487-cf74-4e11-a593-f78fb1114450","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"action\": \"BIND\",\n \"users\": [\n {\n \"document\": \"11122233344\"\n },\n {\n \"username\": \"cliente.exemplo@cws.digital\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/sellerModule/manageBulkWallet/:attendantID","description":"

Descrição

Gerencia a carteira de um vendedor em massa, permitindo vincular, desvincular ou substituir múltiplos clientes de uma vez.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`attendantID`	`string`	Sim	ID do vendedor.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`action`	`string`	Sim	Ação a ser realizada: `BIND` (vincular), `UNBIND` (desvincular), `REPLACE` (substituir toda a carteira).
`users`	`array`	Sim	Lista de clientes a serem gerenciados (identificados por `username` ou `document`).

Endpoints para gerenciar vendedores e suas carteiras de clientes.

\n","_postman_id":"b284cb20-5108-47a4-b12d-356511a2d9e3","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"11 - Prioridade de SKU","item":[{"name":"Buscar Prioridade por ID","id":"576e5e37-a506-4562-855a-a1275a104ce7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/searchSkuPriority/:id","description":"

Descrição

Busca a configuração de prioridade a partir do seu ID único.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID da regra de prioridade.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["searchSkuPriority",":id"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"120","key":"id"}]}},"response":[],"_postman_id":"576e5e37-a506-4562-855a-a1275a104ce7"},{"name":"Buscar Prioridade por ID do Produto (SKU)","id":"f60ae2e1-41d5-4a99-88ae-c84a906e3330","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/searchSkuPriority/sku/:skuId","description":"

Descrição

Busca a configuração de prioridade de um produto a partir do ID do SKU na CWS.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`skuId`	`integer`	Sim	ID do produto (SKU) na CWS.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["searchSkuPriority","sku",":skuId"],"host":["{{url}}"],"query":[],"variable":[{"type":"any","value":"1062407","key":"skuId"}]}},"response":[],"_postman_id":"f60ae2e1-41d5-4a99-88ae-c84a906e3330"},{"name":"Buscar Prioridade por Código do Produto","id":"ae67d114-5159-4c31-bed3-632ed97930b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"partCode\": \"1820\",\n \"brand\": \"DS\",\n \"composition\" : \"UNITARY\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/searchSkuPriority/find","description":"

Descrição

Busca a configuração de prioridade de um produto a partir da combinação de código, marca e composição.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`partCode`	`string`	Sim	Código do produto.
`brand`	`string`	Sim	Marca do produto.
`composition`	`string`	Sim	Composição: `UNITARY`, `PAIR`, `SET` ou `KIT`.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"skuId\": 1062407,\n \"priorityLevel\" : 1\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/searchSkuPriority","description":"

Descrição

Define um nível de prioridade para um produto que ainda não possui. O produto pode ser identificado pelo skuId ou pela combinação de partCode, brand e composition.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`priorityLevel`	`integer`	Sim	Nível de prioridade a ser definido.
`skuId`	`integer`	Condicional	ID do produto na CWS.
`partCode`	`string`	Condicional	Código do produto.
`brand`	`string`	Condicional	Marca do produto.
`composition`	`string`	Condicional	Composição do produto.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"skuId\": 1062407,\n \"priorityLevel\" : 3\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/searchSkuPriority","description":"

Descrição

Atualiza o nível de prioridade para um produto que já possui uma configuração. A identificação do produto segue a mesma lógica do endpoint de criação.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`priorityLevel`	`integer`	Sim	Novo nível de prioridade.
`skuId`	`integer`	Condicional	ID do produto na CWS.
`partCode`	`string`	Condicional	Código do produto.
`brand`	`string`	Condicional	Marca do produto.
`composition`	`string`	Condicional	Composição do produto.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/searchSkuPriority/:id","description":"

Descrição

Remove a configuração de prioridade de um produto, fazendo com que ele volte ao comportamento padrão de busca.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`id`	`integer`	Sim	ID da regra de prioridade a ser removida.

Resposta (`204 No Content`)

A solicitação foi bem-sucedida.

Endpoints para gerenciar a prioridade de exibição de produtos (SKUs) nos resultados de busca.

\n","_postman_id":"f309ff57-3688-4414-92a2-b8a3b2577789","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}}},{"name":"12 - CashBack","item":[{"name":"Consultar Saldo Total de Cashback do Marketplace","id":"878a2b35-d7f3-494b-8667-0108fdccdf9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/loyaltyProgram/total","description":"

Descrição

Retorna o saldo total de cashback da sua operação, agregado e separado por tipo (crédito/débito) e status.

Estrutura da Resposta (`200 OK`)

credit: Valor total de cashback que os clientes ganharam.
- TO_RELEASE: Saldo a ser liberado.
- RELEASED: Saldo já liberado para uso.
- CANCELLED: Saldo cancelado.
\n
debit: Valor total de cashback que os clientes utilizaram.
- IN_USE: Saldo atualmente em uso em um carrinho.
- USED: Saldo já utilizado em compras.
- EXPIRED: Saldo expirado.
\n

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/loyaltyProgram/listCustomersTotal?limit=20&offset=0","description":"

Descrição

Retorna uma lista paginada do saldo atual de cashback de cada cliente.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de clientes por página (Padrão: 20, Máximo: 50).
`offset`	`integer`	Não	Ponto de partida para paginação.

Estrutura da Resposta (`200 OK`)

Retorna uma lista de objetos, cada um com customerId, name, document e os saldos de credit e debit (com seus respectivos status).

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"url":"{{url}}/loyaltyProgram/customerReport/:document?limit=20&offset=0","description":"

Descrição

Lista o histórico de transações de cashback (ganhos e usos) para um cliente específico.

Parâmetros de Rota (Path)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`document`	`string`	Sim	CPF/CNPJ do cliente.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`limit`	`integer`	Não	Quantidade de registros por página.
`offset`	`integer`	Não	Ponto de partida para paginação.
`status`	`string`	Não	Filtra por um status específico: `TO_RELEASE`, `RELEASED`, `CANCELLED`, `IN_USE`, `USED`, `EXPIRED`.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","type":"collection"}},"urlObject":{"path":["loyaltyProgram","customerReport",":document"],"host":["{{url}}"],"query":[{"key":"limit","value":"20"},{"key":"offset","value":"0"}],"variable":[{"type":"any","value":"65009076077","key":"document"}]}},"response":[],"_postman_id":"b0e1e120-c5c0-4937-b476-b4afe7c71f11"},{"name":"Conceder Cashback por Pedido Externo","id":"2439f2d9-8b97-43b8-a57e-fa84a841c523","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{access_token}}","description":"

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"cpfCnpj\": \"11122233344\",\n \"email\": \"cliente@exemplo.com.br\",\n \"externalOrderId\": \"PED-EXT-001\",\n \"status\": \"RELEASED\",\n \"orderItems\": [\n {\n \"documentPartner\": \"11222333000144\",\n \"skuId\": 123456,\n \"deliveryDate\": \"2025-10-20\",\n \"quantity\": 1,\n \"unitaryValue\": 250.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/loyaltyProgram/earnRewardExternal","description":"

Descrição

Adiciona cashback para um cliente com base em um pedido realizado externamente à plataforma CWS.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`cpfCnpj`	`string`	Sim	Documento do cliente que receberá o cashback.
`email`	`string`	Sim	Email do cliente.
`externalOrderId`	`string`	Sim	ID do pedido no seu sistema externo.
`status`	`string`	Sim	Status inicial do cashback: `TO_RELEASE` ou `RELEASED`.
`orderItems`	`array`	Sim	Lista de itens do pedido.

Dentro de cada objeto orderItems:

documentPartner (string): CNPJ da sua loja.
skuId (integer): ID do produto na CWS.
deliveryDate (string): Data da entrega (YYYY-MM-DD).
quantity (integer): Quantidade do item.
unitaryValue (number): Valor unitário do item.

access_token retornado na resposta do serviço 1.1 - autenticar

\n"}],"body":{"mode":"raw","raw":"{\n \"documentPartner\":\"11222333000144\",\n \"earning\": 15.50,\n \"orderDeliveryDate\": \"2025-10-22\",\n \"status\": \"RELEASED\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/loyaltyProgram/earnRewardExternal?externalOrderId=PED-EXT-001","description":"

Descrição

Atualiza o status, valor ou data de um cashback concedido por um pedido externo.

Parâmetros de Consulta (Query)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`externalOrderId`	`string`	Sim	ID do pedido externo a ser atualizado.

Corpo da Requisição (JSON)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parâmetro	Tipo	Obrigatório	Descrição
`documentPartner`	`string`	Sim	CNPJ da sua loja.
`status`	`string`	Sim	Novo status do cashback (`RELEASED`, `CANCELLED`, etc).
`earning`	`number`	Não	Novo valor do cashback.
`orderDeliveryDate`	`string`	Não	Nova data de entrega do pedido (`YYYY-MM-DD`).

Endpoints para consulta de saldos e gerenciamento de cashback de clientes.

\n","_postman_id":"79397e3b-9069-42d6-b998-8b4f6c437645","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]},"isInherited":true,"source":{"_postman_id":"50f0524e-205e-4b92-a12e-be9686666536","id":"50f0524e-205e-4b92-a12e-be9686666536","name":"WS - CWS","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":"7260cbcc-af4c-42c5-9e9d-6620b813dfdb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Visão Geral da Autenticação

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.).

A resposta do seu endpoint de token deve seguir o padrão OAuth2:

{\n    \"access_token\": \"SEU_TOKEN_GERADO\",\n    \"expires_in\": 3600\n}\n

Abaixo estão três exemplos reais de como seu endpoint de token pode ser configurado.

Exemplo 1: Fluxo `client_credentials` com Basic Auth

Como 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:

curl --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'\n

Exemplo 2: Fluxo com `clientId` e `clientSecret` no Body

Como funciona: Suas credenciais são enviadas diretamente no corpo (body) da requisição em formato JSON.

Requisição que a CWS fará para seu endpoint de token:

curl --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}'\n

Exemplo 3: Autenticação com Token Estático no Corpo

Este 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.

Requisição que a CWS fará para seu endpoint de Cálculo de Impostos:

curl --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}'\n

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"c8ba0b33-0726-4b19-b384-aad5ed6f4a9d","id":"c8ba0b33-0726-4b19-b384-aad5ed6f4a9d","name":"Cálculo de Impostos (Síncrono)","type":"folder"}},"urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"7260cbcc-af4c-42c5-9e9d-6620b813dfdb"},{"name":"[EXEMPLO] Requisição de Cálculo de Impostos","id":"26e1f8af-a0e2-4656-8327-fa3dfa60bff4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"tenantId","value":"01,04160001"},{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer [TOKEN_OBTIDO_DO_SEU_SISTEMA]"}],"body":{"mode":"raw","raw":"{\n \"cliente\": \"03.558.351/0001-00\",\n \"empresa\": \"12.377.080/0001-88\",\n \"finalidade\": 4,\n \"itens\": [\n {\n \"item\": \"123456\",\n \"partner_part_code\": \"FO0002248281\",\n \"pre_unit\": \"451.99\",\n \"qtde\": \"45\"\n },\n {\n \"item\": \"7891011\",\n \"partner_part_code\": \"FO0002248279\",\n \"pre_unit\": \"654.99\",\n \"qtde\": \"5\"\n }\n ],\n \"num_pedido\": \"0\",\n \"uf\": \"ES\",\n \"valor_frete\": 0,\n \"valor_pedido\": 23664.05\n}","options":{"raw":{"language":"json"}}},"url":"https://api.exemplo-cliente.com.br/wscwstax/calcular","description":"

Descrição

Este é um exemplo completo da requisição que a CWS enviará para o seu endpoint de Cálculo de Impostos.

Estrutura da Resposta Esperada

Seu 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}\n

\n","urlObject":{"protocol":"https","path":["wscwstax","calcular"],"host":["api","exemplo-cliente","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"26e1f8af-a0e2-4656-8327-fa3dfa60bff4"}],"id":"c8ba0b33-0726-4b19-b384-aad5ed6f4a9d","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"e40b13a3-cb7f-4c3b-be1e-bd9b4afbd3ea","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"621b0a5e-5561-456a-ac26-5254cc1f205e","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"c8ba0b33-0726-4b19-b384-aad5ed6f4a9d","description":""},{"name":"Webhooks (Assíncrono)","item":[{"name":"[DOC] Autenticação (O que sua loja precisa fornecer)","id":"940f07b8-b5ae-4f05-8a36-1cb49ad8032b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"

Visão Geral da Autenticação

Para 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.

Você deve nos fornecer os detalhes do seu endpoint de autenticação para que possamos configurá-lo.

Estrutura do Endpoint de Token (Sua Responsabilidade)

Você 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}\n

Abaixo estão três exemplos reais de como seu endpoint de token pode ser configurado.

Exemplo 1: Fluxo `client_credentials` com Basic Auth

Como 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:

curl --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'\n

Exemplo 2: Fluxo com `clientId` e `clientSecret` no Body

Como funciona: Suas credenciais são enviadas diretamente no corpo (body) da requisição em formato JSON.

Requisição que a CWS fará para seu endpoint de token:

curl --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}'\n

Exemplo 3: Fluxo com Credenciais em Headers Customizados

Como 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:

curl --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'\n

Este é 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.

\n","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","name":"13 - Callbacks e Webhooks","type":"folder"}},"urlObject":{"protocol":"https","path":["webhook","pedido"],"host":["api","exemplo-cliente","com","br"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf164eee-831b-4171-a9cf-817280c3007b"},{"name":"[EXEMPLO] Payload de Webhook de Pedidos (Completo)","id":"f075e17d-147d-4281-8d66-1aabdf736a46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer [TOKEN_OBTIDO_DO_SEU_SISTEMA]"}],"body":{"mode":"raw","raw":"{\n \"id\": 505676,\n \"status\": \"CANCELED\",\n \"subTotal\": \"R$90.07\",\n \"total\": \"R$90.07\",\n \"dateCreated\": \"2024-04-08 13:33:27.0\",\n \"lastUpdated\": \"2024-04-08 13:35:42.0\",\n \"customer\": {\n \"id\": 1637173,\n \"name\": \"usuario teste CWS\",\n \"email\": \"usuarioteste@cws.digital\",\n \"phone\": \"(11) 98988-8888\",\n \"type\": \"pf\",\n \"document\": \"720.953.820-80\"\n },\n \"seller\": {\n \"id\": 6255,\n \"name\": \"Filial 1 Loja Exemplo Teste\",\n \"document\": \"78.861.562/0001-17\"\n },\n \"deliveries\": [\n {\n \"freight\": {\n \"name\": \"Retirada na Loja\",\n \"total\": \"R$0.00\",\n \"type\": \"PICKUP_IN_STORE\"\n },\n \"products\": [\n {\n \"id\": 10204964,\n \"name\": \"Perfil Alumínio Puxador M02 Azul Petróleo 18mm\",\n \"mfrPartCode\": \"LM-9551034002\",\n \"quantity\": 1,\n \"price\": 97.9,\n \"partnerPartCode\": \"5090805\",\n \"brand\": {\n \"id\": 40329,\n \"name\": \"Leo\"\n }\n }\n ]\n }\n ],\n \"payments\": [\n {\n \"id\": 305665,\n \"gateway\": \"BRASPAG\",\n \"paymentInstallments\": 1,\n \"paymentInstallmentsValue\": \"R$90.07\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.exemplo-cliente.com.br/webhook/pedido-completo","description":"

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":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","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":"f075e17d-147d-4281-8d66-1aabdf736a46"},{"name":"[EXEMPLO] Payload de Webhook de Clientes","id":"2c6751fd-759a-47bb-81ae-2069c197f5c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer [TOKEN_OBTIDO_DO_SEU_SISTEMA]"}],"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.

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":"6f0e3462-3675-4aca-8ece-4eaf542c62f2","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","name":"13 - Callbacks e Webhooks","type":"folder"}}}],"id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147","description":"

Descrição

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.

Existem dois tipos de comunicação iniciada pela CWS:

Síncronas (Callbacks): A CWS faz uma chamada e aguarda uma resposta imediata para continuar um processo. Ex: Cálculo de Impostos.
\n
Assí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

\n","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"1236ed93-2e84-4a08-8484-bd9dfb99a0f9","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7ce0504b-d94f-4796-9937-e5ee1e790ac3","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"57b0bd27-9fe0-4cd0-8fef-01fa194bb147"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{authorization_secret}}"}]}},"event":[{"listen":"prerequest","script":{"id":"2fd5b39a-b12f-4616-be24-8d128edd1d75","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"6bcd62b3-dab7-419f-86cc-f55119bf95d7","type":"text/javascript","requests":{},"exec":[""]}}]}

Bem-vindo à API da CWS!

Descrição

Corpo da Requisição (Form-URL-Encoded)

Estrutura da Resposta (200 OK)

Descrição

Corpo da Requisição (JSON)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Resposta (202 Accepted)

Descrição

Parâmetros de Rota (Path)

Resposta (202 Accepted)

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Consulta (Query)

Estrutura da Resposta (200 OK)

Descrição

Descrição

Parâmetros de Rota (Path)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Descrição

Parâmetros de Rota (Path)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Estrutura da Resposta (200 OK)

Descrição

Descrição

Parâmetros da Rota (Path)

Corpo da Requisição (JSON)

Descrição

Parâmetros de Rota (Path)

Estrutura da Resposta (200 OK)

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (form-data)

Descrição

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Validações (retornam 422; nada é gravado)

Resposta

Descrição

Parâmetros de Rota (Path)

Corpo da Requisição (JSON)

Validações (retornam 422; nada é gravado)

Resposta

Observação (Marketplace)

Descrição

Parâmetros de Rota (Path)

Resposta

Descrição

Parâmetros de Rota (Path)

Resposta

Observação (Marketplace)

Descrição

Parâmetros de Rota (Path)

Descrição

Parâmetros de Rota (Path)

Observação (Marketplace)

Descrição

Parâmetros de Rota (Path)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Resposta (`202 Accepted`)

Resposta (`202 Accepted`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Validações (retornam `422`; nada é gravado)

Validações (retornam `422`; nada é gravado)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`201 Created`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`201 Created`)

Resposta (`200 OK`)

Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Estrutura da Resposta (`200 OK`)

Resposta (`202 Accepted`)

Estrutura da Resposta (`200 OK`)