Referência da API
Contratos
Endpoints para gerenciar contratos de preço fixo para clientes ou grupos de clientes.
Gestão loja
-
Cria um contrato de preço: a tabela de preços especiais que a loja aplica a um conjunto de clientes durante um período. A criação grava o cabeçalho do contrato, vigência, abrangência e filtros de aplicação. Os clientes e os produtos entram depois, por Adicionar Clientes ao Contrato e Adicionar Produtos ao Contrato.
-
Atualiza parte do cabeçalho de um contrato: status, vigência, abrangência e filtros de aplicação. É uma atualização parcial, envie só os campos que quer mudar, e ao menos um deles.
-
Lista os contratos de preço da sua loja, do mais recente para o mais antigo, com paginação.
-
Adiciona clientes a um contrato, pelo documento de cada um. Os clientes passam a receber os preços do contrato.
-
Remove clientes de um contrato, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.
-
Adiciona produtos ao contrato com o preço de cada um, ou atualiza o preço dos que já estão nele. Cada produto é processado de forma independente: o resultado de cada um vem no campo status da resposta.
-
Remove produtos do contrato. Os produtos voltam a ser vendidos pelo preço de tabela da loja.
Gestão Matriz
-
Permite que uma conta matriz crie um contrato de preço em uma de suas filiais. A criação grava o cabeçalho do contrato, vigência, abrangência e filtros de aplicação. Os clientes e os produtos entram depois, por Adicionar Clientes ao Contrato da Filial e Adicionar Produtos ao Contrato da Filial.
-
Permite que uma conta matriz atualize parte do cabeçalho de um contrato de uma de suas filiais: status, vigência, abrangência e filtros de aplicação. É uma atualização parcial, envie só os campos que quer mudar, e ao menos um deles.
-
Permite que uma conta matriz liste os contratos de preço de uma de suas filiais, do mais recente para o mais antigo, com paginação.
- PUT Adicionar Clientes ao Contrato da Filial
/pricing/contract/:contractId/customers/store/:partnerIdPermite que uma conta matriz adicione clientes a um contrato de uma de suas filiais, pelo documento de cada um. Os clientes passam a receber os preços do contrato.
- DELETE Remover Clientes do Contrato da Filial
/pricing/contract/:contractId/customers/store/:partnerIdPermite que uma conta matriz remova clientes de um contrato de uma de suas filiais, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.
-
Permite que uma conta matriz adicione produtos ao contrato de uma de suas filiais com o preço de cada um, ou atualize o preço dos que já estão nele. Cada produto é processado de forma independente: o resultado de cada um vem no campo status da resposta.
-
Permite que uma conta matriz remova produtos do contrato de uma de suas filiais. Os produtos voltam a ser vendidos pelo preço de tabela da filial.
Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.