Simular pedido
Este endpoint é responsável por simular um pedido e retornar a viabilidade do mesmo.
Método: POST
URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/order
Requisição e Tipos de Dados
Tipo de Conteúdo da Requisição: application/json
Corpo da Requisição: Para simular o pedido, devemos:
- CEP
- Informar quando o pedido será um pacote
- Itens do pedido
- Sku do produto
- Quantidade do produto
- Data da requisição
Exemplo de Requisição:
{
"postalCode": "stringst",
"marketplaceSupplierComboId": 0,
"items": [
{
"sku": "string",
"quantity": 0,
"requestedDate": "2024-05-06T21:10:49.323Z"
}
]
}
Possíveis Respostas
Códigos de Resposta e seus significados:
| Status Code | Descrição |
|---|---|
| 200 | Ok. |
| 400 | Bad Request: Erro de validação ou processamento da requisição. Verifique o corpo da requisição. |
| 401 | Unauthorized: Autenticação necessária e não fornecida. |
| 403 | Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação. |
| 502 | Bad Gateway. |
Exemplos de Respostas:
Sucesso (200):
{
"deliveryPrice": 0,
"orderTotal": 0
}
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:
-
Abra o Postman.
-
Selecione o método
POSTe insira a URL do endpoint. -
No corpo da requisição, insira o JSON do exemplo fornecido.
-
Envie a requisição e observe a resposta.
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.