SAsamsara
Beta APIs

[beta] List orders for a specific plan

Retrieve all orders for a specific plan, including both assigned and unassigned orders.

Beta: This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have RoutePlanning APIs enabled for your organization.

<b>Rate limit:</b> 10 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>

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.

get/hub/plan/orders

Request

  • Base URL
    https://api.samsara.com
  • Auth
    HTTP bearer

Query parameters

planIdstring required

The plan identifier

orderIdsstring

Comma-separated list of order IDs for filtering.

afterstring

If specified, should be the endCursor from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limitinteger

Maximum number of objects to return. Default and maximum is 100

Response

OK response.

Example response

{
  "data": [
    {
      "createdAtTime": "2024-04-10T11:30:00Z",
      "customProperties": [
        {
          "customPropertyId": "750e8400-e29b-41d4-a716-446655440004",
          "name": "CustomerType",
          "value": "Premium"
        }
      ],
      "customerOrderId": "ORDER-2024-001",
      "delivery": {
        "address": "123 Business Way, San Francisco",
        "appointmentWindow": {
          "endTime": "2024-04-10T17:00:00Z",
          "startTime": "2024-04-10T09:00:00Z"
        },
        "customerLocationId": "LOC-123",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "notes": "Use main entrance",
        "position": "first",
        "serviceTimeSeconds": 600
      },
      "hubId": "550e8400-e29b-41d4-a716-446655440000",
      "id": "a50e8400-e29b-41d4-a716-446655440006",
      "pickup": {
        "address": "123 Business Way, San Francisco",
        "appointmentWindow": {
          "endTime": "2024-04-10T17:00:00Z",
          "startTime": "2024-04-10T09:00:00Z"
        },
        "customerLocationId": "LOC-123",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "notes": "Use main entrance",
        "position": "first",
        "serviceTimeSeconds": 600
      },
      "planId": "650e8400-e29b-41d4-a716-446655440023",
      "priority": 1,
      "quantities": [
        {
          "capacityId": "850e8400-e29b-41d4-a716-446655440003",
          "quantity": 25.5
        }
      ],
      "routeId": "950e8400-e29b-41d4-a716-446655440005",
      "skillsRequired": [
        "650e8400-e29b-41d4-a716-446655440001",
        "650e8400-e29b-41d4-a716-446655440001"
      ],
      "updatedAtTime": "2024-04-10T11:30:00Z"
    }
  ],
  "pagination": {
    "endCursor": "YXJyYXljb25uZWN0aW9uOjEwMA=="
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.