Atualizar Identificador de Referência Externa

Descrição: Atualiza o identificador externo de uma negociação.

Endpoint

PUT/api/v1/integration/order-commitments/{commitment_id}:updateExternalReference

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
commitment_id	Identificador da negociação na plataforma Merx.	UUID	Sim	-
external_reference	Referência externa da negociação	String	Não	A API não valida este campo. O corpo da requisição não passa por validação, portanto um valor vazio, em branco ou ausente é aceito e gravado como está

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "external_reference": "ERP-REF-12345"
  }' \
  "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:updateExternalReference"

Java

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

String body = "{\"external_reference\": \"ERP-REF-12345\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:updateExternalReference"))
    .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/order-commitments/{commitment_id}:updateExternalReference',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      external_reference: 'ERP-REF-12345',
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/order-commitments/{commitment_id}:updateExternalReference"

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

payload = {
    "external_reference": "ERP-REF-12345"
}

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.commitment.UpdateOrderCommitmentExternalReferenceRequest;
import java.util.UUID;

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

merx.orderCommitments().updateExternalReference(UUID.fromString("00000000-0000-0000-0000-000000000000"), UpdateOrderCommitmentExternalReferenceRequest.builder()
    .externalReference("ERP-123")
    .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
commitment_id	Identificador da negociação na plataforma Merx.	UUID	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
external_reference	Referência externa da negociação	String	Não

Respostas

• 204 - No content

• 400 - Bad Request

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

• 401 - Unauthorized