Atualização Volumes Entregues

Descrição: Atualiza o volume entregue de uma negociação.

Endpoint

POST/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
commitment_id	Identificador da negociação na plataforma Merx.	UUID	Sim

Exemplo de Requisição

cURL

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "total_delivered": 1000.00,
    "unit_of_measurement": "SC",
    "delivery_mode": "FULL"
  }' \
  "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume"

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

String body = "{\"total_delivered\": 1000.00, \"unit_of_measurement\": \"SC\", \"delivery_mode\": \"FULL\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .build();

HttpClient client = HttpClient.newHttpClient();
try {
    HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.statusCode());
} catch (Exception e) {
    e.printStackTrace();
}

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      total_delivered: 1000.00,
      unit_of_measurement: 'SC',
      delivery_mode: 'FULL',
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:deliveredVolume"

headers = {
    "Authorization": "{SUA_API_KEY}",
    "Content-Type": "application/json"
}

payload = {
    "total_delivered": 1000.00,
    "unit_of_measurement": "SC",
    "delivery_mode": "FULL"
}

response = requests.post(url, json=payload, headers=headers)
print(response.status_code)

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.order.commitment.DeliveredVolumeRequest;
import java.util.UUID;
import java.math.BigDecimal;

MerxClient merx = MerxClient.builder()
    .apiKey("{SUA_API_KEY}")
    .environment(Environment.SANDBOX)
    .build();

merx.orderCommitments().updateDeliveredVolume(UUID.fromString("00000000-0000-0000-0000-000000000000"), DeliveredVolumeRequest.builder()
    .totalDelivered(new BigDecimal("100"))
    .unitOfMeasurement("KG")
    .build());

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization	Chave de API obtida via support-api@merx.tech	String	Sim
Content-Type	application/json	String	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório	Validações
total_delivered	Volume entregue	Number	Sim	Valor decimal estritamente positivo, com no máximo 13 dígitos inteiros e 2 casas decimais
unit_of_measurement	Unidade de medida	String	Sim	Apenas obrigatoriedade de preenchimento. A API não valida os valores contra uma lista fixa — use SC, KG ou TON
delivery_mode	Modo de Entrega. FULL substitui o volume entregue; PARTIAL incrementa.	Enum	Não	FULL, PARTIAL. Omitir equivale a FULL, ou seja, o volume informado substitui o total entregue da negociação. Atenção: o endpoint Registrar Entrega alimenta o mesmo total e tem o default oposto, PARTIAL

Respostas

• 204 - No content

• 400 - Bad Request

{
  "messages": ["message.entidade.campo-inválido"]
}

• 401 - Unauthorized