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())

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://merx-order-homolog.s3.amazonaws.com/order-commitments/a721162d-f573-4090-9e14-2f96bd3da202/documents/35d5a2bb-f106-465b-ae61-5da8f750d0dd/documento1.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251204T145954Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=AKIAWCPZAV7B7NF33ZFE%2F20251204%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=6d766575ba9a0da795539e9eb64105e4c4dd4dab094a1170e573994102e4c797"
    },
    {
        "filename": "documento2.pdf",
        "file_url": "https://merx-order-homolog.s3.amazonaws.com/order-commitments/a721162d-f573-4090-9e14-2f96bd3da202/documents/729ffa08-a53b-46fc-9ee2-d080887dbf93/documento2.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20251204T145954Z&X-Amz-SignedHeaders=host&X-Amz-Expires=59&X-Amz-Credential=AKIAWCPZAV7B7NF33ZFE%2F20251204%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2e92de0f6f3bfb83b9db7270a9937021a676aef14b60e54d8e6977c58becec10"
    }
]

• 400 - Bad Request

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

• 401 - Unauthorized