Pular para o conteúdo principal

Atualizar os dados de endereço de uma Companhia Produtora

Descrição: Atualiza os dados de endereço de uma Companhia Produtora.

Endpoint​

PUT/api/v1/integration/producers/{producer_id}/address

Regras​

AtributosDescriçãoTipoObrigatórioValidações
producer_idIdentificador da Companhia ProdutoraUUIDSim-
streetRuaStringSimCampo de preenchimento obrigatório. Até 255 caracteres.
numberNúmeroStringSimCampo de preenchimento obrigatório. Aceita texto livre (ex: S/N), até 10 caracteres.
complementComplementoStringNãoCampo opcional. Até 100 caracteres.
neighborhoodBairroStringSimCampo de preenchimento obrigatório. Até 100 caracteres.
zip_codeCEPStringSimCampo 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.
cityCidadeStringSimCampo de preenchimento obrigatório. Até 100 caracteres.
stateEstadoStringSimCampo de preenchimento obrigatório. Sigla da UF, até 2 caracteres (ex: MT).
countryPaísStringSimCampo de preenchimento obrigatório. Até 50 caracteres.
address_typeTipo do endereçoStringNãoCampo livre, sem validação pela API (ex: PRODUCER).

Exemplo de Requisição​

curl -X PUT \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"street": "Rua das Palmeiras",
"number": "456",
"complement": "Apto 2",
"neighborhood": "Jardim Europa",
"zip_code": "78890-000",
"city": "Sorriso",
"state": "MT",
"country": "Brasil"
}' \
"https://api.merx.tech/api/v1/integration/producers/{PRODUCER_ID}/address"

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

Respostas​

  • 204 - No Content

  • 400 - Bad Request

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

  • 404 - NotFound