Remover itens

DELETE /api/v1/valepix/distributions/{distribution_id}/items

Remove um ou mais colaboradores de uma distribuição no estado draft.

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
employee_ids	array	Sim	IDs dos colaboradores a remover

Exemplo curl

curl --request DELETE \
  --url "https://routes.valepix.com.br/api/v1/valepix/distributions/$DISTRIBUTION_ID/items" \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --data "{
    \"employee_ids\": [
      \"$EMPLOYEE_ID\"
    ]
  }"

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "removed_count": 1
  }
}

Validações importantes

• A distribuição precisa estar em draft.
• Os colaboradores precisam estar incluídos na distribuição.
• Os totais são recalculados após a remoção e seus campos são omitidos quando o valor resultante é zero.
• Em uma lista mista, IDs que não estão no rascunho são ignorados e os itens encontrados são removidos.

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 não encontrada	Conferir o distribution_id
422	Lista vazia, distribuição fora de draft ou nenhum item encontrado para remover	Consultar os itens e revisar a lista
429	Limite de chamadas excedido	Reduzir a taxa de chamadas e aplicar backoff
500, 502, 503, 504	Falha temporária	Tentar novamente com backoff

Repetir a remoção da mesma lista retorna 422. Consulte os itens antes de repetir após timeout.