Receipts API

‍

The Receipts API is the best way to collect and download new sales.

Use the receipts api to get the receipts and combine this with calls to the SaleItems, Customers, Users, Devices and Stores API to get all of the detail required.

‍

There is one method available for receipts :

1. List receipts

‍

List receipts

End Point: https://api.myposconnect.com/api/v2/saleitems/receipts

Verb: GET

Example Call: https://api.myposconnect.com/api/v2/saleitems/receipts?OnlyHomeDeliv=false&creationdateutcmin=2022-mar-23%2015%3a10&creationdateutcmax=2022-mar-31%2016%3a14%3a23 

Return Codes: 200 for success, with the body containing the JSON for the new sales receipts. For other possible (more general) return codes please see API Build Basics

Notes: This is a utility method to retrieve the receiptId’s and associated customerId. You can optionally filter down the results with a query string argument for the customerId as shown in the example call.

- OnlyHomeDeliv (set to "true" if you want home delivery orders only)

- CustomerId

- CreationDateUTCMin

- CreationDateUTCMax

‍

Example JSON Object

Receipt List    {        "receiptId": "55598788-a5a1-43d2-893a-008185cffe70",        "customerId": "8dd555fa-7cc7-4829-893c-0885ef95b10a",        "customerCode": "POS55555,7059207986"    }

‍

‍