Completed Orders

Returns a list of orders completed by a member in the past 24 hours. Returns at most 100 orders data at a time. To get more order data, one must paginate through the order list.

get/members/{companyId}/completedOrders

Request

  • Base URL
    https://api.shipday.com/partner
  • URL
    https://api.shipday.com/partner/members/{companyId}/completedOrders
  • Auth
    API key in header PARTNER-API-KEY

Path parameters

companyIdinteger required

Headers

PARTNER-API-KEYstring required

Response

200

orderIdinteger
orderNumberstring
companyIdinteger
orderItemstring
acceptedboolean
placementTimestring
requestedPickupTimestring
requestedDeliveryTimestring
assignedTimestring
startTimestring
pickedupTimestring
arrivedTimestring
deliveryTimestring
failedDeliveryTimeunknown
deliveryNotestring
deliveryInstructionstring
dispatcherNotestring
paymentMethodstring
orderSourcestring
incompleteboolean
orderTotalnumber
deliveryFeenumber
tipnumber
discountinteger
taxinteger
driverPaymentinteger
statusstring

Example response

[
  {
    "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",
    "deliveryInstruction": "Call my number when you arrive",
    "dispatcherNote": "rd",
    "paymentMethod": "CARD",
    "orderTotal": 13.4,
    "deliveryFee": 5.2,
    "tip": 1.3,
    "carrier": {
      "id": 7890,
      "name": "Jeff Minem",
      "phone": "+1234567890",
      "email": "jeffMinem@gmail.com",
      "status": "OFFLINE",
      "vehiclePlateNumber": "CA-1234",
      "vehicleDescription": "Black Chevy",
      "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",
      "lat": 37.4568076,
      "lng": -121.925089
    },
    "status": "ALREADY_DELIVERED"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.