Histórico de Volumes Entregues

Descrição: Retorna o histórico de volumes entregues de uma negociação, incluindo volume negociado, volume entregue consolidado e a lista de eventos de entrega.

Endpoint

GET/api/v1/integration/order-commitments/{order_commitment_id}/delivered-volume-history

Regras

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

Exemplo de Requisição

cURL

curl -X GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/order-commitments/{order_commitment_id}/delivered-volume-history"

Java

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

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/order-commitments/{order_commitment_id}/delivered-volume-history"))
    .header("Authorization", "{SUA_API_KEY}")
    .GET()
    .build();

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

JavaScript

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/order-commitments/{order_commitment_id}/delivered-volume-history',
  {
    method: 'GET',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
const data = await response.json();
console.log(data);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/order-commitments/{order_commitment_id}/delivered-volume-history"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

response = requests.get(url, headers=headers)
print(response.json())

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import java.util.UUID;

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

var history = merx.orderCommitments()
    .findDeliveredVolumeHistory(UUID.fromString("00000000-0000-0000-0000-000000000000"))
    .orElseThrow();

Parâmetros

Parâmetros de Cabeçalho

Nome	Descrição	Tipo	Obrigatório
Authorization		String	Sim

Respostas

• 200 - Ok

{
  "id": "b3290cf1-9aca-41f1-a1ce-db3b398e1831",
  "fixed_amount": 100.00,
  "delivered_volume": 75.50,
  "product": "Soja",
  "harvest": "2025/2026",
  "unit_of_measurement_code": "SC",
  "events": [
    {
      "id": "a1b2c3d4-1234-5678-9abc-def012345678",
      "original_delivered_volume": 25.50,
      "commitment_delivered_volume": 25.50,
      "original_unit_of_measurement_code": "SC",
      "origin": "INTEGRATION",
      "delivery_mode": "PARTIAL",
      "created_at": 1775842200.000000
    },
    {
      "id": "b2c3d4e5-2345-6789-abcd-ef0123456789",
      "original_delivered_volume": 50.00,
      "commitment_delivered_volume": 50.00,
      "original_unit_of_measurement_code": "SC",
      "origin": "INTEGRATION",
      "delivery_mode": "PARTIAL",
      "created_at": 1776255300.000000
    }
  ]
}

Atributos da Resposta

Nome	Descrição	Tipo
id	Identificador da negociação	UUID
fixed_amount	Volume negociado da negociação	Number
delivered_volume	Volume entregue consolidado até o momento	Number
product	Produto da negociação	String
harvest	Safra da negociação	String
unit_of_measurement_code	Unidade de medida da negociação (SC, KG, TON)	String
events	Lista de eventos de atualização do volume entregue	Array

Atributos de cada Evento

Nome	Descrição	Tipo
id	Identificador do evento	UUID
original_delivered_volume	Volume entregue informado na requisição original	Number
commitment_delivered_volume	Volume entregue convertido para a unidade de medida da negociação	Number
original_unit_of_measurement_code	Unidade de medida informada na requisição original	String
origin	Origem do evento (ex.: INTEGRATION)	String
delivery_mode	Modo de entrega do evento (FULL ou PARTIAL)	String
created_at	Data e hora em que o evento foi registrado, em epoch (segundos decimais). Ex.: 1775842200.000000	Number

• 400 - Bad Request

{
    "timestamp": "string (date-time)",
    "status": "integer (int32)",
    "error": "string",
    "message": "string"
}

• 401 - Unauthorized

• 404 - Not Found

Negociação não encontrada.