SAsamsara
Beta APIs

[beta] List purchase orders

Returns a paginated list of purchase orders ordered by last update time.

<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 Purchase Orders 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/purchase-orders

Request

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

Query parameters

idsstring

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

poNumbersstring

A filter on the data based on this comma-separated list of PO number values.

vendorIdsstring

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

endTimestring

Optional end of the updated time range, exclusive. Defaults to the server's current time.

startTimestring required

Required start of the updated time range, inclusive.

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": [
    {
      "createdAtTime": "2019-06-13T19:08:25Z",
      "creationSource": "Unknown",
      "deliveryAtTime": "2019-06-13T19:08:25Z",
      "firstReceivedAtTime": "2019-06-13T19:08:25Z",
      "fullyReceivedAtTime": "2019-06-13T19:08:25Z",
      "glCode": "12345",
      "id": "281474976710656",
      "invoiceNumber": "12345",
      "mediaItemIds": [
        "12345",
        "12345",
        "12345",
        "12345"
      ],
      "notes": "12345",
      "orderStatus": "Unknown",
      "otherCost": {
        "amount": "12345",
        "currency": "12345"
      },
      "parts": [
        {
          "batchNumber": "12345",
          "coreCharge": {
            "coreChargeStatus": "Unknown",
            "corePartSamsara": {
              "id": "281474976710656"
            },
            "recoverabilityPolicy": {
              "fixedRecoverableUntilTime": "2019-06-13T19:08:25Z",
              "policyType": "Unknown",
              "relativeWindowDuration": 12345
            },
            "returnRecipientVendor": {
              "id": "281474976710656"
            },
            "unitCoreAmount": {
              "amount": "12345",
              "currency": "12345"
            }
          },
          "description": "12345",
          "lineItemId": "12345",
          "partSamsara": {
            "id": "281474976710656"
          },
          "place": {
            "id": "281474976710656"
          },
          "quantityOrdered": 123.45,
          "quantityReceived": 123.45,
          "tax": {
            "basisPoints": 12345,
            "money": {
              "amount": "12345",
              "currency": "12345"
            }
          },
          "unitCost": {
            "amount": "12345",
            "currency": "12345"
          },
          "unitOfMeasureType": "Unknown"
        }
      ],
      "poNumber": "PO-1001",
      "poNumberPrefix": "12345",
      "poNumberSuffix": "12345",
      "sentAtTime": "2019-06-13T19:08:25Z",
      "tax": {
        "basisPoints": 12345,
        "money": {
          "amount": "12345",
          "currency": "12345"
        }
      },
      "taxTotal": {
        "amount": "12345",
        "currency": "12345"
      },
      "trackingNumber": "12345",
      "updatedAtTime": "2019-06-13T19:08:25Z",
      "vendor": {
        "id": "281474976710656"
      }
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Changes

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