Central Transaction Repository (CTR) API

What is CTR?

Central Transaction Repository (CTR) is a centralized long-term storage that allows you to store, retrieve and maintain transactions details (documents) from various touchpoints across the Retail Management Platform or any third-party POS systems.

CTR APIs

Central Transaction Repository (CTR) API integrates the Vynamic Retail Platform applications or any third-party POS systems with the Central Transaction Repository (CTR) storage. It provides the following features:

  • Storing transaction details in CTR.
  • Retrieving a list of stored POS transactions or documents from CTR.
  • Retrieving from CTR the extended information on the stored POS transactions or documents, including their derivative documents.
  • Retrieving stored POS transactions or documents from CTR in raw or unified format.
  • Retrieving stored POS transactions or documents from CTR by ctrTransactionId in raw or unified format.
  • Retrieving raw or unified information for a list of documents.
  • Reloading of raw documents for processing into the unified format (from Cold Storage to Hot Storage) based on a list of CTR identifiers.
  • Reloading of unified documents for reporting purposes from Hot Storage to the reporting database based on a list of CTR identifiers.
  • Retrieving collection of average sales for specified shop items.
  • Retrieving collection of future movements for specified shop items.
  • Retrieving the number of transactions for a business unit per chosen date range.
  • Managing CTR's export configurations, so that only documents which meet the criteria are exported from CTR.
  • Registering process codes in CTR and assigning process flag values to specific documents.
  • Checking of the process code existence and retrieving documents with a specific process code and the CTR document Id (ctrTransactionId) value.
  • Generating reports configured in CTR by adding certain parameters, according to a list of predefined report types.
  • Storing information about events, and retrieving them for auditing purposes.
  • Extracting all unified documents in a single .zip file by using the respective filters.