Pular para o conteúdo
platform
PT EN

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

Remover Clientes do Contrato

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

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

Descrição

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

Envie de 1 a 100 documentos por requisição. Os que não estiverem no contrato voltam em notFound, sem impedir os demais.

Parâmetros de Rota

Parâmetro Tipo Obrigatório Descrição
contractId integer Sim Id do contrato, devolvido em id na criação.

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 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 loja do token: {"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.

Exemplo de requisição

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

Respostas de exemplo

200Sucesso: cliente removido

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

Usado em

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

Endpoints relacionados

← Ver o grupo: Contratos

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