Maintenance

List part transactions

Returns a paginated, time-windowed feed of inventory transactions (an append-only parts audit log) for the organization, ordered by the time each transaction occurred.

<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 Parts under the Work Orders 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/maintenance/parts/transactions

Request

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

Query parameters

happenedAtTimeStartstring required

A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

happenedAtTimeEndstring

An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).

partSamsaraIdsstring

A filter on the data based on this comma-separated list of Part Samsara ID values.

placeIdsstring

A filter on the data based on this comma-separated list of Place ID values.

transactionTypeInstring

A filter on the data based on this comma-separated list of Transaction Type values.

afterstring

If specified, this should be the endCursor value 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

The limit for how many objects will be in the response. Default and max for this value is 200 objects.

Response

OK response.

Example response

{
  "data": [
    {
      "batch": "12345",
      "createdAtTime": "2019-06-13T19:08:25Z",
      "createdByUserId": "12345",
      "fromPlaceId": "12345",
      "happenedAtTime": "2019-06-13T19:08:25Z",
      "id": "12345",
      "notes": "12345",
      "part": {
        "id": "281474976710656"
      },
      "placeId": "12345",
      "purchaseOrder": "12345",
      "quantity": 123.45,
      "resultingQuantity": 123.45,
      "toPlaceId": "12345",
      "transactionType": "Unknown",
      "unitCost": 123.45,
      "vendorId": "12345",
      "workOrder": {
        "id": "281474976710656"
      }
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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