Adicionar Pacote à fila de processamento

Este endpoint é responsável por incluir um pacote, para ser processado. Esse processamento, envolve o fechamento desse pacote ou seja, o resultado é um pedido para o fornecedor.

Método: POST

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/package/accept

Requisição e Tipos de Dados

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

Corpo da Requisição:

1. Token do pacote.
2. Informar o id do fornecedor.
3. Documento a qual o pacote é vinculado(documento do comprador).

Exemplo de Requisição:

{
    "packageToken": "b3559a0f-0123-415c-8ae0-0842a7dd59bf",
    "supplierId": 1,
    "document": "string"
}

Respostas Possíveis

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 equisiçã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.
500	Bad Gateway.

Exemplos de Respostas:

• Sucesso (200):

{
    "message": "Package successfully queued"
}

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

Como Testar o Endpoint

Para testar este endpoint, siga os passos:

1. Abra o Postman ou similar.

2. Configure o método da requisição para 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.