GET
/
deliveries
/
{id}
Obtener una entrega
curl --request GET \
  --url https://api.getjusto.com/api/v2/deliveries/{id}
{
  "_id": "<string>",
  "price": 123,
  "status": "canceled",
  "placeName": "<string>",
  "isCash": "<string>",
  "fromLocation": {
    "address": "<string>",
    "addressSecondary": "<string>",
    "storeName": "<string>",
    "lat": -33.4489,
    "lng": -70.6693
  },
  "toLocation": {
    "address": "<string>",
    "addressSecondary": "<string>",
    "storeName": "<string>",
    "lat": -33.4489,
    "lng": -70.6693
  },
  "receiveProofImage": "<string>",
  "deliverProofImage": "<string>",
  "driverPassword": "<string>",
  "activatesAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "forDate": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "canceledAt": "2023-11-07T05:31:56Z",
  "nearStoreAt": "2023-11-07T05:31:56Z",
  "nearClientAt": "2023-11-07T05:31:56Z",
  "deliveryExpectedAt": "2023-11-07T05:31:56Z",
  "driverReceivedAt": "2023-11-07T05:31:56Z",
  "trackingURL": "<string>",
  "deliveryInformation": "<string>",
  "driverInformation": {
    "code": "<string>",
    "type": "<string>",
    "phone": "<string>",
    "name": "<string>",
    "categoryId": "<string>",
    "image": "<string>"
  },
  "instructions": "<string>",
  "specialCode": "<string>",
  "externalId": "<string>",
  "orderId": "<string>",
  "uncompletedReason": "<string>"
}

​
Descripción

Este método posibilita la consulta de la información y el estado actual de un despacho (Delivery) específico. Esta función es esencial para el seguimiento y la gestión de entregas, ya que permite que tanto el usuario como el sistema obtengan los datos actualizados sobre cada proceso de despacho.

Path Parameters

​
id
string
required

ID de la entrega

Response

success

​
_id
string

ID del pedido.

​
price
number

Costo del delivery, incluye IVA

​
status
enum<string>

Estado del pedido. Puede tomar los siguientes valores:

  • canceled: Pedido cancelado.
  • pending: Pedido pendiente.
  • scheduled: Pedido programado.
  • active: En camino a buscar el pedido.
  • delivering: En proceso de entrega.
  • done: Pedido 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 en el pedido.
Available options:
canceled,
pending,
scheduled,
active,
delivering,
done,
Dispatch not completed,
error
​
placeName
string

Quién recibe el pedido.

​
isCash
string

Si el pedido require efectivo o no.

​
fromLocation
object

Lugar desde donde inicia el pedido(origen), si es un local se agrega el nombre [].

​
toLocation
object

Lugar donde finaliza el pedido(destino), si es un local se agrega el nombre [].

​
receiveProofImage
string<uri>

La URL de la imagen que toma el repartidor al recibir el pedido.

​
deliverProofImage
string<uri>

La URL de la imagen de la entrega.

​
driverPassword
string

La contraseña asociada al pedido. Puede cambiar si es que cambia el repartidor.

​
activatesAt
string<date-time>

Fecha cuando se comienza a buscar un repartidor.

​
createdAt
string<date-time>

Fecha en la que se generó el delivery.

​
forDate
string<date-time>

Fecha para la cual se solicitó que el repartidor llegue al punto 1.

​
completedAt
string<date-time>

Fecha en la que se completó el pedido.

​
canceledAt
string<date-time>

Fecha en la que se canceló el pedido (si corresponde).

​
nearStoreAt
string<date-time>

Fecha en que la que el repartidor llegó al punto 1.

​
nearClientAt
string<date-time>

Fecha en que la que el repartidor llegó al punto 2.

​
deliveryExpectedAt
string<date-time>

Fecha prometida del despacho (que se complete).

​
driverReceivedAt
string<date-time>

Fecha en que el repartidor retiró el pedido desde el local para llevarlo a cliente final.

​
trackingURL
string<uri>

La URL para que el que recibe la entrega pueda ver donde va.

​
deliveryInformation
string

Texto ingresado por el repartidor donde especifica a quien le entregó el pedido.

​
driverInformation
object
​
instructions
string

Instrucciones para el repartidor.

​
specialCode
string

Número único asignado al pedido.

​
externalId
string

ID externo del pedido.

​
orderId
string

ID de la orden asociada al pedido.

​
uncompletedReason
string

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.