Show Delivery with ETA

This endpoint exposes the courier arrival time to pickup and to drop off

The parameters will_arrive_to_pickup_at and will_arrive_to_drop_off_at will be appears in response body once the status will be turn to 'confirmed' (20) More info on statuses

Resource

GET /v1/delivery/deliveries/:uuid/with-eta

Authorization

OAuth 2.0 bearer token with Delivery scope.

Query Paramaters

Name

Type

Description

business_id

string

Unique identifier representing a Business.

Path Parameters

Name

Type

Description

uuid

string

Delivery id received when creating a new delivery

Response body

{
  "id": "DR-796d042b96774ba693fda9accce7f",
  "uuid": "DR-796d042b96774098bfda9accce7f",
  "bundle_id": "B-739ef76e6c614d91184f6f1e4fca",
  "product_id": "0412cb1a-db4f-4f17-sss8-669824790dc0",
  "display_identifier": "1184107",
  "status": "confirmed",
  "status_code": 20,
  "cannot_deliver_info": null,
  "courier": {
    "color": "Red",
    "license_plate": "1232-76-76",
    "model": "Skoda",
    "name": "John Lenon",
    "phone": "012-4567898",
    "picture_url": "https://public.gett.com/IMG/DRIVERS/3263.3.production.1619125.png"
  },
  "pickup": {
    "lat": 32.108544,
    "lng": 34.838642,
    "address": "Habarzel 15 Tel Aviv",
    "note": "Near the white door"
  },
  "drop_off": {
    "lat": 32.086130,
    "lng": 34.774710,
    "address": "Dizengoff 67 Tel aviv",
    "note": "Floor 6, Door 3"
  },
  "return_drop_off": {
    "lat": 32.108544,
    "lng": 34.838642,
    "address": "Habarzel 15 Tel Aviv",
    "note": "Near the white door"
  },
  "pickup_contact": {
    "name": "Omer",
    "phone_number": "032-4563344"
  },
  "drop_off_contact": {
    "name": "Joel Doe",
    "phone_number": "972519876544"
  },
  "return_contact": {
    "name": "Omer",
    "phone_number": "032-4563344"
  },
  "verifications": [
    {
      "type": "recipient",
      "proved_at": "2021-03-18T13:07:07.30883Z",
      "proof": {
        "recipient_category": "other",
        "recipient_name": "Michael",
        "verified_by": "32263"
      }
    }
  ],
  "started_at": "2021-03-18T12:53:24.160026Z",
  "scheduled_at": "2021-03-18T11:00:00Z",
  "arrived_at": "2021-03-18T13:00:56.93175Z",
  "picked_up_at": "2021-03-18T13:00:56.93175Z",
  "ended_at": "2021-03-18T13:07:07.355859Z",
  "deliver_from": null,
  "deliver_until": null,
  "parcels": [
    {
      "display_identifier": "110929",
      "barcode": "110929",
      "barcodes": [
        "110929"
      ],
      "size_alias": "",
      "length": 0,
      "width": 0,
      "height": 0,
      "weight": 0,
      "items": [
        {
          "external_id": "",
          "name": "110929",
          "quantity": 1,
          "price": 0,
          "vat_rate": 0,
          "exemplars": null,
          "status": "completed",
          "cannot_deliver_info": null
        }
      ],
      "status": "completed",
      "cannot_deliver_info": null
    }
  ],
  "client_price": null,
  "delivery_price": null,
  "vendor": {
    "name": "NBA"
  },
  "route_identifier": "Route 1",
  "journey_id": 1870925,
  "created_at": "2021-03-18T12:53:24.087038Z",
  "age_verification_required": false,
  "order_id_representation": "JC317822093ME",
  "will_arrive_to_pickup_at": "2021-04-06T14:45:29Z",
  "will_arrive_to_drop_off_at": "2021-09-23T14:07:39Z",
  "order_from": "api-6456545",
  "external_payment_confirmation": false,
  "processing_has_started": false
}

Sandbox

Resource:

GET /v1/delivery_sandbox/deliveries/:uuid/with-eta?business_id={{company_id}}

More info can be found here

Note: If uuid parameter equals '1', a fake delivery payload will be returned, on status 'confirmed', while the field 'will_arrive_to_pickup_at' should have a value


Did this page help you?