Inbound API
Clearing (Inbound)
For a real-time clearing process, the shopreme Outbound API offers the /liveClearing endpoint. If it is preferred to request several transactions on-demand, the /bulkClearingByDateRange endpoint can be used. Both clearing endpoints share the same underlying JSON data structure.
To lock or redeem vouchers/coupons, the /liveClearing endpoint needs to be used.
Both clearing endpoints share the same underlying JSON data structure.
/bulkClearing/{transactionId}
API documentation can be found here.
HTTP method: GET
Query parameter:
transactionId: The transactionId for which the transaction details are required.
Returns the basket and payment information for a specific transactionId. Functions like /bulkClearing but always returns exactly one result or none, following the usual /bulkClearing data structure.
/bulkClearing/daterange
API documentation can be found here.
HTTP method: GET
Query parameters :
fromDate: start date of the clearing period (inclusive)toDate: end date of the clearing period (inclusive)
Returns all completed transactions within the specified date range. fromDate and toDate refer to transactionEndDateTime and are inclusive.
Example: If fromDate = 2022-01-20 and toDate = 2022-01-25, all transactions from the beginning of 2022-01-20 to the end of 2022-01-25 will be returned.
Avoid including the current day in your clearing requests. This could include transactions that are scheduled to suffer changes by the end of the day, and the results may be misleading.
/bulkClearing
This endpoint has been deprecated. Please use the new /bulkClearing GET methods instead.
Retrieves details for one or more previously completed transactions. Avoid performing clearing for the current day. The field transactionId is a reference to the purchaseEvaluationReferences.transactionId from the “purchase evaluation” /evaluate request.
shopreme © 2025