Listar os status de workflow de uma negociação

Descrição: Endpoint para retornar os status de workflow de uma negociação através do ID da negociação.

Endpoint

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

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}/workflow"

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

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 statuses = merx.orderCommitments().findWorkflowStatuses(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

{
    "id": "b3290cf1-9aca-41f1-a1ce-db3b398e1831",
    "order_commitment_id": "b3290cf1-9aca-41f1-a1ce-db3b398e1831",
    "compliance_status": "APPROVED",
    "commercial_status": "NEW",
    "contracts_status": "PENDING_REVIEW",
    "administrative_status": "NEW",
    "billing_status": "NEW",
    "compliance_updated_at": 1767020839.592396000,
    "commercial_updated_at": 1763745070.768766000,
    "administrative_updated_at": 1763745070.768766000,
    "contracts_updated_at": 1767044287.228973000,
    "billing_updated_at": 1763745070.768766000,
    "compliance_reviewed": false,
    "commercial_reviewed": false,
    "contracts_reviewed": true,
    "administrative_reviewed": false,
    "billing_reviewed": false
}

• 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