To integrate OMP Report API:
Lovat API uses the REST architecture. The API has predictable, resource-oriented URLs and uses HTTP response codes to indicate API errors. The API always responds in the JSON format, including cases of errors.
Authentication to the OMP API is performed via HTTP header basic authentication. Subscribers need to provide a token as the basic authentication value. If you’re new to Lovat, you’ll need to sign up for an account to get your API key. The API uses built-in HTTP features such as HTTP authentication and HTTP verbs, which can be interpreted by off-the-shelf HTTP clients. It also supports cross-origin resource sharing, allowing you to access it securely from a client web application.
Lovat API uses the following endpoint paths:
https://omp.vatcompliance.co/api/omp — OMP Feed API, OMP Tax rate API
sandbox.vatcompliance.co/api/omp
API lets you request various reports that help you manage your Online Marketplace tax obligations. Report types are specified using the Report types enumeration.
Lovat periodically adds new fields and field values to reports.
The report process begins by creating a report request. Next, you obtain a list of report requests which shows the report request identifier and status of each requested report. Finally, you use the report request identifier from this listing to get the actual report. The process steps are as follows:
Submit a report request using the Report operation. This is a request to Lovat OMP API to generate a specific report.
Submit a request using the get_report_list operation to get a list that shows the report requests and the status and ID of each report request. Lovat OMP API returns a report_request_id for every report requested. When Lovat sets the status of a report request to DONE, the report is ready to be retrieved.
If no GeneratedReportId was created, submit a request using the get_report_list operation and include the report_request_id for the report requested. The operation returns a report_id that you can then pass to the Report operation.
Submit a request using the Report operation to receive a specific report. You include in the request the report_id for the report you want to receive.
Reports are retained for 30 days.
The request type: POST
https://omp.vatcompliance.co/api/omp/report/create/{access_token}
| Name | Description |
|
Sales Tax Report Enumeration value: GET _SALES_TAX_DATA_ API operation: GetReportList API operation: GetReport |
Tab-delimited flat file for tax-enabled US marketplaces. Content updated daily. |
|
EU VAT Calculation Report Enumeration value: _EU_VAT_REPORT_ API operation: RequestReport |
Comma-separated flat file report that provides detailed value-added tax (VAT) calculation information for OMP orders, returns, and refunds. This report is only available for EU sales. Import and export to and from the EU included. |
|
UK VAT Calculation Report Enumeration value: _GET_UK_ VAT_Report_ API operation: RequestReport |
Comma-separated flat file report that provides detailed value-added tax (VAT) calculation information for OMP orders, returns, and refunds. This report is only available for the UK sales. Import and export to and from the UK included. |
|
Merchant Transactions Report Enumeration value: _GET_MTR_ API operation: RequestReport |
Tab-delimited flat file report that provides detailed information about sales, refunds, and deemed orders by merchant_ID. This report is only available in the UK and the EU. |
| Parameter | Type | Description | Required |
| report_type | string | a type of requested report, see the table of Report types | required |
| start_date | dateTime | the earliest date you are looking for, in ISO 8601 date time format | required |
| end_date | dateTime | the end of the date range used for selecting the data to report, in ISO 8601 date time format. | required |
| supplier_id |
string
|
optional |
The requests to Lovat API must: HTTP status: 200 (OK) be sent over HTTPS, use TLS 1.2 or higher, contain authentication parameters,
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json'
-d '{
"report_type": "_EU_VAT_REPORT_",
"start_date": "2020-01-09T00:00:00 +00:00",
"end_date": "2020-30-09T24:00:00 +00:00",
}'
'https://omp.vatcompliance.co/api/omp/report/create/6cec387781a94425b401206d1710801a'
{ "report_request_id": "00012359"}
The request type: GET
https://omp.vatcompliance.co/api/omp/report/status
?token={access_token}&report_request_id={report_request_id}
• IN_PROGRESS
• DONE
• DONE_NO_DATA
| Parameter | Type | Description | Required |
| report_request_id | string | required |
The requests to Lovat API must: HTTP status: 200 (OK) be sent over HTTPS, use TLS 1.2 or higher, contain authentication parameters
curl -X GET --header 'Content-Type: application/json' --header 'Accept: application/json' 'https://omp.vatcompliance.co/api/omp/report/status ?token=6cec387781a94425b401206d1710801a&report_request_id=00012359'
{
"report_id": "00016359",
"status"="DONE"
}
The request type: GET
https://omp.vatcompliance.co/api/omp/report?token={access_token}&report_id={report_id}
| Parameter | Type | Description | Required |
| report_id | string | maximum 20 characters | required |
The requests to Lovat API must: HTTP status: 200 (OK) be sent over HTTPS, use TLS 1.2 or higher, contain authentication parameters,
curl -X GET --header 'Content-Type: application/json' --header 'Accept: application/json' 'https://omp.vatcompliance.co/api/omp/report?token=6cec387781a94425b401206d1710801a&report_id=00016359'