Pular para o conteúdo
platform
PT EN

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

Adicionar Clientes ao Contrato

Método
PUT
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

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

Envie de 1 a 100 documentos por requisição. Os que não forem localizados 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, como string. De 1 a 100 por requisição, com ao menos um preenchido.

Regras de negócio

Contrato de todos os clientes não recebe cliente avulso

Um contrato criado com allCustomers: true já vale para todos os clientes da loja e recusa a inclusão com 400 e priceContract.customers.addNotAllowed. Para montar uma lista de clientes, o contrato precisa estar com allCustomers: false.

Documento que não existe na base volta em notFound

O cliente precisa existir na plataforma, mas não precisa ter comprado da sua loja. O documento que não resolve não interrompe a requisição: ele volta em notFound.customers e os demais são gravados. A resposta é 200 mesmo quando nenhum documento resolveu.

Resposta · 200

Campo Descrição
id Id do contrato.
customers Documentos que foram vinculados ao contrato.
notFound.customers Documentos que você enviou e não foram localizados na plataforma.

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"}.
400 O contrato vale para todos os clientes e não aceita cliente avulso: {"error":"priceContract.customers.addNotAllowed"}.
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 PUT 'https://ws.autorei.net/pricing/contract/:contractId/customers' \
  --header 'Authorization: Bearer {{access_token}}' \
  --header 'Content-Type: application/json' \
  --data '{
  "customers": [
    "29893264000101",
    "70041364856"
  ]
}'

Respostas de exemplo

200Sucesso: um cliente vinculado e um não localizado

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

Usado em

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.