Skip to main content
POST
Purchase order webhook (third-party integrations)

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Body

application/json
order_id
integer<int64>
required

Third-party (Order.co) order id

purchase_order_number
string
required

OpenWrench purchase order id, as a string

status
enum<string>
required
Available options:
approved,
rejected,
completed,
error,
shipping_update,
product_receipt_update
message
object

Status-specific payload; for shipping_update may carry courier, status, subtag_message, shipment_date, estimated_delivery, tracking_number, courier_tracking_link, first_attempted_at, shipment_delivery_date

Response

Processed. Body varies by webhook status branch.

type
string
required

Entity type label, e.g. "SupplierPurchaseOrder". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object
required

Supplier purchase order (hydrated location/brand/currency and deleted-line-item fields omitted).

status
enum<string>
required

"ok" on success

Available options:
ok