Getting Started with O Series Cloud Online Commerce API
Everything you need to start integrating your financial host system with O Series Cloud.
Vertex delivers Vertex O Series Cloud Online Commerce via Vertex O Series Cloud and the API endpoint, which seamlessly integrates with the core Vertex O Series Cloud REST API. Our API endpoint uses the same data model as the standard O Series Cloud REST API, helping to ensure consistency, reliability, and streamlined adoption for existing customers.
You can integrate directly with the service using the API endpoint. This option is designed for users who want to incorporate the standalone services into their checkout when maintaining control over the checkout process, API sequence, and payment methods.
Depending on the access token in use, you can securely calculate taxes against your own environments using commonly available API development and testing tools.
Supported platforms
Here's a list of supported products and services:
| Service | Includes | API details |
|---|---|---|
| Vertex O Series Cloud Online Commerce | Vertex Invoice IQ Vertex Validator | Calculate Tax as a Seller; Restrictions apply. |
| Vertex Invoice IQ | Integrated Vertex Invoice IQ Standalone Vertex Invoice IQ | Vertex Invoice IQ API; Restrictions apply. |
| Vertex Validator | Integrated Vertex Validator Standalone Vertex Validator | Vertex Validator API; Restrictions apply. |
API authentication
Obtain a credential as described in Authentication and Access. Include the credential in your standard O Series Cloud authentication setup. For more information, see Authenticate O Series Cloud.
API integration
Use the following base URLs:
| Environment | URL |
|---|---|
| Sandbox | https://oseries-plus-api.sandbox.marketplace.taxamo.com |
| Production | https://oseries-plus-api.marketplace.taxamo.com |
Include tax calculation and tax number validation data in the Calculate Tax as a Seller request. Use the requests described in the Reference Guide.
Download OAS files
Download the Open API Specification (OAS) files in JSON format from the O Series Cloud REST API Reference.
Requests
Here's a list of requests supported in the service:
| Request | Description |
|---|---|
| Calculation API Requests | Use these tax calculation requests with the Tax Calculation and Tax GIS API. |
| Reporting API Requests | Use these reporting requests to integrate reports into your financial host system. |
| Vertex Invoice IQ API Requests | Use these requests for tax-compliant digital invoices in the invoicing service. |
| Vertex Validator API Requests | Use these requests to validate tax numbers in the validation service. |
For more information, see the Reference Guide.