Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getjusto.com/llms.txt

Use this file to discover all available pages before exploring further.

Crea una orden marketplace para el customer y website. Todas las llamadas usan Authorization: Bearer <token> con scope orderingApi.

Endpoint

POST /v3/ordering/customers/{externalCustomerId}/websites/{domain}/orders

Path parameters

Body

Response

success
boolean
required
Indica si la llamada fue procesada correctamente.
data
apiOrder
required
Orden creada.

Data object

apiOrder

Pedido de ecommerce.
_id
string
ID del pedido.
orderStatus
pending | waiting | preparing | delivering | done | cancelled
Estado operacional del pedido.
paymentStatus
pending | done | error | blocked | inReview | waitingForAdditionalPayment
Estado del pago del pedido.
isScheduled
boolean
Indica si el pedido es programado.
isConfirmed
boolean
Indica si el pedido programado fue confirmado.
websiteId
string
ID de la marca.
storeId
string
ID del local.
code
string
Código único del pedido en Justo.
fullCode
string
Código del pedido con el correlativo diario de la marca.
userId
string
ID del usuario que creó el pedido.
createdAt
string
Fecha de creación del pedido.
address
apiOrderAddress
Ver apiOrderAddress.
menuId
string
ID del menú desde el que se creó el pedido.
deliveryType
delivery | go | serve
Tipo de entrega del pedido.
deliverAt
string
Fecha en que el pedido debe ser entregado o retirado.
timeText
string
Texto legible con la ventana estimada de entrega.
paymentType
string
Medio de pago seleccionado.
paymentTypeLabel
string
Nombre legible del medio de pago.
paymentTypeIsIntegration
boolean
Indica si el medio de pago viene de una integración.
tipAmount
number
Monto de propina.
amountToPay
number
Monto total a pagar por el cliente, incluyendo propina.
deliveryFee
number
Precio del despacho cobrado al cliente.
serviceFee
number
Cargo de servicio cobrado al cliente.
itemsPrice
number
Precio de los productos, sin propina ni despacho.
totalPrice
number
Monto del pedido sin propina.
totalDiscount
number
Monto total descontado del pedido.
expectedPreparationDuration
number
Tiempo estimado de preparación en minutos.
deliveryDuration
number
Tiempo estimado de despacho en minutos.
cashAmount
number
Monto que el cliente declara pagar si el medio de pago es efectivo.
source
string
Origen del pedido.
buyerName
string
Nombre del cliente.
phone
string
Teléfono del cliente.
email
string
Email del cliente.
couponId
string
ID del cupón usado.
couponName
string
Nombre del cupón usado.
couponCode
string
Código del cupón usado.
couponDiscount
number
Monto descontado por cupón.
flagColor
string
Color de la bandera del pedido en POS.
items
apiOrderItem[]
Detalle de los productos vendidos en el pedido.
transaction
apiOrderTransaction
Ver apiOrderTransaction.
deliveries
apiOrderDelivery[]
Despachos asociados al pedido.
orderParams
object
Parámetros adicionales del pedido.
hasManagedDelivery
boolean
Indica si el despacho es gestionado por Justo.
gift
object
Información de regalo, si el pedido fue marcado como regalo.
billing
object
Información de facturación del cliente.
cancellationInfo
object
Información de cancelación del pedido.
deliveryZoneName
string
Nombre de la zona de despacho aplicada al pedido.

apiOrderAddress

Dirección de entrega del pedido.
_id
string
ID de la dirección.
placeId
string
ID del lugar asociado a la dirección.
address
string
Dirección principal en formato legacy.
addressLine2
string
Departamento, oficina u otra información complementaria.
addressSecondary
string
Comuna, ciudad o referencia secundaria de la dirección.
location
object
Coordenadas geográficas.

apiOrderItem

Producto vendido dentro del pedido.
_id
string
ID del item del pedido.
product
object
Producto asociado al item.
unitPrice
number
Precio unitario con descuento, sin incluir descuento de cupón.
baseUnitPrice
number
Precio unitario original antes de descuentos.
productPrice
number
Precio del producto con descuento.
baseProductPrice
number
Precio original del producto antes de descuentos.
amount
number
Cantidad de este producto en el pedido.
comment
string
Instrucciones adicionales para este producto.
description
string
Resumen en texto de los modificadores e instrucciones del item.
promotionId
string
ID de la promoción aplicada al item.
promotionDiscount
number
Monto descontado por promoción en el item.
promotionType
string
Tipo de promoción aplicada al item.
promotionLabel
string
Etiqueta visible de la promoción aplicada al item.
modifiers
apiOrderItemModifier[]
Modificadores seleccionados para el item.

apiOrderTransaction

Transacción de pago asociada al pedido.
_id
string
ID de la transacción.
totalPrice
number
Monto total de la transacción.
paymentType
string
Medio de pago usado en la transacción.
cardType
string
Tipo de tarjeta usada, si aplica.
cardLast4
string
Últimos cuatro dígitos de la tarjeta, si aplica.
status
string
Estado de la transacción.

apiOrderDelivery

Información de un despacho asociado al pedido.
_id
string
ID del despacho.
price
number
Precio del despacho.
status
active | canceled | cancelled | done | error | pending | scheduled | delivering | waiting | unconfirmed
Estado del despacho.
placeName
string
Nombre del lugar de destino.
isCash
boolean
Indica si el despacho se paga en efectivo.
instructions
string
Instrucciones para el despacho.
driverPassword
string
Código que debe presentar el repartidor al retirar el pedido.
fromLocation
object
Coordenadas geográficas.
toLocation
object
Coordenadas geográficas.
trackingURL
string
URL de seguimiento del despacho.
orderId
string
ID del pedido asociado al despacho.
activatesAt
string
Fecha en que se activa el despacho.
createdAt
string
Fecha de creación del despacho.
forDate
string
Fecha objetivo del despacho.
nearStoreAt
string
Fecha en que el repartidor llegó cerca del local.
pickupAt
string
Fecha de retiro del pedido.
nearClientAt
string
Fecha en que el repartidor llegó cerca del cliente.
completedAt
string
Fecha en que se completó el despacho.
canceledAt
string
Fecha de cancelación del despacho.
deliveryExpectedAt
string
Fecha estimada de entrega.
estimatedArrivalAtStoreAt
string
Fecha estimada de llegada del driver al local.
driverReceivedAt
string
Fecha en que el driver recibió el pedido, si aplica.
driverInformation
object
Información del driver asignado, si está disponible.
deliveryInformation
object
Información adicional del despacho, si está disponible.
externalId
string
ID externo del despacho, si existe.
specialCode
string
Código externo o especial del despacho, si existe.

apiOrderItemModifier

Modificador seleccionado para un item del pedido.
modifierId
string
ID Justo del modificador.
externalId
string
ID externo del modificador configurado por la marca.
name
string
Nombre del modificador.
shortName
string
Nombre corto del modificador.
metadata
object
Metadata del modificador escrita por API v3.
description
string
Resumen en texto de las opciones seleccionadas.
countById
Record<string, number>
Cantidad seleccionada por ID Justo de opción.
countByExternalId
Record<string, number>
Cantidad seleccionada por ID externo de opción.
options
object[]
Opciones seleccionadas para este modificador.

Notes

  • La orden queda asociada a la app autenticada mediante orderingAPIAppId.
  • Usa order.idempotencyKey para reintentos del mismo checkout.
  • Si el customer tiene email real, Ordering API lo copia en Order.email.