About the Sales API

Sales are the core data entities consumed by our service to determine the donation amount of an order. These endpoints are designed to be used to sync created orders and refunds from your store’s online and POS channels.

If you are already integrated with a Content Management System "CMS", check out our Guides for steps on how to connect yours.

The following API endpoints are available:

SectionDescription
Create SaleCreates a sale.
Partial Return Order - No Line ItemsAssign a partial refund to an order with the new amount specified.
Partial Return Order - Current Line Item CountsAssign a partial refund to an order and calculate a new amount based on the remaining line item quantities provided.
Partial Return Order - Quantities ReturnedAssign a partial refund to an order and calculate a new amount based on the returned line item quantities or new amount provided.
Return orderAssign a full refund to an order.