40
Purchase Orders API
There are five methods available for purchase orders:
- List all purchase orders
- Return full detail on a single purchase order
- Add a purchase order
- Update an existing purchase order
- Delete (make inactive) a purchase order depending on status
List all purchase orders
End Point: https://api.myposconnect.com/api/v2/purchaseorders
Verb: GET
Example Call: https://api.myposconnect.com/api/v2/purchaseorders?filt_LastEditDateUTC_dt_min=2022-mar-04%2009%3a00&filt_LastEditDateUTC_dt_max=2022-mar-10%2009%3a00
Return Codes: 200 for success, with the body containing the JSON for the orders. For other possible (more general) return codes please see API Build Basics
Important: This call returns a restricted flat view of the orders. The JSON objects in the array are not full order JSON objects as shown in the appendices of this document. If some of the deeper information is required then you will need to use the method for getting a single order object below. There are several query string arguments that can be used with this call as follows (you may need to URL encode your argument values).
Filters:
There are several query string arguments that can be used with this call as follows (you may need to URL encode your argument values).
|
filt_LastEditDate_dt_min |
Optional Local Device DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. Example value of “2020-oct-06 11:10” would be URL encoded to “2020-oct-06%2011%3a10”. |
|
filt_LastEditDate_dt_max |
Optional Local Device DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. |
|
filt_LastEditDateUTC_dt_min |
Optional UTC DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. Example value of “2020-oct-06 11:10” would be URL encoded to “2020-oct-06%2011%3a10”. |
|
filt_LastEditDateUTC_dt_max |
Optional UTC DateTime String (yyyy-MMM-dd HH:mm) – use to filter results by the “LastEditDateUTC” property. |
|
filt_XXXXXXX_XXX |
Other filtering query string arguments may be available if requested, please let us know at [email protected]. |
Return full detail on a single purchase order
End Point: https://api.myposconnect.com/api/v2/purchaseorders/{identifier}
Verb: GET
Return Codes: 200 for success, with the body containing the JSON for the order. For other possible (more general) return codes please see API Build Basics
Important: This call returns a view of a single order and related fields including custom fields tailored for individual MYPOS clients.
Example JSON Object
Single Purchase Order
|
|---|
Add a Purchase Order
End Point: https://api.myposconnect.com/api/v2/purchaseorders/{PurchaseOrderNo}
Verb: POST
Return Codes: 202 (Accepted) for success and the body will contain a copy of your JSON object with populated “purchaseorderId” and “purchaseorderNo” fields. 400 (BadRequest) for failure, see the body for more details. For other possible (more general) return codes please see API Build Basics
Important: Post a valid JSON object as shown in the appendices of this document. You can omit a lot of the fields from the JSON if you have no values for them. The “purchaseorderId” field will be automatically generated by the system when adding so do not supply in your JSON for this call as it will be ignored.
Update an existing purchase order
End Point: https://api.myposconnect.com/api/v2/purchaseorders/{PurchaseOrderNo}
Verb: PUT
Return Codes: 200 (OK) for success. 400 (BadRequest) for failure, see the body for more details. For other possible (more general) return codes please see API Build Basics
Important: Replace the “{purchaseorderNo}” marker in the given endpoint URL with the code of the purchase order you wish to update – you must also ensure the “puchaseorderId” and “purchaseorderNo” fields are correctly populated for the purchase order you wish to update. To ensure no data is lost please call the GET method to get the purchase order first, make your modifications to it, and then use this PUT method to save the changes back. A future release of the API may introduce the PATCH verb but it is not available currently.
Delete a purchase order
End Point: https://api.myposconnect.com/api/v2/purchaseorders/{PurchaseOrderNo}
Verb: DELETE
Return Codes: 204 (No content) for success. 404 if not found. 409 (Conflict) for failure (the body may indicate that the order has been set to inactive). For other possible (more general) return codes please see API Build Basics
Important: Replace the “{PurchaseOrderNo}” marker in the given endpoint URL with the code of the order you wish to delete. If order has transactions such as receipts you can only make them inactive with this operation.
Troubleshooting Ideas
As with all API connections, you will need to have acquired a bearer token and the user that acquired the token will need to be assigned access permission to this table. If you are not receiving any results send the full endpoint together with any filters and the API user to us from a valid email address and we can advise if permissions have been authorised. You might be able to see data with one table and not another if specific permissions are not applied. Check your filter dates if collecting all rows.
