Atualizar Volume Alocado de Rastreabilidade

Descrição: Atualizar Volume Alocado de determinada Rastreabilidade.

Endpoint

PUT/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}:allocatedVolume

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
traceability_id	ID da Rastreabilidade	UUID	Sim
order_commitment_id	ID da Negociação	UUID	Sim

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "allocated_volume": 6.5,
    "user_id": "92489621-37f1-4ccf-8067-0241a5281a2d",
    "unit_of_measurement": "SC"
  }' \
  "https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}:allocatedVolume"

Java

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

String body = "{\"allocated_volume\": 6.5, \"user_id\": \"92489621-37f1-4ccf-8067-0241a5281a2d\", \"unit_of_measurement\": \"SC\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}:allocatedVolume"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .PUT(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/traceability/{traceability_id}/commitments/{order_commitment_id}:allocatedVolume',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      allocated_volume: 6.5,
      user_id: '92489621-37f1-4ccf-8067-0241a5281a2d',
      unit_of_measurement: 'SC',
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}:allocatedVolume"

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

payload = {
    "allocated_volume": 6.5,
    "user_id": "92489621-37f1-4ccf-8067-0241a5281a2d",
    "unit_of_measurement": "SC"
}

response = requests.put(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.traceability.TraceabilityUpdateRequest;
import java.util.UUID;
import java.math.BigDecimal;

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

UUID traceabilityId = UUID.fromString("00000000-0000-0000-0000-000000000000");
UUID commitmentId = UUID.fromString("00000000-0000-0000-0000-000000000000");
merx.traceability().updateAllocatedVolume(traceabilityId, commitmentId, TraceabilityUpdateRequest.builder()
    .allocatedVolume(new BigDecimal("60"))
    .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 de Caminho:

Nome	Descrição	Tipo	Obrigatório
traceability_id	ID da Rastreabilidade	UUID	Sim
order_commitment_id	ID da Negociação	UUID	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório	Validações
allocated_volume	Volume alocado desejado	Number	Sim	Valor decimal com no máximo 13 dígitos inteiros e 2 casas decimais, e estritamente positivo: zero ou negativo é rejeitado com message.allocated-volume.zero-or-under
unit_of_measurement	Unidade de medida do volume alocado. Padrão: TON	String	Não	Sem validação de valores: a API aceita qualquer string. Use SC, KG ou TON
user_id	Identificador do usuário	UUID	Não	-
origin	Origem da atualização de volume	String	Não	-
traceability_id	Identificador da rastreabilidade	UUID	Não	Aceito no corpo, mas ignorado: vale sempre o traceability_id informado no caminho

Respostas

• 204 - No Content

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound