Import API: Overview

Caspeco Sales API is the preferred way to import sales data from external POS systems into Caspeco. By importing all sales data into Caspeco and using the built-in powerful analytics tools, you gain a comprehensive overview of your revenue and expenses.

To get started with an integration to the Caspeco Sales API, the API in this test package should be used during the complete development phase. When the integration is completed, Caspeco is contacted and a test account is set up in our test environment. After testing is done, a new account is created in our live environment and the data that is sent is then saved.

Endpoint to be used when posting data: https://salesapi.caspeco.net/api/ImportApi/Upload

Do note the additional endpoint that can be used during testing mentioned under Additional aid during testing.

Development and Testing

Before sending any data towards the production API the integration you are creating should be able to provide valid payloads. To aid you during the development process there are two options to consider.

1. Use the validation endpoint. This endpoint will only validate the data part of the payload, not the head.

   Validate endpoint can be found here: https://salesapi.dev.caspeco.net/api/ImportApi/ValidatePayload

   This endpoint is only active in our development API and can only be used for testing the structure of your payload. The endpoint does not perform any authentication checks, so if you want to you can provide test data for certain fields. This means you can start your development before being provided with the required authentication information. This endpoint does not store any data or logs, so if you need our help to figure out why something isn’t working please provide the payload and the error message you should receive from the API.

2. Ask for Caspeco Operations for access to the Stage environment for testing purposes. You will receive a separate secret token that will only work in the Stage enivornment, but it will allow you also have the data imported. This could help out if you are having issues during development and require Caspeco to validate your data after import.

   Endpoint to be used when posting data to Stage: https://salesapi.stage.caspeco.net/api/ImportApi/Upload

Timestamps and End of Day in Caspeco

All timestamps provided in a payload should be supplied in the local time of consumption. If your system stores data in UTC timestamps these needs to be converted before exporting the sales data to the api.

Also do note that a sales day in Caspeco analytics is tracked between 06:00:00 and 05:59:59. If your system uses another period for tracking the sales days this might cause discrepancies when comparing the imported sales to the sales in the origin system. There are currently no plans to add support for adjusting this tracking period.

Historic Import and corrections of previously imported sales data

We recommend that you add functionality to export historical data and the support for re-exporting exported sales data due to issues with a previous export. In the case of a re-export contact Caspeco support so any previously imported sales data can be removed.

Data Specifications

• Request data specification
• JSON Schema
• XML Schema
• Payload example