Getting Started with the APIs

Read this topic to get a summary of the APIs and their requests and some examples of how you might use them.

You can use the APIs to integrate the service's features with your marketplace and administrate your marketplace's and sellers' settings.

APIs

The Reference Guide contains the following sections that list the requests and fields for each API endpoint:

EndpointUse
Marketplace Reference GuideUse this endpoint to administrate your marketplace settings.
Sellers Reference GuideUse this endpoint to create seller record and edit their settings.
Transaction Reference GuideUse this API to integrate with your marketplace's store and with the stores of sellers on your marketplace. How to use the API to model different aspects of transactions like tax inclusive pricing is described in the Transaction Modeling topic.

Endpoints and Requests

The following table summarizes the available APIs:

The Sellers V1 API contains the following endpoints and requests:

The Marketplace Transaction API contains the following endpoints and requests:

Endpoint (URI)Requests
Tax (/api/v3/marketplace)Calculate Tax
Transactions (api/v3/marketplace/transactions)- Store Transaction - Confirm Transaction - Retrieve Transaction - Retrieve Transaction Requests
Refunds (/api/v3/marketplace/transactions/{key}/refunds)Refund Transactions

Transaction Processing

See Transaction Modeling.

Example Integration Scenarios

The following table summarizes the how you might use some of the requests to integrate the service's features with your marketplace:

Example ScenarioRequestAction in Vertex for Marketplaces
Show tax on a product page.Calculate TaxTax is calculated and information returned.
Calculate tax and store it until payment details are confirmed. For example, a good is in their basket but they have not yet paid for them.Store TransactionTransaction is stored as pending in the service.
Confirm a transaction when the payment details are confirmed. For example, your customer completes a purchase.Confirm TransactionTransaction is stored in the service. Details returned.
Integrate the service with your refund process.Refund TransactionsRefund recorded in the service's database.

You can also return transaction details for reporting and other purposes using the requests outlined in the following table:

Example ScenarioRequestAction in Vertex for Marketplaces
You wan to retrieve the details for a specified transaction for a report.Retrieve TransactionTransaction details returned by API.
You want to retrieve all the requests for a specified transaction for a monthly report.Retrieve transaction requestsTransaction details returned by API.

In this Section

TopicDescription
Accessing the APIsTo send successful requests, you need to retrieve a valid access token and add it to your requests.
Vertex O Series (Cloud) IntegrationVertex O Series Cloud (Cloud) is the engine for tax rate calculation.