ZUzuper

Update Purchase Order

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. All fields are optional (partial update semantics), but the full purchase_order wrapper object is still expected. Only allowed while the order is in an editable status; some statuses restrict edits to line_items only.

put/purchase_orders/{purchase_order_uid}

Request

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

Path parameters

purchase_order_uidstring required

Request body

Response

200

type'success' required
titlestring required

Exact wording is "Purchase Order" for most companies, or "Material Order" for roofing-industry companies.

messagestring required

Exact wording is "Purchase Order" for most companies, or "Material Order" for roofing-industry companies.

Changes

  • 3c21bc232e16Revision changes
    • breaking

      request property / was restricted to a list of enum values

    • breaking

      request property /// was restricted to a list of enum values

    • breaking

      request property /// was restricted to a list of enum values

    • breaking

      the / request property type changed from string to array

    • breaking

      the / request property type changed from string to array

    • warning

      removed the request property /

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property //

    • info

      the request property default value ITEM was added

    • info

      added the new BUNDLE enum value to the request property ///

    • info

      added the new GROUP enum value to the request property ///

    • info

      added the new HEADER enum value to the request property ///

    • info

      added the new ITEM enum value to the request property ///

    • info

      added the new JOB_ADDRESS enum value to the request property /

    • info

      added the new LABOR enum value to the request property ///

    • info

      added the new PARTS enum value to the request property ///

    • info

      added the new PARTS enum value to the request property ///

    • info

      added the new PICKUP enum value to the request property /

    • info

      added the new PRODUCT enum value to the request property ///

    • info

      added the new SERVICE enum value to the request property ///

    • info

      added the new WAREHOUSE enum value to the request property /

    • info

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