---
title: "[beta] List purchase orders"
method: GET
path: "/maintenance/purchase-orders"
tags: ["Beta APIs"]
---

# \[beta\] List purchase orders

`GET /maintenance/purchase-orders`

## Request

- Base URL: `https://api.samsara.com`
- URL: `https://api.samsara.com/maintenance/purchase-orders`
- Auth: HTTP bearer

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.

## Query parameters

- `ids` string
- `poNumbers` string
- `vendorIds` string
- `endTime` string
- `startTime` string, required
- `after` string
- `limit` integer

## Response `200`

OK response.

- EntityPurchaseOrdersServiceListPurchaseOrdersResponseBody
  - `data` EntityListPurchaseOrdersTypeResponseBody[], required: An array of PurchaseOrders
    - `createdAtTime` string: RFC3339 time when the purchase order was created.
    - `creationSource` 'Unknown' | 'User' | 'ScanPackingList': Source that created the purchase order. Valid values: `Unknown`, `User`, `ScanPackingList`
    - `deliveryAtTime` string: RFC3339 expected delivery time.
    - `firstReceivedAtTime` string: RFC3339 time when the first item was received.
    - `fullyReceivedAtTime` string: RFC3339 time when all items were received.
    - `glCode` string: General ledger code associated with this purchase order.
    - `id` string: Stable Samsara ID for the purchase order.
    - `invoiceNumber` string: Vendor invoice number associated with this purchase order.
    - `mediaItemIds` string[]: IDs of media items attached to the purchase order.
    - `notes` string: Free-text notes for the purchase order.
    - `orderStatus` 'Unknown' | 'Draft' | 'Open' | 'InReview' | 'Approved' | 'Rejected' | 'SentToVendor' | 'PartiallyReceived' | 'FullyReceived' | 'Returned' | 'Cancelled' | 'Closed': Current customer-visible status of the purchase order. Valid values: `Unknown`, `Draft`, `Open`, `InReview`, `Approved`, `Rejected`, `SentToVendor`, `PartiallyReceived`, `FullyReceived`, `Returned`, `Cancelled`, `Closed`
    - `otherCost` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
      - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
      - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
    - `parts` ListPurchaseOrdersEntityPurchaseOrderPurchaseOrderPartTypeResponseBody[]: Parts ordered on the purchase order.
      - `batchNumber` string: Batch or lot number for the ordered part.
      - `coreCharge` ListPurchaseOrdersEntityPurchaseOrderPurchaseOrderCoreChargeTypeResponseBody: PurchaseOrderCoreCharge object
        - `coreChargeStatus` 'Unknown' | 'Active' | 'RemovedOrDisabled': Whether the core charge is active or removed or disabled. Valid values: `Unknown`, `Active`, `RemovedOrDisabled`
        - `corePartSamsara` EntityListPurchaseOrdersPartDefinitionRefTypeResponseBody: Reference to a PartDefinition
          - `id` string, required: The ID of the referenced PartDefinition.
        - `recoverabilityPolicy` ListPurchaseOrdersEntityPurchaseOrderCoreRecoverabilityPolicyTypeResponseBody: CoreRecoverabilityPolicy object
          - `fixedRecoverableUntilTime` string: Absolute deadline for core return.
          - `policyType` 'Unknown' | 'RelativeToReceipt' | 'FixedDate' | 'NoDeadline': Recoverability policy type. Valid values: `Unknown`, `RelativeToReceipt`, `FixedDate`, `NoDeadline`
          - `relativeWindowDuration` integer: Duration after receipt when the core must be returned. Measured in milliseconds.
        - `returnRecipientVendor` EntityListPurchaseOrdersVendorRefTypeResponseBody: Reference to a Vendor
          - `id` string, required: The ID of the referenced Vendor.
        - `unitCoreAmount` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
          - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
          - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
      - `description` string: Description of the ordered part.
      - `lineItemId` string: Stable identifier for the purchase order line.
      - `partSamsara` EntityListPurchaseOrdersPartDefinitionRefTypeResponseBody: Reference to a PartDefinition
        - `id` string, required: The ID of the referenced PartDefinition.
      - `place` EntityListPurchaseOrdersPlaceRefTypeResponseBody: Reference to a Place
        - `id` string, required: The ID of the referenced Place.
      - `quantityOrdered` number, double: Quantity ordered on this line.
      - `quantityReceived` number, double: Quantity received on this line.
      - `tax` ListPurchaseOrdersEntityPurchaseOrderTaxAdjustmentTypeResponseBody: TaxAdjustment object
        - `basisPoints` integer: Tax rate in basis points. Set exactly one of money or basisPoints.
        - `money` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
          - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
          - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
      - `unitCost` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
        - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
        - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
      - `unitOfMeasureType` 'Unknown' | 'Each' | 'Set' | 'Pack' | 'Box' | 'Pound' | 'Kilogram' | 'Ounce' | 'Liter' | 'Milliliter' | 'Gallon' | 'Quart' | 'FluidOunce' | 'Inch' | 'Foot' | 'Meter' | 'Yard' | 'SquareFoot' | 'SquareMeter' | 'Pint' | 'Hundred' | 'Roll': Unit of measure for quantities on this line. Read-only: derived from the line's part definition, and ignored if supplied on create or update. Valid values: `Unknown`, `Each`, `Set`, `Pack`, `Box`, `Pound`, `Kilogram`, `Ounce`, `Liter`, `Milliliter`, `Gallon`, `Quart`, `FluidOunce`, `Inch`, `Foot`, `Meter`, `Yard`, `SquareFoot`, `SquareMeter`, `Pint`, `Hundred`, `Roll`
    - `poNumber` string: Customer-visible purchase order number.
    - `poNumberPrefix` string: Optional prefix included in the purchase order number.
    - `poNumberSuffix` string: Optional suffix included in the purchase order number.
    - `sentAtTime` string: RFC3339 time when the purchase order was sent to its vendor.
    - `tax` ListPurchaseOrdersEntityPurchaseOrderTaxAdjustmentTypeResponseBody: TaxAdjustment object
      - `basisPoints` integer: Tax rate in basis points. Set exactly one of money or basisPoints.
      - `money` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
        - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
        - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
    - `taxTotal` ListPurchaseOrdersEntityPurchaseOrderMoneyTypeResponseBody: Money object
      - `amount` string: Monetary amount as a decimal string in major currency units (e.g. "24.50").
      - `currency` string: ISO 4217 currency code, lowercased (e.g. "usd").
    - `trackingNumber` string: Shipment tracking number for the purchase order.
    - `updatedAtTime` string: RFC3339 time when the purchase order was last updated.
    - `vendor` EntityListPurchaseOrdersVendorRefPublicVariant07ae4b76c2baTypeResponseBody: Reference to a Vendor
      - `id` string, required: The ID of the referenced Vendor.
  - `pagination` GoaPaginationResponseResponseBody, required: Pagination parameters.
    - `endCursor` string, required: Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.
    - `hasNextPage` boolean, required: True if there are more pages of results immediately available after this endCursor.

## Other responses

- `401`: Unauthorized response.
- `404`: Not Found response.
- `405`: Method Not Allowed response.
- `413`: Content Too Large response.
- `429`: Too Many Requests response.
- `500`: Internal Server Error response.
- `501`: Not Implemented response.
- `502`: Bad Gateway response.
- `503`: Service Unavailable response.
- `504`: Gateway Timeout response.
- `default`: Bad Request response.

---

[API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)