Atualiza as configurações de registro individual

Este endpoint é responsável por atualizar dados cadastrais de registros individuais. Importante ele atualiza por lista, então atente-se a atualizar a lista toda. Exemplo no caso de uso.

Método: PUT

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/supplierConfiguration/supplierIndividualRegister

Requisição e Tipos de Dados

Tipo de Conteúdo da Requisição: application/json

Corpo da Requisição:

Para atualizar o registro individual do fornecedor, devemos informar a requisição abaixo:

{
  "items": [
    {
      "state": "string",
      "code": "string"
    }
  ]
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo	Obrigatoriedade
items	Objeto da requisição	object	Required
state	Estado (SEMPRE 2 CHAR)	string	Required
code	Código do registro	string	Required

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição	Observação	Corpo da resposta
200	Sucesso na operação, mas não tem corpo de resposta	Retorna em qualquer tipo de requisição com sucesso	Sim
400	Bad Request: Erro de validação ou processamento da requisição.	Verifique o corpo da requisição.	Sim
401	Unauthorized: Autenticação necessária e não fornecida.	Verifique seu ClientId, ClientSecret e o Token enviado	Não
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.	Verifique suas configurações de rede ou VPN	Não
502	Bad Gateway: indica que ele, enquanto atuando como um servidor intermediário, recebeu uma resposta inválida do servidor para o qual a requisição foi encaminhada	Verifique sua requisição	Não

Exemplos de Respostas:

• Erro (400):

{
  "statusCode": 0,
  "message": "string",
  "errors": {
    "additionalProp1": ["string"],
    "additionalProp2": ["string"],
    "additionalProp3": ["string"]
  }
}

Cómo Testar o Endpoint

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

1. Abra o Postman.

2. Selecione o método PUT e insira a URL do endpoint.

3. No corpo da requisição, insira o JSON do exemplo fornecido.

4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.

Casos de uso

1. Pensando que o fornecedor, já possui seus registros individuais inseridos via portal do parceiro, vamos atualizar.

• Buscamos os Registros individuais no endpoint. GET: supplierConfiguration/supplierIndividualRegister

Agora estruture o request com toda a lista, e atualize o valor desejado.

Nesse caso mudou o valor de code de 1 para 2 do state “BA”

• Buscamos novamente os Registros individuais no endpoint. GET: supplierConfiguration/supplierIndividualRegister

2. Situação de atenção, se não mandar a lista toda, de registros já salvos, ele irá apagar. Segue exemplo

• Buscamos os Registros individuais no endpoint. GET: supplierConfiguration/supplierIndividualRegister

Alterei a request, mandando apenas o estado de São Paulo

• Buscamos novamente os Registros individuais no endpoint. GET: supplierConfiguration/supplierIndividualRegister

Repare, que ele apagou o estado BA, pois ele sempre irá considerar a lista.

3. Mandando apenas um carácter no valor do campo state. Ele aceita apenas 2 caracteres.