Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

get_cancel_orders – Get Cancelled Orders

Work orders that have been canceled will be available with the get_cancel_orders event. The timestamp value in the event data is required for this event call. The timestamp cannot be greater than 30 days in the past.

FieldTypeDescription
timestampstringUnix timestamp

Request payload JSON

curl -X POST \
  --data 'payload={
    "username": "demo",
    "password": "da39a3ee5e6b4b0d3255bfef95601890afd80709",
    "site_id": "dcc363d0-8ed1-48a2-ba2e-f638275db4f",
    "event_name": "get_cancel_orders",
    "event_data": "{\"timestamp\":\"1491699142\"}"
  }' \
  https://www.propertypreswizard.com/api/link/receiver.php

Response JSON

{
  "remote_site_id": "1fc25d06-72bd-42f8-ad34-ecbdc5f1a4a4",
  "success": true,
  "error": false,
  "return_error_msg": null,
  "result_data": [{
      "report_id": "12255349",
      "wo_number": "PPWTEST3",
      "org_wo_num": "44309",
      "wo_status": "Cancelled",
      "cancel_timestamp": "1529897535"
    },
    {
      "report_id": "12255376",
      "wo_number": "PPWTEST12",
      "org_wo_num": "44336",
      "wo_status": "Cancelled",
      "cancel_timestamp": "1529895967"
    }
  ]
}
Field NameType/LengthDescription
report_idnumberThe unique id of the order. Must be an integer.
wo_numberstringThe work order number displayed to the user.
org_wo_numnumberNot required. Is not used.
wo_statusstringFor new orders, should be set to Unread
cancel_timestampstringUnix timestamp the order was cancelled