Pular para o conteúdo principal

Atualizar valor em lote

PUT /api/v1/valepix/distributions/{distribution_id}/items/value

Define o valor de um produto para todos os colaboradores da distribuição.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

ParâmetroTipoObrigatórioDescrição
distribution_idstringSimIdentificador da distribuição em draft

Body

CampoTipoObrigatórioDescrição
product_idstringSimCampo id retornado por Listar produtos
valueintegerSimNovo valor em centavos, maior ou igual a zero

Exemplo curl

curl --request PUT \
--url "https://routes.valepix.com.br/api/v1/valepix/distributions/$DISTRIBUTION_ID/items/value" \
--header "Authorization: Bearer $VALEPIX_API_TOKEN" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"product_id\": \"$PRODUCT_ID\",
\"value\": 50000
}"

Response

HTTP 200 OK.

{
"success": "success",
"data": {
"updated_count": 12,
"total_employees": 12,
"total_amount": 600000
}
}

Validações importantes

  • A distribuição precisa estar em draft.
  • Use um product_id retornado pela API.
  • value é um inteiro não negativo em centavos.

Erros comuns

HTTPQuando aconteceAção recomendada
400Identificador malformadoCorrigir os IDs enviados
401Token ausente, inválido, expirado ou revogadoConferir o header Authorization
403Token sem acesso ao recurso solicitadoConfirmar token com a ValePix
404Distribuição ou produto não encontradoUsar identificadores retornados pela API
422Valor negativo, distribuição fora de draft ou rascunho sem itensCorrigir o valor e consultar o estado antes de repetir
429Limite de chamadas excedidoReduzir a taxa de chamadas e aplicar backoff
500, 502, 503, 504Falha temporáriaTentar novamente com backoff