SHshipday

Orders Query

Returns a list of orders as per the defined query request object.

post/orders

Request

  • Base URL
    https://api.shipday.com/partner
  • URL
    https://api.shipday.com/partner/orders
  • Auth
    API key in header PARTNER-API-KEY

Headers

PARTNER-API-KEYstring required

Request body

companyIdstring required

Single long value or comma separated long values inside quote for querying multiple companies.<br/><br/> Examples: 1234 or "1234, 1235, 1236" or "1234"

startTimestring date

ISO-8601 format date-time in UTC. Starting point of the time range query <br/><br/><strong>Default:</strong>24 hours past from now

endTimestring date

ISO-8601 format date-time in UTC. Ending point of the time range query. <br/><br/><strong>Default:</strong> current time

startCursorinteger

Starting pointer of the retrieved order list. This marker is used for paginating the result.<br/><br/><strong>Default:</strong> 1

endCursorinteger

Ending pointer of the retrieved order list. This marker is used for paginating the result. In combination with the startCursor it will determine which rows to return. <br/><br/> For example, startCursor=26 and endCursor=50 will return 25 orders data ranging from 26th to 50th rows sorted in descending order of order placement time having the most recent one at the top.<br/><br/><strong>Default:</strong> 100

orderStatus'ACTIVE' | 'NOT_ASSIGNED' | 'NOT_ACCEPTED' | 'NOT_STARTED_YET' | 'STARTED' | 'PICKED_UP' | 'READY_TO_DELIVER' | 'ALREADY_DELIVERED' | 'FAILED_DELIVERY' | 'INCOMPLETE'

Indicates what category of orders to retrieve.

carrierIdstring

Single long value or comma separated long values inside quote for querying multiple assigned carriers.

pickupIdstring

Pickup identifier. It needs to be exact match with case-sensitivity.

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.