API Integración de Logística

Descripción de los objetos correspondientes a los modelos de datos de cada entidad manejada en esta documentación.

Order

Clave	Tipo	Descripción
id	String	Identificador de la orden.
currency	String	Moneda de la orden en formato ISO 4217.
customer	<Customer>	Información del comprador.
deliveryInformation	<DeliveryInformation>	Información sobre la entrega de la orden.
items	List<Item>	Detalle de los productos que contiene la orden.
packages	List<Package>	Detalle de los paquetes.

Customer

Clave	Tipo	Descripción
name	String	Nombre del comprador.
lastName	String	Apellido del comprador.
document	<Document>	Datos del documento del comprador.
email	String	Correo electrónico del comprador.
phone	String	Teléfono en formato +[CODIGOPAIS] [NUMERO].

DeliveryInformation

Clave	Tipo	Descripción
recipientName	String	Nombre de la persona que recibirá la orden.
fromAddress	<Address>	Datos de la dirección de retiro.
toAddress	<Address>	Datos de la dirección de envío.
deliveryDate	<DeliveryDate> | null	Franja horaria de entrega del envío. Este dato es opcional y se puede incluir o no dependiendo del Service Type enviado. Este campo solo se envía en el servicio Create Shipping. Importante: Especificar si el servicio logístico soporta la definición de franjas de entrega en su sistema, incluyendo días y horarios disponibles.

DeliveryDate

Clave	Tipo	Descripción
from	DateTime	Fecha y hora comienzo de la franja de entrega.
to	DateTime	Fecha y hora fin de la franja de entrega.

Document

Clave	Tipo	Descripción
number	String	Número de documento.
country	String	Código ISO 3166-1 del país.
type	Enum	Tipo de documento. Valores posibles.

Item

Clave	Tipo	Descripción
id	String	Identificador del ítem.
name	String | null	Nombre del ítem.
quantity	Int	Cantidad de unidades compradas.
price	Float | null	Precio unitario de ítem.
cantidadRegalo	Int	Cantidad de ítems que seleccionaron para regalo.
weight	Float | null	Peso del ítem en gramos.
length	Float | null	Largo del ítem en centímetros.
width	Float | null	Ancho del ítem en centímetros.
height	Float | null	Alto del ítem en centímetros.

Address

Clave	Tipo	Descripción
country	String	Nombre del País.
region	String	Nombre del departamento.
locality	String	Nombre de la localidad.
street	String	Nombre de la calle.
doorNumber	String	Número de puerta.
apartmentNumber	String | null	Número de apartamento..
postcode	String | null	Código postal de la dirección.
latitude	Float | null	Latitud. Si se requiere puede ser un dato obligatorio.
longitude	Float | null	Longitud. Si se requiere puede ser un dato obligatorio.
additionalInformation	String | null	Información extra sobre la dirección.

Package

Clave	Tipo	Descripción
codigo	Enum	Código del tipo de paquete. Valores a definir por empresa logística.
cantidad	Int	Cantidad del paquete.