---
title: "Orders Query"
method: POST
path: "/orders"
---

# Orders Query

`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`

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

## Headers

- `PARTNER-API-KEY` string, required

## Request body

- object
  - `companyId` string, 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"
  - `startTime` string, 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
  - `endTime` string, date: ISO-8601 format date-time in UTC. Ending point of the time range query. <br/><br/><strong>Default:</strong> current time
  - `startCursor` integer: Starting pointer of the retrieved order list. This marker is used for paginating the result.<br/><br/><strong>Default:</strong> 1
  - `endCursor` integer: 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.
  - `carrierId` string: Single long value or comma separated long values inside quote for querying multiple assigned carriers.
  - `pickupId` string: Pickup identifier. It needs to be exact match with case-sensitivity.

## Response `200`

200

- object[]
  - `orderId` integer
  - `orderNumber` string
  - `companyId` integer
  - `orderItem` string
  - `accepted` boolean
  - `placementTime` string
  - `requestedPickupTime` string
  - `requestedDeliveryTime` string
  - `assignedTime` string
  - `startTime` string
  - `pickedupTime` string
  - `arrivedTime` string
  - `deliveryTime` string
  - `failedDeliveryTime` unknown
  - `deliveryNote` string
  - `deliveryInstruction` string
  - `dispatcherNote` string
  - `paymentMethod` string
  - `orderSource` string
  - `incomplete` boolean
  - `orderTotal` number
  - `deliveryFee` number
  - `tip` number
  - `discount` integer
  - `tax` integer
  - `driverPayment` integer
  - `carrier` object
    - `id` integer
    - `name` string
    - `phone` string
    - `email` string
    - `status` string
    - `vehiclePlateNumber` string
    - `vehicleDescription` string
    - `note` unknown
    - `imageUrl` unknown
    - `partner` string
  - `pickup` object
    - `id` integer
    - `name` string
    - `address` string
    - `formattedAddress` string
    - `phone` string
    - `lat` number
    - `lng` number
  - `delivery` object
    - `id` integer
    - `name` string
    - `address` string
    - `formattedAddress` string
    - `phone` string
    - `email` string
    - `lat` number
    - `lng` number
  - `status` string

## Other responses

- `400`: 400
- `401`: 401
- `415`: 415

---

[API](https://skmtc.dev/shipday/apis/partner.md) - [All operations](https://skmtc.dev/shipday/apis/partner/llms.txt) - [OpenAPI document](https://skmtc.dev/shipday/apis/partner/revisions/eb40cf6d37dc?raw)