# Returns

Order object array `Array`

Array of [order objects](https://docs.shipday.com/reference/partner-order-object) with all details.

Supported status types for the `orderStatus` attribute are:

| Supported Status Enum values |
| --- |
| ACTIVE |
| NOT_ASSIGNED |
| NOT_ACCEPTED |
| NOT_STARTED_YET |
| STARTED |
| PICKED_UP |
| READY_TO_DELIVER |
| ALREADY_DELIVERED |
| FAILED_DELIVERY |
| INCOMPLETE |

Note: ACTIVE orders are those which are neither ALREADY_DELIVERED nor FAILED_DELIVERY nor INCOMPLETE

## Parameters

- **companyId**:  
  `string`  
  required  
  Defaults to 1234, 12345, 1236  
  Single long value or comma separated long values inside quote for querying multiple companies.  
  Examples: 1234 or "1234, 1235, 1236" or "1234"

- **startTime**:  
  `date`  
  Defaults to 2021-02-01T23:00:00Z  
  ISO-8601 format date-time in UTC. Starting point of the time range query  
  **Default:** 24 hours past from now

- **endTime**:  
  `date`  
  Defaults to 2021-04-05T13:42:23Z  
  ISO-8601 format date-time in UTC. Ending point of the time range query.  
  **Default:** current time

- **startCursor**:  
  `int32`  
  Defaults to 1  
  Starting pointer of the retrieved order list. This marker is used for paginating the result.  
  **Default:** 1

- **endCursor**:  
  `int32`  
  Defaults to 25  
  Ending pointer of the retrieved order list. This marker is used for paginating the result.  
  **Default:** 100

- **orderStatus**:  
  `string`  
  enum  
  Defaults to ACTIVE  
  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`  
  Defaults to TEST#234Manhattan23  
  Pickup identifier. It needs to be exact match with case-sensitivity.

- **PARTNER-API-KEY**:  
  `string`  
  required  
  Defaults to <partner api key>

- **accept**:  
  `string`  
  enum  
  Defaults to application/json  
  Allowed: `application/json` `text/plain`

## Responses

### `200`  
array of objects

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

### Error Responses

### `400`  
### `401`  
### `415`

## Example curl request

```
curl --request POST \
     --url https://api.shipday.com/partner/orders \
     --header 'PARTNER-API-KEY: <partner api key>' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "companyId": "1234, 12345, 1236"
}
'
```

## Example response

```json
[
  {
    "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,
    "tax": 0,
    "driverPayment": 0,
    "carrier": {
      "id": 7890,
      "name": "Jeff Minem",
      "phone": "+1234567890",
      "email": "jeffMinem@gmail.com",
      "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.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",
      "email": "",
      "lat": 37.4568076,
      "lng": -121.925089
    },
    "status": "ALREADY_DELIVERED"
  }
]
```