93
RepairOrders API
The primary tables available in MYPOS for Repairs are RepairOrders and RepairOrderItems. Obtain the Auth token in the normal way for the database and then :
If you know a specific Service Order Number you can retrieve it via
End Point: https://api.myposconnect.com/api/v2/repairorders/item?sServiceOrder={serviceordernumber}
Verb: GET
Example Call 1: https://api.myposconnect.com/api/v2/repairorders/item?sServiceOrder=8140953649
Return Codes: 200 for success, with the body containing the JSON for the sale items. For other possible (more general) return codes please see API Build Basics
Important: Replace the “{serviceordernumber}” marker in the given endpoint URL with a valid service order number
If you know a specific Serial Number you can retrieve it via
End Point: https://api.myposconnect.com/api/v2/repairorders?filt_serialnumber_str={serialnumber}
NOTICE This end point differs from the Service order number retrieval above, this is because there maybe more than one service order for a serial number.
Verb: GET
Example Call 1: https://api.myposconnect.com/api/v2/repairorders?filt_serialnumber_str=ABC-DE-FGH999J
Return Codes: 200 for success, with the body containing the JSON for the sale items. For other possible (more general) return codes please see API Build Basics
Important: Replace the “{serialnumber}” marker in the given endpoint URL with a valid serial number. A null return means no repairs for that serial number.
If you want to retrieve all Service Orders, regardless of status
End Point: https://api.myposconnect.com/api/v2/repairorders
NOTICE This end point differs from the Service order number retrieval above, this is because there maybe more than one service order for a serial number.
Verb: GET
Example Call 1: https://api.myposconnect.com/api/v2/repairorders
Return Codes: 200 for success, with the body containing the JSON for the sale items. For other possible (more general) return codes please see API Build Basics
Example JSON Object
Example Repair Order list
|
|---|
To get all of the item details, safety checks and fault codes
Once you have the repair, from either the Service Order Number or from the Serial Number you will have the repairOrderId
To retrieve all the details for a Service Order including the items and safety checks
End Point: https://api.myposconnect.com/api/v2/repairorders/{repairorderid}
Verb: GET
Example Call 1: https://api.myposconnect.com/api/v2/repairorders/xx0x3410-3171-4749-89xx-08f06x40xxxx
Return Codes: 200 for success, with the body containing the JSON for the sale items. For other possible (more general) return codes please see API Build Basics
To retrieve the sales receipt related to a Service Order
End Point: https://api.myposconnect.com/api/v2/saleitems/receipt-detailed?uiRepairOrderId={repairorderid}
Verb: GET
Example Call 1: https://api.myposconnect.com/api/v2/saleitems/receipt-detailed?uiRepairOrderId=xx0x3410-3171-4749-89xx-08f06x40xxxx
Return Codes: 200 for success, with the body containing the JSON for the sale items. For other possible (more general) return codes please see API Build Basics
A Null return will indicate no sales for that service order id.
