Cadastrar um Armazém

Descrição: Cadastra um novo Armazém associado a uma Companhia Produtora.

Endpoint

POST/api/v1/integration/warehouses/-/producers/{producer_id}

Regras

Atributos	Descrição	Tipo	Obrigatório	Validações
producer_id	Identificador da Companhia Produtora	UUID	Sim	_
name	Nome	String	Sim	Campo de preenchimento obrigatório, até 255 caracteres.
document	CNPJ	String	Sim	Campo de preenchimento obrigatório. Deve ser um CNPJ válido: 14 caracteres, com dígitos verificadores corretos; pontuação é ignorada. CNPJ inválido é recusado com 400 `message.create-warehouse.document.invalid`. Não pode ser repetido o mesmo CNPJ para a Companhia Produtora
capacity	Capacidade	Number	Sim	Obrigatório. Deve ser maior ou igual a 0.0 e aceita até 8 dígitos inteiros e 2 dígitos decimais.
state_subscription	Inscrição estadual	String	Não	Se preenchido, deverá conter a inscrição e o Estado separados por hífen(-). Exemplo: 123456-MS
state_subscription_uf	UF da inscrição estadual	String	Não	Sigla do estado (ex: MS)
address_id	Identificador de endereço existente	UUID	Não	Ignorado. A API sempre cria um endereço novo a partir de `address` e sobrescreve este campo.
address.street	Rua	String	Sim	Campo de preenchimento obrigatório. Até 255 caracteres.
address.number	Numero	String	Sim	Campo de preenchimento obrigatório. Aceita texto livre (ex: `S/N`), até 10 caracteres.
address.complement	Complemento	String	Não	Campo opcional. Até 100 caracteres.
address.neighborhood	Bairro	String	Sim	Campo de preenchimento obrigatório. Até 100 caracteres.
address.zip_code	CEP	String	Sim	Campo de preenchimento obrigatório. Deve ter de 5 a 8 dígitos, opcionalmente seguidos de `-` e mais 3 dígitos (ex: `78890000` ou `78890-000`). Outros separadores são recusados com 400 `message.zipCode.invalid.format`.
address.city	Cidade	String	Sim	Campo de preenchimento obrigatório. Até 100 caracteres.
address.state	Estado	String	Sim	Campo de preenchimento obrigatório. Sigla da UF, até 2 caracteres (ex: `MT`).
address.country	Pais	String	Sim	Campo de preenchimento obrigatório. Até 50 caracteres.
address.address_type	Tipo do endereço	String	Não	Campo livre, sem validação pela API (ex: `WAREHOUSE`).

Exemplo de Requisição

cURL
Java
JavaScript
Python
SDK Java

curl -X POST \
  -H "Authorization: {SUA_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Armazém Central MT",
    "document": "12345678000195",
    "capacity": 5000.00,
    "state_subscription": "123456-MT",
    "state_subscription_uf": "MT",
    "address": {
      "street": "Av. das Indústrias",
      "number": "1000",
      "complement": "Galpão 3",
      "neighborhood": "Distrito Industrial",
      "zip_code": "78705-060",
      "city": "Sorriso",
      "state": "MT",
      "country": "Brasil"
    }
  }' \
  "https://api.merx.tech/api/v1/integration/warehouses/-/producers/{producer_id}"

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

String body = "{\"name\": \"Armazém Central MT\", \"document\": \"12345678000195\", \"capacity\": 5000.00, \"state_subscription\": \"123456-MT\", \"state_subscription_uf\": \"MT\", \"address\": {\"street\": \"Av. das Indústrias\", \"number\": \"1000\", \"complement\": \"Galpão 3\", \"neighborhood\": \"Distrito Industrial\", \"zip_code\": \"78705-060\", \"city\": \"Sorriso\", \"state\": \"MT\", \"country\": \"Brasil\"}}";

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.merx.tech/api/v1/integration/warehouses/-/producers/{producer_id}"))
    .header("Authorization", "{SUA_API_KEY}")
    .header("Content-Type", "application/json")
    .POST(HttpRequest.BodyPublishers.ofString(body))
    .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();
}

const response = await fetch(
  'https://api.merx.tech/api/v1/integration/warehouses/-/producers/{producer_id}',
  {
    method: 'POST',
    headers: {
      'Authorization': '{SUA_API_KEY}',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Armazém Central MT',
      document: '12345678000195',
      capacity: 5000.00,
      state_subscription: '123456-MT',
      state_subscription_uf: 'MT',
      address: {
        street: 'Av. das Indústrias',
        number: '1000',
        complement: 'Galpão 3',
        neighborhood: 'Distrito Industrial',
        zip_code: '78705-060',
        city: 'Sorriso',
        state: 'MT',
        country: 'Brasil',
      },
    }),
  }
);
const data = await response.json();
console.log(data);

import requests

url = "https://api.merx.tech/api/v1/integration/warehouses/-/producers/{producer_id}"

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

payload = {
    "name": "Armazém Central MT",
    "document": "12345678000195",
    "capacity": 5000.00,
    "state_subscription": "123456-MT",
    "state_subscription_uf": "MT",
    "address": {
        "street": "Av. das Indústrias",
        "number": "1000",
        "complement": "Galpão 3",
        "neighborhood": "Distrito Industrial",
        "zip_code": "78705-060",
        "city": "Sorriso",
        "state": "MT",
        "country": "Brasil"
    }
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())

import com.merx.sdk.api.MerxClient;
import com.merx.sdk.core.Environment;
import com.merx.sdk.model.baseline.warehouse.CreateWarehouseRequest;
import com.merx.sdk.model.common.IdResponse;
import java.util.UUID;
import java.math.BigDecimal;

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

IdResponse warehouse = merx.warehouses().create(UUID.fromString("00000000-0000-0000-0000-000000000000"), CreateWarehouseRequest.builder()
    .name("Armazem Central")
    .capacity(new BigDecimal("1000"))
    .build());
System.out.println(warehouse.getId());

Parâmetros

Parâmetros de Caminho:

Nome	Descrição	Tipo	Obrigatório
producer_id	Identificador da Companhia Produtora	UUID	Sim

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 do Corpo

Nome	Descrição	Tipo	Obrigatório
name	Nome	String	Sim
document	CNPJ	String	Sim
state_subscription	Inscrição estadual	String	Não
state_subscription_uf	UF da inscrição estadual	String	Não
address_id	Endereço existente (ignorado)	UUID	Não
capacity	Capacidade	Number	Sim
address.street	Rua	String	Sim
address.number	Numero	String	Sim
address.complement	Complemento	String	Não
address.neighborhood	Bairro	String	Sim
address.zip_code	CEP	String	Sim
address.city	Cidade	String	Sim
address.state	Estado	String	Sim
address.country	Pais	String	Sim
address.address_type	Tipo do endereço	String	Não

Respostas

200 - Ok

{
  "id": "string"
}

400 - Bad Request

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

401 - Unauthorized
404 - NotFound

Cadastrar um Armazém

Endpoint​

Regras​

Exemplo de Requisição​

Parâmetros​

Parâmetros de Caminho:​

Parâmetros de Cabeçalho​

Parâmetros do Corpo​

Respostas​

Endpoint

Regras

Exemplo de Requisição

Parâmetros

Parâmetros de Caminho:

Parâmetros de Cabeçalho

Parâmetros do Corpo

Respostas