Referência da API · Contratos · Gestão Matriz

Remover Clientes do Contrato da Filial

Método: DELETE
Rota: /pricing/contract/:contractId/customers/store/:partnerId
URL base: https://ws.autorei.net
Parâmetros de rota: :contractId :partnerId
Token: Exige token Bearer

Abre esta requisição na documentação pública da API, a fonte oficial da referência.

Descrição

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.

O corpo e a resposta são idênticos aos da remoção na própria loja, a diferença é a filial dona do contrato, que vem na rota e é validada contra os vínculos da sua matriz.

Parâmetros de Rota

Parâmetro	Tipo	Obrigatório	Descrição
`contractId`	integer	Sim	Id do contrato, devolvido em `id` na criação.
`partnerId`	integer	Sim	Id da filial dona do contrato. Precisa estar vinculada à matriz do token.

Corpo da Requisição (JSON)

Campo	Tipo	Obrigatório	Descrição
`customers`	array	Sim	Documentos dos clientes a remover, como string. De 1 a 100 por requisição, com ao menos um preenchido.

Regras de negócio

Documento fora do contrato volta em `notFound`

O documento que não está vinculado ao contrato não interrompe a requisição: ele volta em notFound.customers e os demais são removidos. A resposta é 200 mesmo quando nenhum documento foi removido.

Para esvaziar a lista inteira de uma vez, use deleteAllCustomers em Atualizar Contrato.

Resposta · 200

Campo	Descrição
`id`	Id do contrato.
`customers`	Documentos que foram desvinculados do contrato.
`notFound.customers`	Documentos que você enviou e não estavam no contrato.

Erros

Código	Quando
400	`partnerId` da rota não é numérico: `{"error":"Invalid target partner ID"}`.
400	`contractId` da rota não é um número maior que zero: `{"error":"invalid contract id: \"...\""}`.
400	O corpo não é um JSON válido. O detalhe vem em `error`.
400	O contrato não existe ou não é da filial informada: `{"error":"priceContract.notFound"}`.
422	`customers` ausente, vazio, com mais de 100 entradas ou só com strings vazias. O detalhe vem em `error`.
401	Token ausente, malformado ou expirado: `{"error":"Authentication required for this route"}`.
403	A filial não está vinculada à sua matriz: `{"error":"Access denied: Invalid partnership"}`. Diferente de 400, aqui o payload está certo, o que falta é o vínculo.

Exemplo de requisição

curl --request DELETE 'https://ws.autorei.net/pricing/contract/:contractId/customers/store/:partnerId' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "customers": [
    "29893264000101"
  ]
}'

Respostas de exemplo

200Sucesso: cliente removido

{
  "id": 4610002,
  "customers": [
    "29893264000101"
  ],
  "notFound": {
    "customers": []
  }
}

Usado em

Este endpoint ainda não aparece em nenhum caso de uso publicado.

Endpoints relacionados

POST Criar Contrato da Filial /priceContract/store/:partnerId
PUT Atualizar Contrato da Filial /pricing/contract/:contractId/store/:partnerId
GET Listar Contratos da Filial /pricing/contract/list/store/:partnerId
PUT Adicionar Clientes ao Contrato da Filial /pricing/contract/:contractId/customers/store/:partnerId
PUT Adicionar Produtos ao Contrato da Filial /pricing/contract/:contractId/items/store/:partnerId
DELETE Remover Produtos do Contrato da Filial /pricing/contract/:contractId/items/store/:partnerId

← Ver o grupo: Contratos

Gerado a partir da coleção pública da API, publicada em 04/09/2026: api-docs.cws.digital.