Cancelar Negociação por Identificador ERP

Descrição: Cancela uma negociação a partir do identificador ERP (internal_id).

Endpoint

PUT/api/v1/integration/order-commitments/-/internal-ids/{internal_id}:cancel

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
internal_id	Identificador da negociação no ERP do cliente.	String	Sim	-

Exemplo de Requisição

cURL

curl -X PUT \
  -H "Authorization: {SUA_API_KEY}" \
  "https://api.merx.tech/api/v1/integration/order-commitments/-/internal-ids/{internal_id}:cancel"

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/-/internal-ids/{internal_id}:cancel"))
    .header("Authorization", "{SUA_API_KEY}")
    .PUT(HttpRequest.BodyPublishers.noBody())
    .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/-/internal-ids/{internal_id}:cancel',
  {
    method: 'PUT',
    headers: {
      'Authorization': '{SUA_API_KEY}',
    },
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/order-commitments/-/internal-ids/{internal_id}:cancel"

headers = {
    "Authorization": "{SUA_API_KEY}",
}

response = requests.put(url, headers=headers)
print(response.status_code)

SDK Java

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;

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

merx.orderCommitments().cancelByInternalId("INTERNO-123");

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

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
internal_id	Identificador da negociação no ERP do cliente.	String	Sim

Respostas

• 204 - No content

• 400 - Bad Request

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

• 404 - Not Found

Nenhuma negociação encontrada para o internal_id (código do ERP) informado.

{
  "messages": ["message.erp-code.not-found"]
}

• 401 - Unauthorized