Attributes
orderId Integer
Unique order ID for identifying the order
orderNumber String
Order number for the order
companyId Integer
Unique Company ID for identifying the company
orderItem String
Order Items ( JSON Array )
accepted Boolean
Identifier indicating if the order is accepted
placementTime String
Order placement time
requestedPickupTime String
Requested pickup time for the order
requestedDeliveryTime String
requested delivery time for the order
assignedTime String
Assignment time for the order
startTime String
Starting time for the delivery of the order
pickedupTime String
Pickup time for the order
arrivedTime String
Arrival time of the carrier to the customer address
deliveryTime String
Delivery time for the order to the customer
failedDeliveryTime String
Failed Delivery time if the order delivery failed
deliveryNote String
Provided Delivery note
deliveryInstruction String
Provided delivery instruction
dispatcherNote String
Dispatch Note for the order
paymentMethod String
Payment Method for the order
| Possible enum values |
|---|
| cash |
| credit card |
creditCardType String
Type of the credit card (if credit card is selected as payment method)
| Possible enum values |
|---|
| visa |
| master card |
| AMEX |
| other |
creditCardId Integer
Last four digits of the credit card (if credit card is selected as payment method)
orderSource String
Order Source
incomplete Boolean
Identifier indicating if the order delivery is incomplete
orderTotal Double
Total fee amount for the order
deliveryFee Double
Delivery fee amount for the order
tip Double
Tip amount for the order
discount Double
Discount amount for the order
tax Double
Tax amount for the order
driverPayment Double
Driver/Carrier payment amount
carrier hash
Carrier details object
Child Attributes
id
Integer
Unique ID for the carrier
name
String
Name of the carrier
phone
String
phone number of the carrier
String
Email address of the carrier
status
String
Current State of the carrier
| Possible enum values of 'status' |
|---|
| ONLINE |
| OFFLINE |
vehiclePlateNumber
String
Vehicle Plate number of the carrier
vehicleDescription
String
Vehicle Description of the carrier
note
String
Note for the carrier
imageUrl
String
Carrier image url
partner
String
Partner of the carrier
pickup hash
Detailed Pickup information object
Child Attributes
id
Integer
Unique ID for the pickup
name
String
Name of the pickup point
address
String
Address of the pickup location
formattedAddress
String
Formatted Address of the pickup location
phone
String
Phone number with country code
lat
Double
Latitude value of the pickup location
lng
Double
Longitude value of the pickup location
delivery hash
Detailed Delivery information object
Child Attributes
id
Integer
Unique ID for the delivery
name
String
Name of the delivery point / customer
address
String
Address of the delivery location
formattedAddress
String
Formatted Address of the delivery location
phone
String
Phone number with country code
String
Email address of the customer
lat
Double
Latitude value of the delivery location
lng
Double
Longitude value of the delivery location
status String
Order delivery Status
| Possible Enum values for `status` |
|---|
| ACTIVE |
| NOT_ASSIGNED |
| NOT_ACCEPTED |
| NOT_STARTED_YET |
| STARTED |
| PICKED_UP |
| READY_TO_DELIVER |
| ALREADY_DELIVERED |
| FAILED_DELIVERY |
| INCOMPLETE |
Note: All datetimes are in UTC ISO format
{
"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.0,
"tax": 0.0,
"driverPayment": 0.0,
"carrier": {
"id": 7890,
"name": "Jeff Minem",
"phone": "+1234567890",
"email": "[email protected]",
"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.007420,
"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"
}