HTTP Response Codes

200

json

400

API Request Example

curl --request GET \
     --url https://api.shipday.com/orders \
     --header 'Accept: application/json' \
     --header 'Authorization: Basic BgxsDwd00n.LNNn90QydrjgZ1K9dS13' \
     --header 'x-api-key: null'

Sample Order Data

[
  {
    "orderId": 22773,
    "orderNumber": "75637",
    "companyId": 409,
    "areaId": 406,
    "customer": {
      "name": "Isabella",
      "address": "Crespi Dr, Pacifica, CA 94044, USA",
      "phoneNumber": "+8801555552505",
      "emailAddress": "isabella@ymail.com",
      "latitude": 23.810332,
      "longitude": 90.4125181
    },
    "restaurant": {
      "id": 1232332,
      "name": "Kenny's Cafe",
      "address": "640 Crespi Dr #1, Pacifica, CA 94044, United States",
      "phoneNumber": "+16507388777",
      "latitude": 23.8069245,
      "longitude": 90.36869779999999
    },
    "assignedCarrier": {
      "id": 30309,
      "name": "Jennifer",
      "phoneNumber": "+1234234233",
      "email": "jennifer1234@gmail.com",
      "carrierPhoto": "https://s3-us-west-2.amazonaws.com/qt.com.dashboard.profile.driver/somelinktothecarrier.jpg",
      "isOnShift": true,
      "isActive": true
    },
    "distance": 0.6443,
    "activityLog": {
      "placementTime": "2019-12-07T05:48:05",
      "expectedPickupTime": "06:15",
      "expectedDeliveryDate": "2019-12-07",
      "expectedDeliveryTime": "06:45"
    },
    "costing": {
      "totalCost": 19.55,
      "deliveryFee": 2,
      "tip": 0,
      "discountAmount": 0,
      "tax": 1.55,
      "cashTip": 0
    },
    "paymentMethod": "CASH",
    "orderStatus": {
      "incomplete": true,
      "accepted": false,
      "orderState": "INCOMPLETE"
    },
    "deliveryInstruction": "Ring the bell twice"
  }
]