Configuração fornecedor obter endereço de retirada detalhado

Este endpoint é responsável por obter um local de forma de retirada específica de forma detalhada.

Método: GET

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

Requisição e Tipos de Dados

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

Corpo da Requisição:

Nesse endpoint é usado o clientId para identificar o fornecedor

Exemplo de Requisição:

https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/supplierConfiguration/pickUpLocationConfigureDetail?Id=1

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição	Observação	Corpo da resposta
200	Sucesso na operação	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:

• Sucesso (200):

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

• Exemplo 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"
  }
]

• 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 GET 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.