Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Purchase Orders

List purchase orders

Endpoint used to list purchase order resources

get/purchaseorders

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Purchase Orders returned

updatedAt[gte]string date-time

Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
updatedAt[lte]string date-time

Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
createdAt[gte]string date-time

Return records whose createdAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
createdAt[lte]string date-time

Return records whose createdAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
customFieldNamestring[]

Filter purchase orders by custom field value. Your query parameter should be your custom field name. (ie: To filter by a custom field named "Industry" with the value "Construction", you would do this "/purchaseorders?Industry=Construction"). <br><br>Adding multiple instance of the same custom field act as an <code>OR</code> and adding a different custom field act as an <code>AND</code>. (ie: To filter by a custom field named <code>Industry</code> with the value <code>Construction</code> OR <code>Transportation</code> AND the custom field <code>Manufacturer</code> with the value <code>ACME</code>, you would do this <code>/purchaseorders?Industry=Construction&Industry=Transportation&Manufacturer=ACME</code>). <br><br>If your custom field label is the same as a reserved query parameter such as <code>limit</code>, <code>sort</code>, <code>expand</code>, etc, you can add <code>__c</code> to your custom field filtering (ie: To filter by a custom field named <code>limit</code> with the value <code>ten</code>, you would do this <code>/purchaseorders?limit__c=ten</code>). <br><br>Note that your custom field needs to be created beforehand. Only number and single line text custom field types are supported.

statusesstring[]

To filter by multiple statuses: statuses=APPROVED&statuses=COMPLETED

sort'id' | 'createdAt' | 'updatedAt' | '-id' | '-createdAt' | '-updatedAt'

Attribute on which to sort the list. (for descending order, prefix attribute with '-').

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Purchase Orders list

nextCursorstring nullable required

The cursor to retrieve the next page of Purchase Orders.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Purchase Orders.

Example response

{
  "purchaseOrders": [
    {
      "id": 135,
      "status": "APPROVED",
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "createdAt": "2022-01-01T00:00:00.000Z"
    }
  ]
}