Deletar Rastreabilidade

Descrição: Deletar Rastreabilidade.

Endpoint

DELETE/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
traceability_id	ID da Rastreabilidade	UUID	Sim
order_commitment_id	ID da Negociação	UUID	Sim

Exemplo de Requisição

cURL

curl -X DELETE \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "excluir rastreio",
    "user_id": "e168db8c-4fa2-4728-9ec3-945207fa474c"
  }' \
  "https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}"

Java

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

String body = "{\"description\": \"excluir rastreio\", \"user_id\": \"e168db8c-4fa2-4728-9ec3-945207fa474c\"}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .method("DELETE", 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/traceability/{traceability_id}/commitments/{order_commitment_id}',
  {
    method: 'DELETE',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      description: 'excluir rastreio',
      user_id: 'e168db8c-4fa2-4728-9ec3-945207fa474c',
    }),
  }
);
console.log(response.status);

Python

import requests

url = "https://api.merx.tech/api/v1/integration/traceability/{traceability_id}/commitments/{order_commitment_id}"

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

payload = {
    "description": "excluir rastreio",
    "user_id": "e168db8c-4fa2-4728-9ec3-945207fa474c"
}

response = requests.delete(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.traceability.SoftDeleteTraceabilityRequest;
import java.util.UUID;

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

UUID traceabilityId = UUID.fromString("00000000-0000-0000-0000-000000000000");
UUID commitmentId = UUID.fromString("00000000-0000-0000-0000-000000000000");
merx.traceability().softDelete(traceabilityId, commitmentId, SoftDeleteTraceabilityRequest.builder()
    .description("Removido por correcao")
    .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

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
traceability_id	ID da Rastreabilidade	UUID	Sim
order_commitment_id	ID da Negociação	UUID	Sim

Parâmetros do Corpo

Nome	Descrição	Tipo	Obrigatório
description	Descrição	String	Não
user_id	Identificador do usuário	UUID	Sim

Respostas

• 204 - No Content

• 400 - Bad Request

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

• 401 - Unauthorized

• 404 - NotFound