Requisitos Mínimos de Dados para Integração com o TrocaMe

Modificado em Ter, 28 Out na (o) 3:36 PM

1. Introdução

Este documento enumera os campos de dados que o sistema de terceiros DEVE disponibilizar em sua API para garantir a compatibilidade e a integração funcional com a plataforma TrocaMe.

O foco é o contrato de dados, ou seja, a lista exata de informações de pedidos e itens que devem ser retornadas em qualquer consulta de pedido.

2. Estrutura de Dados Necessária

A API Parceira deve ser capaz de fornecer dados estruturados em dois objetos principais: Pedido (o objeto principal) e Item (uma lista aninhada dentro de Pedido).

2.1. Objeto Principal: Pedido

Este objeto deve conter as seguintes informações sobre o pedido e o cliente:

Campo	Tipo Esperado	Descrição
cpf	string	CPF do cliente.
nome	string	Nome completo do cliente.
numeroPedido	string	Identificador único do pedido.
datadePedido	DateTime (string ISO 8601)	Data e hora em que o pedido foi realizado.
email	string	E-mail do cliente.
endereco	string	Logradouro do endereço de entrega.
enderecoCmmpto	string	Complemento do endereço.
enderecoNumero	string	Número do endereço.
enderecoObs	string	Observação sobre o endereço.
bairro	string	Bairro do endereço de entrega.
cidade	string	Cidade do endereço de entrega.
estado	string	Estado do endereço de entrega (UF).
cep	string	CEP.
dataEntrega	DateTime (string ISO 8601)	Data prevista ou realizada da entrega.
total	decimal (number)	Valor total do pedido (produtos + frete - descontos).
valorDesconto	decimal (number)	Valor total dos descontos aplicados ao pedido.
totalFrete	decimal (number)	Valor total do frete do pedido.
telefone	string	Telefone de contato do cliente.
itens	List<Item> (array)	Lista de objetos Item (ver Seção 2.2).
codigoRastreio	string	Código de rastreio da encomenda.

2.2. Objeto Aninhado: Item

Cada item dentro da lista itens deve conter as seguintes informações:

Campo	Tipo Esperado	Descrição
numItem	int (integer)	Número sequencial do item no pedido.
id	string	ID do produto no catálogo.
idVariant	string	ID da variante do produto (ex: cor, tamanho).
quantidade	int (integer)	Quantidade comprada.
descricao	string	Nome ou descrição do item.
valor	decimal (number)	Valor unitário do item (sem frete/desconto).
valorFrete	decimal (number)	Valor do frete atribuído a este item.
valorDesconto	decimal (number)	Valor de desconto atribuído a este item.
width	int (integer)	Largura em cm (para cálculo de frete/embalagem).
height	int (integer)	Altura em cm (para cálculo de frete/embalagem).
length	int (integer)	Comprimento em cm (para cálculo de frete/embalagem).
weight	float (number)	Peso em kg (pode ser float).
urlImagem	string	URL da imagem do produto.

3. Formatos e Considerações

•Valores Monetários: Os campos de tipo decimal (representados como number em JSON) devem garantir a precisão de duas casas decimais.

•Datas: Os campos de data e hora (DateTime) devem ser formatados no padrão ISO 8601 (ex: AAAA-MM-DDTHH:MM:SSZ).

•Campos Opcionais: Embora todos os campos estejam listados para um contrato de dados completo, o sistema de terceiros deve indicar quais campos são estritamente obrigatórios e quais podem ser nulos ou omitidos na resposta (ex: enderecoCmmpto, enderecoObs, codigoRastreio). Para fins de integração, recomenda-se que todos os campos listados sejam fornecidos, se disponíveis.