Purchase Order Bulk Action

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. Only action: "update_status" is currently supported. The action is processed asynchronously by a background worker — this endpoint acknowledges the request immediately; it does not confirm that every order was updated by the time it responds.

post/purchase_orders/bulk_action

Request

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

Request body

purchase_order_uidstring[]

UIDs to target. Alternative to filter_rules.

filter_rulesobject[]

Rule-engine filter, alternative to purchase_order_uid.

filter_rule_operator'AND' | 'OR'
action'update_status' required

Response

200

type'success'
titlestring
messagestring

Changes