SAsamsara
Plans

Create orders in bulk

Create one or more orders (bulk upsert). Pass an array of order objects; any object whose customerOrderId already exists will be updated, otherwise a new order is created. Functions can return JSON arrays in this Order POST format. Orders are initially created at the plan level but will migrate to hub-level entities, with planId becoming optional in future versions.

<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 Write 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.

post/hub/plan/orders

Request

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

Request body

enableUpdateExistingOrdersboolean

Enable update of existing orders if an order with the same customerOrderId exists. The input must match the same quantity dimensions as the existing order. If not provided, requests will fail if an order's customerOrderId already exists.

Example request

{
  "data": [
    {
      "customProperties": [
        {
          "customPropertyId": "750e8400-e29b-41d4-a716-446655440004",
          "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",
      "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
        }
      ],
      "skillsRequired": [
        "650e8400-e29b-41d4-a716-446655440001",
        "650e8400-e29b-41d4-a716-446655440001",
        "650e8400-e29b-41d4-a716-446655440001",
        "650e8400-e29b-41d4-a716-446655440001"
      ]
    }
  ]
}

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"
    }
  ]
}

Changes

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