Criar Pacote

Este endpoint é projetado para a criação de pacotes que serão utilizados dentro do Marketplace. Ele permite aos usuários registrar um novo pacote, incluindo detalhes sobre itens, pagamento e validade, para facilitar transações de compra e venda.

Método: POST

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

Requisição e Tipos de Dados

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

Exemplo de Requisição:

{
 "document": "string",
 "name": "string",
 "maximumDelivery": "2024-08-11",
 "items": [
	 {
		 "sku": "string",
		 "quantity": 0,
		 "unitPrice": 0
	 }
 ],
 "payment": {
	 "paymentType": 0,
	 "paymentInterest": 0,
	 "paymentDeadline": "2024-08-11",
	 "paymentDays": 0,
	 "paymentInterestType": "string"
	 },
 "validity": "2024-08-11T16:44:52.398Z",
 "startDate": "2024-08-11T16:44:52.398Z",
 "negotiationName": "string"
}

Descrição das propriedades:

Nome da Propriedade	Descrição	Tipo	Obrigatoriedade
Document	Documento do comprador (string).	string	Required
Name	Nome do pacote (string).	string	Required
maximumDelivery	Data máxima de entrega (data no formato AAAA-MM-DD).	dateTime	Required
items	Array de objetos, cada um representando um item do pacote com sku, quantity e unitPrice.	List<object>	Required
payment	Um objeto detalhando o tipo de pagamento, juros, prazos e dias de pagamento.	decimal	Required
validity	Período de validade do pacote.	dateTime	Required
startDate	Data de início da negociação.	dateTime	Required
negotiationName	Nome da negociação.	string	Optional
paymentInterest	1 (Juros simples) / 2 (Juros compostos).	int	Required
paymentType	1 (Boleto à vista) / 2 (Boleto a prazo).	int	Required
paymentDeadline	Data de vencimento do boleto.	date	Required
paymentDays	Caso o pagamento seja Boleto a prazo.	int	Required

Respostas Possíveis

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Ok: O pacote foi criado com sucesso.
400	Bad Request: Erro na requisição devido a um problema de validação dos dados.
401	Unauthorized: Falta de autenticação para acessar o endpoint.
403	Forbidden: Autenticação bem-sucedida, mas acesso ao recurso é negado.
500	Internal Server Error: Erro genérico indicando uma falha no servidor ao processar a requisição.

Exemplos de Respostas:

• Sucesso (200):

{
 "url": "string",
 "id": 0,
 "name": "string",
 "startDate": "2024-08-11T16:44:52.398Z",
 "endDate": "2024-08-11T16:44:52.398Z",
 "ticketExpiration": "2024-08-11T16:44:52.398Z",
 "price": 0
}

Exemplo de resposta prática, pois esse endpoint não preenche todas as propriedades.

{
	"url": "https://orbia-dev.bravium.com.br/orbia/comprar/Pacote/7cff029e-895e-4ffb-a6df-b1676c4af373",
	"id": 5970,
	"name": "Teste Insert CanalOrigem Hub",
	"startDate": "2024-09-03T09:00:00.001Z",
	"endDate": "2024-09-25T23:59:59.001Z",
	"ticketExpiration": "2024-09-25T13:32:48.7678304-03:00",
	"price": 989.80
}

Descrição das propriedades:

Nome da Propriedade	Descrição	Tipo
url	URL do link do pacote	string
id	Id do pacote	int
name	Nome do pacote	string
startDate	Data validade do pacote (início)	dateTime
endDate	Data validade do pacote (final)	dateTime
ticketExpiration	Data de expiração do câmbio	dateTime
price	Preço final do pacote	decimal

• 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 URI completa do endpoint.

3. No campo de parâmetros de cancelamento, adicione o json do pacote que deseja criar.

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.

Como acessar no portal do parceiro

Observação

Todas as informações exibidas neste fluxo são apenas para consulta e não podem ser alteradas diretamente no portal.

Saiba como acessar aos registros dos pacotes desde o Portal do Parceiro.

1. Faça login no "Portal Parceiro".
2. No menu, clique no botão "Pacotes" e, em seguida, selecione "Ver pacotes cadastrados".
3. Na tela, você poderá visualizar uma lista detalhada dos pacotes cadastrados.