Listar os documentos de uma negociação

Descrição: Endpoint para retornar os documentos anexados (sem signatários) de uma negociação através do ID da negociação.

Endpoint

GET/api/v1/integration/order-commitments/{commitment_id}/documents

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 GET \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}/documents"

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/{commitment_id}/documents"))
    .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/{commitment_id}/documents',
  {
    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/{commitment_id}/documents"

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 documents = merx.orderCommitments().findDocuments(UUID.fromString("00000000-0000-0000-0000-000000000000"));

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

Respostas

• 200 - Ok

[
    {
        "filename": "documento1.pdf",
        "file_url": "https://<bucket>.s3.amazonaws.com/order-commitments/<order_commitment_id>/documents/<document_id>/documento1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<credencial>&X-Amz-Date=<data>&X-Amz-Expires=60&X-Amz-SignedHeaders=host&X-Amz-Signature=<assinatura>"
    },
    {
        "filename": "documento2.pdf",
        "file_url": "https://<bucket>.s3.amazonaws.com/order-commitments/<order_commitment_id>/documents/<document_id>/documento2.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<credencial>&X-Amz-Date=<data>&X-Amz-Expires=60&X-Amz-SignedHeaders=host&X-Amz-Signature=<assinatura>"
    }
]

O endpoint devolve sempre um array — vazio quando a negociação não tem documentos anexados. Cada item traz apenas filename e file_url; a URL é pré-assinada do S3 e expira em cerca de um minuto, então baixe o arquivo logo após a consulta em vez de guardar o link.

• 400 - Bad Request

Retornado quando o identificador informado no caminho não é um UUID válido. Nesse caso o corpo segue o formato padrão de erro de conversão de parâmetro:

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

• 401 - Unauthorized