Pular para o conteúdo principal

Criar Código ERP

Descrição: Integra ERP ao produtor.

Endpoint​

POST/api/v1/integration/producers/{producer_id}/erp

Regras​

AtributosDescriçãoTipoObrigatórioValidações
producer_idIdentificador da Companhia ProdutoraStringSim
erp_codesLista de códigos ERPArraySimNão há validação de Bean Validation, mas omitir a lista resulta em 500: o serviço percorre erp_codes sem checar nulo e estoura. Para não criar nenhum código, envie a lista vazia ("erp_codes": []), que passa sem erro.
idIdentificador do código ERPStringNãoNão validado em runtime: a lista erp_codes não é anotada com @Valid, então as restrições dos itens não são aplicadas.
descriptionDescrição do identificador ERPStringNãoNão validado em runtime: a lista erp_codes não é anotada com @Valid, então o limite de 255 caracteres não é aplicado.

Exemplo de Requisição​

curl -X POST \
-H "Authorization: {SUA_API_KEY}" \
-H "Content-Type: application/json" \
-d '{
"erp_codes": [
{
"id": "777",
"description": "Código ERP principal"
},
{
"id": "888",
"description": "Código ERP secundário"
}
]
}' \
"https://api.merx.tech/api/v1/integration/producers/{producer_id}/erp"

Parâmetros​

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
erp_codesLista de códigos ERPArraySim
erp_codes[].idIdentificador do código ERPStringNão
erp_codes[].descriptionDescrição do código ERPStringNão

Respostas​

  • 204 - No Content

  • 400 - Bad Request

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

  • 500 - Internal Server Error

Devolvido quando o corpo não traz a chave erp_codes. O serviço percorre a lista sem checar nulo:

{
"messages": ["message.internal.error"]
}