Returns

Order object array Array

Array of order objects with all details

• companyId
  int64 required Defaults to 1234

• PARTNER-API-KEY
  string required Defaults to

• accept
  string enum Defaults to application/json

Generated from available response content types

• application/json
• text/plain

Allowed:

application/json text/plain

200 200

• array of objects

• object

• orderId
  integer Defaults to 0

• orderNumber
  string

• companyId
  integer Defaults to 0

• orderItem
  string

• accepted
  boolean Defaults to true

• placementTime
  string

• requestedPickupTime
  string

• requestedDeliveryTime
  string

• assignedTime
  string

• startTime
  string

• pickedupTime
  string

• arrivedTime
  string

• deliveryTime
  string

• failedDeliveryTime
  string

• deliveryNote
  string

• deliveryInstruction
  string

• dispatcherNote
  string

• paymentMethod
  string

• orderSource
  string

• incomplete
  boolean Defaults to true

• orderTotal
  number Defaults to 0

• deliveryFee
  number Defaults to 0

• tip
  number Defaults to 0

• discount
  integer Defaults to 0

• tax
  integer Defaults to 0

• driverPayment
  integer Defaults to 0

• carrier
  object

• pickup
  object

• delivery
  object

• status
  string

Example Order

[
  {
    "orderId": 1234567890,
    "orderNumber": "NR#123Test",
    "companyId": 1234567,
    "orderItem": "[{name:Pizza,quantity:1,unitPrice:13.4}]",
    "accepted": true,
    "placementTime": "2021-02-23T17:54:44Z",
    "requestedPickupTime": "2021-02-23T18:24:43Z",
    "requestedDeliveryTime": "2021-02-23T18:54:43Z",
    "assignedTime": "2021-02-23T17:56:00Z",
    "startTime": "2021-02-23T18:03:41Z",
    "pickedupTime": "2021-02-23T18:27:51Z",
    "arrivedTime": "2021-02-23T18:42:12Z",
    "deliveryTime": "2021-02-23T18:45:351Z",
    "failedDeliveryTime": null,
    "deliveryNote": "",
    "deliveryInstruction": "Call my number when you arrive",
    "dispatcherNote": "rd",
    "paymentMethod": "CARD",
    "orderSource": "",
    "incomplete": false,
    "orderTotal": 13.4,
    "deliveryFee": 5.2,
    "tip": 1.3,
    "discount": 0,
    "tax": 0,
    "driverPayment": 0,
    "carrier": {
      "id": 7890,
      "name": "Jeff Minem",
      "phone": "+1234567890",
      "email": "jeffMinem@gmail.com",
      "status": "OFFLINE",
      "vehiclePlateNumber": "CA-1234",
      "vehicleDescription": "Black Chevy",
      "note": null,
      "imageUrl": null,
      "partner": "None"
    },
    "pickup": {
      "id": 45678,
      "name": "Pizza Home",
      "address": "123 Fremont Blvd, Fremont, CA 94538, USA",
      "formattedAddress": "123 Fremont Blvd, Fremont, CA 94538, USA",
      "phone": "+1234567891",
      "lat": 37.00742,
      "lng": -121.301
    },
    "delivery": {
      "id": 420,
      "name": "Abbey Kikoy",
      "address": "000 Alta Vista Terrace, Fremont, CA 94539, USA",
      "formattedAddress": "000 Alta Vista Terrace, Fremont, CA 94539, USA",
      "phone": "+1234567892",
      "email": "",
      "lat": 37.4568076,
      "lng": -121.925089
    },
    "status": "ALREADY_DELIVERED"
  }
]