---
title: "[preview] Get orders"
method: GET
path: "/preview/fleet/orders"
tags: ["Preview APIs"]
---

# \[preview\] Get orders

`GET /preview/fleet/orders`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/preview/fleet/orders`
- Auth: HTTP bearer

Returns current canonical order state for up to 100 supplied order IDs.

 <b>Rate limit:</b> 5 requests/sec (learn more about rate limits <a href="https://developers.samsara.com/docs/rate-limits" target="_blank">here</a>).

To use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. <a href="https://developers.samsara.com/docs/authentication#scopes-for-api-tokens" target="_blank">Learn More.</a>

Endpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications

- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.

- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).
 

 **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our <a href="https://forms.gle/zkD4NCH7HjKb7mm69" target="_blank">API feedback form</a>. If you encountered an issue or noticed inaccuracies in the API documentation, please <a href="https://www.samsara.com/help" target="_blank">submit a case</a> to our support team.

## Query parameters

- `orderIds` string[], required
- `includeExternalIds` boolean

## Response `200`

OK response.

- OrdersGetOrdersResponseBody
  - `data` FleetOrderObjectResponseBody[], required: Requested live orders.
    - `createdAtTime` string, date-time, required: Creation timestamp in RFC 3339 format.
    - `customerProperties` FleetOrderCustomerPropertyObjectResponseBody[], required: Order-specific customer metadata.
      - `key` string, required: Customer-defined property key.
      - `value` string, required: Customer-defined property value.
    - `externalIds` object: Org-scoped external identifiers.
    - `id` string, required: Samsara-generated canonical order UUID.
    - `samsaraCustomerOrderName` string: Human-readable order label.
    - `tasks` FleetOrderTaskObjectResponseBody[], required: Live order tasks.
      - `createdAtTime` string, date-time, required: Creation timestamp in RFC 3339 format.
      - `customerProperties` FleetOrderCustomerPropertyObjectResponseBody[], required: Task-specific customer metadata.
        - `key` string, required: Customer-defined property key.
        - `value` string, required: Customer-defined property value.
      - `dispatcherNotes` string: Dispatcher-visible note.
      - `driverNotes` string: Driver-visible note.
      - `hubId` string, required: Hub UUID for the task.
      - `id` string, required: Opaque task ID.
      - `positionConstraintType` 'unknown' | 'none' | 'first' | 'last', required: Task position constraint. Valid values: `unknown`, `none`, `first`, `last`
      - `quantities` FleetOrderQuantityObjectResponseBody[], required: Task quantities.
        - `capacityId` string: Capacity UUID when this quantity uses a configured capacity.
        - `id` string, required: Opaque quantity UUID.
        - `label` string, required: Human-readable quantity label.
        - `value` number, double, required: Quantity value.
      - `routeId` string: Route ID when this task is attached to a route.
      - `serviceDurationSeconds` integer: Expected service duration in seconds.
      - `serviceLocation` FleetOrderServiceLocationObjectResponseBody: A saved, one-time, or unknown task service location.
        - `addressId` string: Saved address ID.
        - `customAddress` FleetOrderCustomAddressObjectResponseBody: A one-time structured service address.
          - `addressLine1` string: First address line.
          - `addressLine2` string: Second address line.
          - `city` string: City.
          - `country` string: Country.
          - `formattedAddress` string: Human-readable formatted address.
          - `latitude` number, double: Latitude in decimal degrees.
          - `longitude` number, double: Longitude in decimal degrees.
          - `postalCode` string: Postal code.
          - `state` string: State, province, or region.
        - `serviceLocationType` 'unknown' | 'savedAddress' | 'customAddress', required: Location discriminator. Returns unknown when the backend location variant is not recognized. Valid values: `unknown`, `savedAddress`, `customAddress`
      - `serviceWindows` FleetOrderServiceWindowObjectResponseBody[], required: Task service windows.
        - `endTime` string, date-time: Service window end in RFC 3339 format.
        - `id` string, required: Opaque service window UUID.
        - `startTime` string, date-time: Service window start in RFC 3339 format.
      - `taskType` 'unknown' | 'delivery' | 'pickup' | 'pickupDelivery', required: Task type. Valid values: `unknown`, `delivery`, `pickup`, `pickupDelivery`
      - `updatedAtTime` string, date-time, required: Last update timestamp in RFC 3339 format.
    - `updatedAtTime` string, date-time, required: Last update timestamp in RFC 3339 format.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)