Restoke Export Overview
This document will contain information specific to the Restoke export template. For general information about the Data Extraction Service and it's API please see the general purpose documentation
Job Run Parameters
This template supports filtering against the DBGen range OR the TradingDate of finalised ZReports.
EITHER DBGen filtering OR trading date filtering must be used. Filtering on both is not supported.
Parameter Definitions
| Parameter | Type | Description |
|---|---|---|
| DBGenFrom | Number (optional) | The (inclusive) start of the DBGen range which will be used to filter data. (required if using DBGen filtering) |
| DBGenTo | Number (optional) | The (inclusive) end of the DBGen range which will be used to filter data. If unspecified the current latest DBGen from the server will be used. |
| TradingDateFrom | DateTime (optional) | The (inclusive) start of the TradingDate range which will be used to filter data. Please note that the time will reference the time the order/zreport was closed/finalised (required if TradingDateTo is set) |
| TradingDateTo | DateTime (optional) | The (inclusive) end of the TradingDate range which will be used to filter data. Please note that the time will reference the time the order/zreport was closed/finalised (required if TradingDateFrom is set) |
Auto Value Considerations
DBGenFrom supports auto values which (when executing an auto value job run) will update to the value supplied at DBGenTo (or the latest DBGen from the sales data). When DBGenFrom is set to use an auto value it will use the value of the auto value + 1 to ensure that repeated executions will never export already exported sales data.
Configuration
First you will need to select a single outlet to generate the output for. You will then need to provide an API Key specific for that customer and provided by Restoke for the selected outlet.
Output Files
Exports will generate the following:
| File | Format | Description |
|---|---|---|
| sales.json | JSON | A list of GenericSalesTransactionItem entitiy encoded as JSON. |
| config.json | JSON | A ConfigurationExport entitiy encoded as JSON. |
More importantly it will export this data in a similar format through to Restoke directly using the confured API Key.
Overview
This export will connect with Restoke and send both configuration and sales data. It will also save a copy of the data sent to Restoke for your review should you need it.