Justo

Justo

  • Docs

›Datos

General

  • Introducción
  • Crear una llave
  • Estructura
  • Ejemplos

Métodos

  • Información la marca
  • Listar locales
  • Editar el local
  • Listar pedidos pendientes
  • Listar pedidos
  • Rechazar un pedido
  • Aceptar un pedido
  • Activar delivery
  • Obtener un pedido
  • Cupones
  • Editar un pedido
  • Cambiar el estado de un pedido
  • Calcular costo delivery especial
  • Obtener el listado
  • Editar el listado
  • Editar el listado V2
  • Editar menús
  • Obtener un cliente
  • Listar clientes
  • Agregar puntos a cliente
  • Definir código de verificación

Métodos de stock

  • Agotar un producto o modificador
  • Eliminar productos agotados
  • Obtener ítems agotados
  • Definir stock de productos
  • Actualizar stock de productos con respuesta por webhook

Última milla

  • Crear solicitud de despacho
  • Consultar información de despacho
  • Cancelar despacho
  • Crear solicitud de despacho externo

Webhooks

  • Introducción
  • Nuevo pedido
  • Cambio de estado de un pedido
  • Modificación de un pedido
  • Cambio de estado de un despacho
  • Actualización de estado de procesos

Datos

  • Order
  • OrderItem
  • Store
  • Delivery
  • EstimateDelivery
  • Client
  • Address
  • Menu
  • Transaction
  • LoyaltyTransaction
  • Devolution
  • InStoreCouponCode
  • Schedule
  • PaginatedResult
  • OutOfStockItem
  • Billing

Delivery

Estructura

  • _id: ID del pedido
  • price: Costo del delivery, incluye IVA
  • status: Estado del pedido. Puede ser:
    • canceled: Se canceló el pedido
    • pending: Buscando repartidor
    • scheduled: Programado
    • active: En camino a buscar el pedido
    • delivering: En entrega
    • done: Completado
    • Dispatch not completed: No se pudo completar el pedido. En el campo uncompletedReason podrá encontrar el motivo porque no se pudo completar la entrega
    • error: Error
  • placeName: Quién recibe el pedido
  • isCash: Si el pedido require efectivo o no
  • fromLocation: Lugar desde donde inicia el pedido(origen), si es un local se agrega el nombre []
    • address: Dirección del lugar donde comienza el pedido
    • addressSecondary: Información extra de la dirección (comuna, ciudad, país, etc)
    • storeName: Nombre del local donde comienza el pedido (si corresponde)
    • lat: Latitude del lugar
    • lng: Longitud del lugar
  • toLocation: Lugar donde finaliza el pedido(destino), si es un local se agrega el nombre []
    • address: Dirección del lugar de destino del pedido
    • addressSecondary: Información extra de la dirección (comuna, ciudad, país, etc)
    • storeName: Nombre del local donde comienza el pedido (si corresponde)
    • lat: Latitude del lugar
    • lng: Longitud del lugar
  • receiveProofImage: La URL de la imagen que toma el repartidor al recibir el pedido
  • deliverProofImage: La URL de la imagen de la entrega
  • driverPassword: La contraseña asociada al pedido. Puede cambiar si es que cambia el repartidor
  • activatesAt: Fecha cuando se comienza a buscar un repartidor
  • createdAt: Fecha en la que se generó el delivery
  • forDate: Fecha para la cual se solicitó que el repartidor llegue al punto 1
  • completedAt: Fecha en que el repartidor completó el pedido
  • canceledAt: Fecha en que la que se canceló el delivery (si corresponde)
  • nearStoreAt: Fecha en que la que el repartidor llegó al punto 1
  • nearClientAt: Fecha en que la que el repartidor llegó al punto 2
  • deliveryExpectedAt: Fecha prometida del despacho (que se complete)
  • driverReceivedAt: Fecha en que el repartidor retiró el pedido desde el local para llevarlo a cliente final
  • trackingURL: La URL para que el que recibe la entrega pueda ver donde va
  • deliveryInformation: Texto ingresado por el repartidor donde especifica a quien le entregó el pedido
  • driverInformation: Información del repartidor
    • code: Código del repartidor
    • type: Tipo de vehiculo
    • phone: Telefono
    • name: Nombre
    • categoryId: Categoría interna del repartidor
    • image: La URL de una foto de la cara del repartidor
  • instructions: Instrucciones dadas al repartidor
  • specialCode: Número único asignado a cada pedido
  • externalId: ID Externo asignado al pedido
  • orderId: ID de la orden a la cual pertenece el pedido (si corresponde)
  • uncompletedReason: String opcional que contiene un motivo por el que un despacho se vio frustrado. Si este valor existe, los productos no pudieron ser entregados al cliente final

Ejemplo

{
  "_id": "QCevLRgMJfTgSJxhS",
  "price": 1999,
  "status": "done",
  "driverPassword": "5818",
  "activatesAt": "2021-07-20T16:26:00.000Z",
  "createdAt": "2021-07-20T16:12:14.822Z",
  "forDate": "2021-07-20T16:41:43.164Z",
  "fromLocation": {
    "address": "Avenida Vitacura 6345",
    "addressSecondary": "Vitacura, Chile",
    "storeName": "NOMBRE MARCA' Vitacura 6345 (Rotonda Irene Frei)",
    "lat": -33.3902738,
    "lng": -70.5701148
  },
  "toLocation": {
    "address": "Avenida Providencia 1302",
    "addressSecondary": "Providencia, Chile",
    "lat": -33.4286681,
    "lng": -70.6203024
  },
  "nearStoreAt": "2021-07-20T16:16:14.202Z",
  "nearClientAt": "2021-07-20T16:17:32.852Z",
  "completedAt": "2021-07-20T16:18:31.332Z",
  "canceledAt": null,
  "deliveryExpectedAt": "2021-07-20T17:12:00.000Z",
  "driverReceivedAt": "2021-07-20T16:16:32.230Z",
  "deliverProofImage": <URL>,
  "receiveProofImage": <URL>,
  "deliveryInformation": "Maria Soto - Recepción",
  "driverInformation": {
    "type": "moto",
    "phone": "+56999999999",
    "name": "Peter",
    "image": <URL>
  },
  "trackingURL": <URL>,
  "orderId": "wtZnef2Ks7xTfRJ8X",
  "placeName": "Miguel Piedrafitas",
  "instructions": "Dejar el pedido en conserjeria",
  "isCash": true,
  "specialCode": "369",
  "externalId": "ID_EXTERNO",
  "uncompletedReason": "Repartidor sufrió accidente"
}
← StoreEstimateDelivery →
  • Estructura
  • Ejemplo