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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
distribution_id | string | Sim | Identificador da distribuição em draft |
Body
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
product_id | string | Sim | Campo id retornado por Listar produtos |
value | integer | Sim | Novo 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_idretornado pela API. valueé um inteiro não negativo em centavos.
Erros comuns
| HTTP | Quando acontece | Ação recomendada |
|---|---|---|
400 | Identificador malformado | Corrigir os IDs enviados |
401 | Token ausente, inválido, expirado ou revogado | Conferir o header Authorization |
403 | Token sem acesso ao recurso solicitado | Confirmar token com a ValePix |
404 | Distribuição ou produto não encontrado | Usar identificadores retornados pela API |
422 | Valor negativo, distribuição fora de draft ou rascunho sem itens | Corrigir o valor e consultar o estado antes de repetir |
429 | Limite de chamadas excedido | Reduzir a taxa de chamadas e aplicar backoff |
500, 502, 503, 504 | Falha temporária | Tentar novamente com backoff |