[preview] Get orders

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

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Routes under the Driver Workflow category when creating or editing an API token. Learn More.

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.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
orderIds
array of strings
required

Comma-separated Samsara order UUIDs or external ID tokens. Maximum 100.

orderIds*
boolean
Defaults to false

Include external IDs in returned orders.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json