ZUzuper

Get Purchase Orders

Changed on

Operates on Purchase Orders. In the Zuper client app this module is labeled "Purchase Order" for most companies, and "Material Order" for companies in the roofing industry — the API and data shape are identical either way. Purchase Orders and Work Orders (Service Orders) share the exact same underlying schema and endpoints; they're distinguished only by the purchase_order_type field (PURCHASE_ORDER here) and the /purchase_orders vs /service_orders route prefix. purchase_order_type is always enforced server-side based on this route; you cannot use this endpoint to read the other module's records.

get/purchase_orders

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/purchase_orders
  • Auth
    API key in header x-api-key

Query parameters

filter.keywordstring
filter.is_activestring
filter.vendorstring

vendor_uid

filter.created_from_datestring date
filter.created_to_datestring date
filter.due_from_datestring date
filter.due_to_datestring date
filter.purchase_order_from_datestring date
filter.purchase_order_to_datestring date
filter.created_bystring

user uid

filter.statusstring
filter.updated_at_fromstring date
filter.updated_at_tostring date
filter.jobstring

Job uid

filter.estimatestring

Quote uid

filter.reference_numberstring
filter.purchase_order_numberstring
filter.await_approval_fromstring
filter.purchase_order_uidstring
pagestring

Default "1".

limitstring

Default "10". Also accepts count as an alias.

sortstring

"ASC" or "DESC", default "DESC" (by created_at).

cursorstring

Opaque cursor for cursor-based pagination.

prev_cursorstring

Opaque cursor for the previous page.

cursor_paginationstring

Set to enable cursor-based pagination instead of offset pagination.

include_deletedstring

Set to include soft-deleted records.

fields_to_selectstring

Sparse fieldset selector.

filter.projectstring

Project UID.

filter.assetstring

Asset UID.

filter.material_requeststring

Material Request UID.

filter.appointment_uidstring

Comma-separated appointment UIDs.

filter.parent_postring
filter.current_delivery_statusstring
filter.supplier_order_refstring
filter.delivery_methodstring

Response

200

type'success'
messagestring
dataobject[]
total_recordsinteger
current_pageinteger
total_pagesinteger

Changes

  • 3c21bc232e16Revision changes
    • info

      added the new optional query request parameter cursor

    • info

      added the new optional query request parameter cursor_pagination

    • info

      added the new optional query request parameter fields_to_select

    • info

      added the new optional query request parameter filter.appointment_uid

    • info

      added the new optional query request parameter filter.asset

    • info

      added the new optional query request parameter filter.current_delivery_status

    • info

      added the new optional query request parameter filter.delivery_method

    • info

      added the new optional query request parameter filter.material_request

    • info

      added the new optional query request parameter filter.parent_po

    • info

      added the new optional query request parameter filter.project

    • info

      added the new optional query request parameter filter.supplier_order_ref

    • info

      added the new optional query request parameter include_deleted

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter prev_cursor

    • info

      added the new optional query request parameter sort

    • info

      added the media type application/json for the response with the status