Pular para o conteúdo principal

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

AtributosDescriçãoTipoObrigatórioValidações
producer_idIdentificador da Companhia ProdutoraUUIDSim_
nameNomeStringSimAté 250 caracteres.
documentCNPJStringSimAceita apenas números. Não pode ser repetido o mesmo CNPJ para a Companhia Produtora
capacityCapacidadeNumberSimApenas números. Aceita até 8 dígitos inteiros e 2 dígitos decimais
state_subscriptionInscrição estadualStringNãoSe preenchido, deverá conter a inscrição e o Estado separados por hífen(-). Exemplo: 123456-MS
state_subscription_ufUF da inscrição estadualStringNãoSigla do estado (ex: MS)
address.streetRuaStringSimAté 250 caracteres.
address.numberNumeroStringSimApenas números. Até 10 caracteres.
address.complementComplementoStringNãoAté 100 caracteres.
address.neighborhoodBairroStringSimAté 100 caracteres.
address.zip_codeCEPStringSimCEP com "-"
address.cityCidadeStringSimAté 100 caracteres.
address.stateEstadoStringSimAté 2 caracteres.
address.countryPaisStringSimAté 50 caracteres.

Exemplo de Requisição

curl -X POST \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"name": "Armazém Central MT",
"document": "12345678000190",
"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}"

Parâmetros

Parâmetros de Caminho:
NomeDescriçãoTipoObrigatório
producer_idIdentificador da Companhia ProdutoraStringSim
Parâmetros de Cabeçalho
NomeDescriçãoTipoObrigatório
AuthorizationChave de API obtida via support-api@merx.techStringSim
Content-Typeapplication/jsonStringSim
Parâmetros do Corpo
NomeDescriçãoTipoObrigatório
nameNomeStringSim
documentCNPJStringSim
state_subscriptionInscrição estadualStringNão
state_subscription_ufUF da inscrição estadualStringNão
capacityCapacidadeNumberSim
address.streetRuaStringSim
address.numberNumeroStringSim
address.complementComplementoStringNão
address.neighborhoodBairroStringSim
address.zip_codeCEPStringSim
address.cityCidadeStringSim
address.stateEstadoStringSim
address.countryPaisStringSim

Respostas

  • 200 - Ok
{
"id": "string"
}
  • 400 - Bad Request
{
"messages": ["message.entidade.campo-inválido"]
}
  • 401 - Unauthorized

  • 404 - NotFound