Pular para o conteúdo
platform
PT EN

Referência da API

Contratos

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

Gestão loja

  • POST Criar Contrato /priceContract

    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.

  • PUT Atualizar Contrato /pricing/contract/:contractId

    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.

  • GET Listar Contratos /pricing/contract/list

    Lista os contratos de preço da sua loja, do mais recente para o mais antigo, com paginação.

  • PUT Adicionar Clientes ao Contrato /pricing/contract/:contractId/customers

    Adiciona clientes a um contrato, pelo documento de cada um. Os clientes passam a receber os preços do contrato.

  • DELETE Remover Clientes do Contrato /pricing/contract/:contractId/customers

    Remove clientes de um contrato, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.

  • PUT Adicionar Produtos ao Contrato /pricing/contract/:contractId/items

    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.

  • DELETE Remover Produtos do Contrato /pricing/contract/:contractId/items

    Remove produtos do contrato. Os produtos voltam a ser vendidos pelo preço de tabela da loja.

Gestão Matriz

  • POST Criar Contrato da Filial /priceContract/store/:partnerId

    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.

  • PUT Atualizar Contrato da Filial /pricing/contract/:contractId/store/:partnerId

    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.

  • GET Listar Contratos da Filial /pricing/contract/list/store/:partnerId

    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/:partnerId

    Permite 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/:partnerId

    Permite que uma conta matriz remova clientes de um contrato de uma de suas filiais, pelo documento de cada um. Os clientes deixam de receber os preços do contrato.

  • PUT Adicionar Produtos ao Contrato da Filial /pricing/contract/:contractId/items/store/:partnerId

    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.

  • DELETE Remover Produtos do Contrato da Filial /pricing/contract/:contractId/items/store/:partnerId

    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.