Estos modelos describen los objetos retornados enDocumentation Index
Fetch the complete documentation index at: https://docs.getjusto.com/llms.txt
Use this file to discover all available pages before exploring further.
data y los objetos compuestos usados por Ordering API.
OrderingAddress
Dirección guardada por el customer de Ordering API.ID de la dirección.
Place ID usado por Justo para calcular cobertura y despacho.
Dirección principal.
Departamento, oficina u otra información secundaria.
Texto secundario de comuna, ciudad o referencia.
Ver
OrderingLocation.Indica si el customer confirmó que no tiene línea 2.
Comentario o instrucciones de entrega.
ID del usuario sintético dueño de la dirección.
Device ID usado al crear la dirección.
Calle y numeración normalizada.
Localidad o comuna.
Sub-localidad.
Región o estado.
Código postal.
Código de país ISO 3166-1 alpha-2.
Nombre del país.
Fecha de creación.
OrderingAddressInput
Dirección a crear o actualizar para el customer.Place ID normalizado usado para cobertura y despacho.
Dirección principal visible para el customer.
Departamento, oficina u otra información secundaria.
Texto secundario de comuna, ciudad o referencia.
Ver
OrderingLocation.Indica si el customer confirmó que no tiene línea 2.
Comentario o instrucciones de entrega.
Calle y numeración normalizada.
Localidad o comuna.
Sub-localidad.
Región o estado.
Código postal.
Código de país ISO 3166-1 alpha-2.
Nombre del país.
OrderingBilling
Datos de facturación guardados para el checkout.Nombre o razón social.
Documento tributario.
Email de facturación.
Dirección de facturación.
Giro o actividad económica.
OrderingBillingInput
Datos de facturación para el checkout.Tipo de facturación elegido desde billingParamsSchema.
Nombre o razón social.
Documento tributario.
Email de facturación.
Dirección de facturación.
Giro o actividad económica.
OrderingBillingParams
Parámetros de facturación requeridos por el website.Schema dinámico de campos de facturación.
Indica si la facturación es obligatoria.
Código de país del website.
OrderingCart
Carrito calculado.ID del website.
ID del menú.
ID del local.
Tipo de entrega.
Place ID seleccionado.
Cupón aplicado.
Medio de pago seleccionado.
Subtipo de pago, si aplica.
Monto de propina seleccionado.
Porcentaje de propina seleccionado.
Propina calculada por defecto.
Justo Coins a usar.
Website Coins a usar.
Items del carrito.
Indica si el carrito acepta propina.
Estado del cupón aplicado.
Beneficios o promociones aplicadas.
Costo de despacho.
Costo de despacho antes de descuentos.
Precio de productos.
Precio de productos antes de descuentos.
Cargo de servicio.
Total sin propina.
Total a pagar.
OrderingCartItem
Item del carrito.ID del item del carrito.
ID del producto.
ID del menú.
Cantidad del producto.
Cantidad del producto en flujos v2.
Comentario del item.
Modificadores seleccionados.
Producto asociado al item.
Precio unitario.
Precio total del item.
OrderingCartItemInput
Item a agregar o actualizar en el carrito.ID del producto.
ID del menú desde el que se agrega el producto.
Cantidad del producto. Debe ser mayor a 0.
Modificadores seleccionados.
Comentario del item.
OrderingCartItemMutation
Resultado de una mutación de item de carrito.Ver
OrderingCartItem.Ver
OrderingCartState.OrderingCartModifierSelection
Selección de un modificador de producto.ID del modificador.
IDs de opciones seleccionadas. Repite un ID si la opción permite más de una unidad.
OrderingCartPreference
Preferencias activas del carrito.ID del website.
ID del usuario sintético.
Device ID usado por Ordering API.
ID del local seleccionado.
ID del menú seleccionado.
Place ID seleccionado.
Tipo de entrega.
Medio de pago seleccionado.
Subtipo de pago, si aplica.
Código de cupón aplicado.
Hora seleccionada. Usa
now para pedidos inmediatos.Texto visible de la hora seleccionada.
Tipo de entrega en destino.
Mesa o identificador de consumo en local.
Monto declarado para pago en efectivo.
ID de tarjeta guardada.
Justo Coins a usar.
Website Coins a usar.
OrderingCartPreferencesInput
Preferencias persistentes del carrito.ID del local seleccionado.
ID del menú seleccionado.
Place ID seleccionado.
Tipo de entrega.
Medio de pago seleccionado.
Subtipo de pago, si aplica.
Código de cupón aplicado.
Hora seleccionada. Usa
now o un value de cart/times.Tipo de entrega en destino.
Mesa o identificador de consumo en local.
Monto declarado para pago en efectivo.
ID de tarjeta guardada.
Justo Coins a usar.
Website Coins a usar.
OrderingCartState
Estado completo del carrito y checkout.Ver
OrderingCartPreference.Ver
OrderingAddress.Ver
OrderingStore.Horarios disponibles.
Medios de pago disponibles.
Ver
OrderingCart.OrderingCategoryTreeItem
Nodo del árbol de categorías.ID de la categoría.
Nombre de la categoría.
Subcategorías.
Traducciones de la categoría.
OrderingCheckoutState
Estado temporal de checkout persistido por Ordering API.ID del estado temporal.
ID de la app Ordering API.
ID del customer externo.
ID del website.
Dirección seleccionada.
Ver
OrderingBilling.Configuración de propina.
Monto declarado para efectivo.
Información de regalo.
Parámetros adicionales del pedido.
Firmas de términos.
Idempotency key provisto por la app externa.
Metadata adicional.
Fecha de nacimiento de sesión.
Fecha de creación.
Fecha de actualización.
Fecha de expiración TTL.
OrderingCheckoutStateInput
Estado temporal de checkout a guardar.ID de dirección seleccionada.
Ver
OrderingBillingInput.Propina seleccionada.
Monto declarado para efectivo.
Información de regalo.
Parámetros adicionales del pedido.
Firmas de términos.
Key estable para reintentos del mismo checkout.
Metadata adicional.
Fecha de nacimiento de sesión.
OrderingCreateOrderInput
Payload para crear una orden.Ver
OrderingOrderCustomerInput.Ver
OrderingOrderInput.OrderingCustomer
Customer propio de la app Ordering API.ID del customer en el sistema externo.
Email real del customer, usado para notificaciones.
Teléfono real del customer.
Nombre del customer.
Apellido del customer.
Fecha de creación del customer.
Fecha de última actualización del customer.
OrderingCustomerInput
Datos reales del customer externo.Email real del customer, usado para notificaciones.
Teléfono real del customer.
Nombre del customer.
Apellido del customer.
OrderingFeaturedProduct
Producto destacado de una card marketplace.ID del producto.
Nombre del producto.
Ver
OrderingImage.Precio final.
Precio base antes de descuentos.
Indica si está disponible.
Motivo de no disponibilidad.
Path del producto dentro del website.
OrderingHumanSchedule
Bloque de horario legible.Días a los que aplica el horario.
Horario legible.
OrderingImage
Imagen publicada por Justo o por el comercio.ID de la imagen.
URL original de la imagen.
Colores calculados de la imagen.
Dimensiones originales de la imagen.
URLs de versiones redimensionadas.
OrderingLocation
Coordenadas geográficas.Latitud.
Longitud.
OrderingMarketplaceCard
Card de restaurante en marketplace.ID interno de la card.
ID del local recomendado.
ID del website recomendado.
URL base del website.
Nombre comercial del website.
Indica si el website está en modo staging.
Descripción del comercio.
Tags de categorías gastronómicas.
Códigos de categorías gastronómicas.
Palabras de búsqueda indexadas.
Promedio de reviews.
Cantidad de reviews como texto público.
Indica si tiene despacho gestionado.
Ver
OrderingImage.Ver
OrderingImage.ID de la ciudad marketplace.
Tiempo estimado de cocina en minutos.
Duración actual de despacho en minutos.
Duración actual de retiro en minutos.
Ver
OrderingStoreAddress.Indica si no acepta pedidos para ahora.
Mensaje de cierre, si el local está cerrado.
Datos calculados para el placeId consultado.
Productos destacados del comercio.
Productos que coincidieron con una búsqueda marketplace.
OrderingMarketplacePage
Página de resultados de marketplace.Restaurantes encontrados.
Total de resultados.
Total de páginas.
Indica si existe una página siguiente.
Indica si existe una página anterior.
OrderingMenuData
Menú publicado.Datos del menú.
Productos indexados por ID.
Categorías indexadas por ID.
Árbol de categorías.
OrderingOrderCustomerInput
Datos del customer a actualizar justo antes de crear la orden.Email real del customer para Order.email y notificaciones.
Teléfono real del customer.
Nombre del customer.
Apellido del customer.
OrderingOrderInput
Datos finales de la orden. Si omites un campo, Ordering API usa preferencias o checkout-state cuando aplique.ID de dirección para delivery.
ID del local que preparará el pedido.
ID del menú usado en el carrito.
Tipo de entrega.
Horario final. Usa
now o un value de cart/times.Medio de pago final.
Monto declarado para pago en efectivo.
Cupón a usar en la orden.
Subtipo de pago, si aplica.
ID de tarjeta guardada, si aplica.
Monto final de propina.
Tipo de entrega en destino.
Mesa o identificador de consumo en local.
Parámetros adicionales del pedido.
Ver
OrderingBillingInput.Firmas de términos.
Key estable para reintentos del mismo checkout.
Datos del proveedor de pago.
Configuración del proveedor de pago.
Fecha de nacimiento de sesión.
Información de regalo.
Website Coins a descontar.
Justo Coins a descontar.
Metadata adicional.
Indica si se debe usar Payments V3. Default true.
OrderingOrdersPage
Página de pedidos de un customer.Pedidos de la página.
Total de pedidos.
Total de páginas.
Indica si existe una página siguiente.
Indica si existe una página anterior.
OrderingPaymentMethod
Medio de pago disponible.Código del medio de pago.
Nombre visible del medio de pago.
Indica si permite despacho.
Indica si el pago depende de una integración externa.
Tipos de entrega permitidos para este medio de pago.
Indica si requiere viaje ida y vuelta.
Indica si está disponible para API v3.
Indica si requiere validaciones seguras adicionales.
OrderingProduct
Producto de menú.ID del producto.
Nombre del producto.
Descripción del producto.
ID externo configurado por el comercio.
Prioridad de ordenamiento.
Sellos informativos del producto.
Precio y disponibilidad del producto en el menú consultado.
Alias de búsqueda del producto.
Categorías del producto.
Imágenes del producto.
Cantidad máxima por compra.
ID del website.
Nombre del website.
ID del menú consultado.
URL de video del producto.
Modificadores del producto.
Texto alt de imagen.
Título de imagen.
Unidad de medida.
Valor de medida.
Traducciones del producto.
Path del producto dentro del website.
OrderingProductCategory
Categoría de menú.ID de la categoría.
Nombre de la categoría.
Posición de la categoría.
Traducciones de la categoría.
OrderingProductModifier
Modificador de un producto.ID del modificador.
Nombre del modificador.
Nombre corto del modificador.
Descripción del modificador.
Indica si se muestra como modificador visual.
Mínimo de opciones a seleccionar.
Máximo de opciones a seleccionar.
Indica si el modificador es opcional.
Opciones del modificador.
Traducciones del modificador.
OrderingProductModifierOption
Opción seleccionable de un modificador.ID de la opción.
Nombre de la opción.
Precio y disponibilidad de la opción en el menú.
Imágenes de la opción.
Máximo seleccionable de esta opción.
Indica si requiere otra opción seleccionada.
IDs de opciones requeridas.
Traducciones de la opción.
OrderingProductSearchData
Resultado de búsqueda de productos.Texto buscado.
IDs de categorías incluidas en el resultado.
Productos indexados por ID.
Categorías indexadas por ID.
OrderingSelectedAddressInput
Dirección seleccionada para el checkout del website.ID de una dirección del customer.
OrderingStore
Local disponible para operar pedidos.ID del local.
ID del website al que pertenece el local.
Nombre del local.
Zona horaria del local.
Indica si acepta despacho.
Indica si acepta retiro.
Indica si acepta consumo en local.
Indica si acepta reservas.
Indica si acepta lista de espera.
Días mínimos de anticipación para pedidos programados.
Indica si se oculta la propina.
Indica si se fuerza ocultar propina de delivery.
Indica si el local usa despacho gestionado por defecto.
Tipo de cálculo de costo de despacho.
ID de la ciudad marketplace.
Ver
OrderingStoreAddress.Horario de atención legible.
Horario de reservas legible.
Zonas de despacho del local.
Medios de pago disponibles para el local.
Canales de soporte del local.
OrderingStoreAddress
Dirección pública de un local.Place ID del local.
Dirección principal.
Dirección extendida.
Ver
OrderingLocation.Localidad o comuna.
País.
OrderingTimeOption
Opción de horario disponible.Valor que debe enviarse como
time.Texto visible del horario.
Indica si la opción no está disponible.
apiOrder
Pedido de ecommerce.ID del pedido.
Estado operacional del pedido.
Estado del pago del pedido.
Indica si el pedido es programado.
Indica si el pedido programado fue confirmado.
ID de la marca.
ID del local.
Código único del pedido en Justo.
Código del pedido con el correlativo diario de la marca.
ID del usuario que creó el pedido.
Fecha de creación del pedido.
Ver
apiOrderAddress.ID del menú desde el que se creó el pedido.
Tipo de entrega del pedido.
Fecha en que el pedido debe ser entregado o retirado.
Texto legible con la ventana estimada de entrega.
Medio de pago seleccionado.
Nombre legible del medio de pago.
Indica si el medio de pago viene de una integración.
Monto de propina.
Monto total a pagar por el cliente, incluyendo propina.
Precio del despacho cobrado al cliente.
Cargo de servicio cobrado al cliente.
Precio de los productos, sin propina ni despacho.
Monto del pedido sin propina.
Monto total descontado del pedido.
Tiempo estimado de preparación en minutos.
Tiempo estimado de despacho en minutos.
Monto que el cliente declara pagar si el medio de pago es efectivo.
Origen del pedido.
Nombre del cliente.
Teléfono del cliente.
Email del cliente.
ID del cupón usado.
Nombre del cupón usado.
Código del cupón usado.
Monto descontado por cupón.
Color de la bandera del pedido en POS.
Detalle de los productos vendidos en el pedido.
Ver
apiOrderTransaction.Despachos asociados al pedido.
Parámetros adicionales del pedido.
Indica si el despacho es gestionado por Justo.
Información de regalo, si el pedido fue marcado como regalo.
Información de facturación del cliente.
Información de cancelación del pedido.
Nombre de la zona de despacho aplicada al pedido.
apiOrderAddress
Dirección de entrega del pedido.ID de la dirección.
ID del lugar asociado a la dirección.
Dirección principal en formato legacy.
Departamento, oficina u otra información complementaria.
Comuna, ciudad o referencia secundaria de la dirección.
Coordenadas geográficas.
apiOrderDelivery
Información de un despacho asociado al pedido.ID del despacho.
Precio del despacho.
status
active | canceled | cancelled | done | error | pending | scheduled | delivering | waiting | unconfirmed
Estado del despacho.
Nombre del lugar de destino.
Indica si el despacho se paga en efectivo.
Instrucciones para el despacho.
Código que debe presentar el repartidor al retirar el pedido.
Coordenadas geográficas.
Coordenadas geográficas.
URL de seguimiento del despacho.
ID del pedido asociado al despacho.
Fecha en que se activa el despacho.
Fecha de creación del despacho.
Fecha objetivo del despacho.
Fecha en que el repartidor llegó cerca del local.
Fecha de retiro del pedido.
Fecha en que el repartidor llegó cerca del cliente.
Fecha en que se completó el despacho.
Fecha de cancelación del despacho.
Fecha estimada de entrega.
Fecha estimada de llegada del driver al local.
Fecha en que el driver recibió el pedido, si aplica.
Información del driver asignado, si está disponible.
Información adicional del despacho, si está disponible.
ID externo del despacho, si existe.
Código externo o especial del despacho, si existe.
apiOrderDeliveryUpdatedWebhookData
Datos del webhook de actualización de despacho de pedido.Ver
apiOrder.Ver
apiOrderDelivery.apiOrderItem
Producto vendido dentro del pedido.ID del item del pedido.
Producto asociado al item.
Precio unitario con descuento, sin incluir descuento de cupón.
Precio unitario original antes de descuentos.
Precio del producto con descuento.
Precio original del producto antes de descuentos.
Cantidad de este producto en el pedido.
Instrucciones adicionales para este producto.
Resumen en texto de los modificadores e instrucciones del item.
ID de la promoción aplicada al item.
Monto descontado por promoción en el item.
Tipo de promoción aplicada al item.
Etiqueta visible de la promoción aplicada al item.
Modificadores seleccionados para el item.
apiOrderItemModifier
Modificador seleccionado para un item del pedido.ID Justo del modificador.
ID externo del modificador configurado por la marca.
Nombre del modificador.
Nombre corto del modificador.
Metadata del modificador escrita por API v3.
Resumen en texto de las opciones seleccionadas.
Cantidad seleccionada por ID Justo de opción.
Cantidad seleccionada por ID externo de opción.
Opciones seleccionadas para este modificador.
apiOrderStatusUpdatedWebhookData
Datos del webhook de actualización de pedido. Si previousOrderStatus y newOrderStatus son iguales, el evento corresponde a un cambio importante del despacho asociado.Ver
apiOrder.Despacho actualizado. Se incluye cuando el evento se origina por un cambio importante del despacho, como cambio de estado o llegada del repartidor cerca del local o cliente.
Estado anterior del pedido.
Nuevo estado del pedido.
apiOrderTransaction
Transacción de pago asociada al pedido.ID de la transacción.
Monto total de la transacción.
Medio de pago usado en la transacción.
Tipo de tarjeta usada, si aplica.
Últimos cuatro dígitos de la tarjeta, si aplica.
Estado de la transacción.