Atualiza informações da loja do fornecedor

Este endpoint é responsável por atualizar informações da loja do fornecedor. Como estamos falando de um endpoint com o verbo patch, podemos atualizar as informações de forma individual.

Método: Patch

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

Requisição e Tipos de Dados

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

Corpo da Requisição:

Para criar os dados da loja do fornecedor, devemos informar a requisição abaixo:

Exemplo de Requisição:

{
  "storeUrl": "string",
  "aboutCompany": "string",
  "deliveryPolicy": "string",
  "returnPolicy": "string",
  "storeImageUrl": "string"
}

Descrição das propriedades:

Nome da propriedade	Descrição	Tipo	Obrigatoriedade
storeUrl	Url da sua loja personalizada na Orbia (https://orbia.ag/loja/SUA_MARCA)	object	nullable
aboutCompany	Sobre a Empresa (mínimo 200 char)	string	nullable
deliveryPolicy	Política de Entrega	string	nullable
returnPolicy	Política de Devolução	string	nullable
storeImageUrl	Hash do arquivo gerado pelo endpoint PostFile	string	nullable

Importante

A propriedade storeImageUrl receberá o HASH gerado pelo endpoint POST: orbia-marketplace-hub/v1/file. Será necessário fazer uma requisição para esse endpoint com o arquivo da imagem da loja do fornecedor no marketplace. Esse arquivo deve

• Extensão da imagem: JPG e PNG
• Tamanho mínimo da imagem: 512x512

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 PATCH 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. Vamos atualizar todas as informações de dados da loja do fornecedor.

• Primeiro vamos usar o POST: file para incluir a logo escolhida na estrutura.

• Agora vamos montar a requisição para atualizar os dados da loja com esse hash

2. Vamos atualizar apenas uma propriedade.

3. Enviar um HASH na storeImageUrl que está fora do padrão.

4. Enviars um HASH na storeImageUrl que já foi utilizado