Skip to main content

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

AtributosDescriçãoTipoObrigatórioValidações
commitment_idIdentificador da negociação na plataforma Merx.UUIDSim

Exemplo de Requisição

Exemplo de Requisição
curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json;charset=UTF-8"\
"https://homolog.api.merx.tech/api/v1/integration/order-commitments/a721162d-f573-4090-9e14-2f96bd3da202/documents"

Parâmetros

Parâmetros de Cabeçalho

NomeDescriçãoTipoObrigatório
AuthorizationStringSim

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
{
"timestamp": "string (date-time)",
"status": "integer (int32)",
"error": "string"
}
  • 401 - Unauthorized