Skip to main content

Configuração fornecedor endereço de retirada

Este endpoint é responsável por configurar os locais de retirada do fornecedor.

Método: POST

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

Requisição e Tipos de Dados

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

Corpo da Requisição:

  1. storeName: Nome da loja.
  2. postalCode: CEP.
  3. state: Estado.
  4. city: Cidade.
  5. district: Bairro.
  6. number: Número.
  7. complement: Complemento.
  8. operations: Operação.
  9. operations.dayOfWeek: Dia da semana.
  10. operations.startTime: Horário inicial da loja.
  11. operations.endTime: Horário final da loja.

Exemplo de Requisição:


{
"storeName": "string",
"postalCode": "stringst",
"state": "st",
"city": "string",
"address": "string",
"district": "string",
"number": "string",
"complement": "string",
"operations": [
{
"dayOfWeek": "string",
"startTime": "string",
"endTime": "string"
}
]
}

Para a propriedade operations:


"operations": [
{
"dayOfWeek": "Monday",
"startTime": "11:00",
"endTime": "19:00"
},
{
"dayOfWeek": "Tuesday",
"startTime": "11:00",
"endTime": "19:00"
},
{
"dayOfWeek": "Wednesday",
"startTime": "11:00",
"endTime": "19:00"
},
{
"dayOfWeek": "Thursday",
"startTime": "11:00",
"endTime": "19:00"
},
{
"dayOfWeek": "Friday",
"startTime": "11:00",
"endTime": "19:00"
}
]

Possíveis Respostas

Códigos de Resposta e seus significados:

Status CodeDescrição
200Sucesso: A requisição foi bem-sucedida.
400Bad Request: Erro de validação ou processamento da requisição. Verifique o corpo da requisição.
401Unauthorized: Autenticação necessária e não fornecida.
403Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.
502Bad Gateway: O servidor, atuando como gateway ou proxy, recebeu uma resposta inválida do servidor upstream.

Exemplos de Respostas:

  • Sucesso (200):

{
"message": "string"
}

  • Erro (400):

{
"statusCode": 400,
"message": "Erro de validação.",
"errors": {
"additionalProp1": ["Erro específico 1"],
"additionalProp2": ["Erro específico 2"],
"additionalProp3": ["Erro específico 3"]
}
}

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 POST 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.