Transaction Modeling

Read about how you can model transactions using the Seller Transaction API.

The Seller Transaction API is designed to allow you to include transactional information where needed to suit your implementation. For example, you might choose the send the buyer's details in a Calculate Tax request or you may decide to send it in a Store Transaction request.

To facilitate this, the same structure is used for the JSON that is attached to all requests. Fields like currency_code are used to represent information like the currency. A full list of the available fields is provided in the Fields Reference section

Some fields are generated by the API so these are known as response-only fields.

You can include information at transaction and transaction line-item level. See Transaction Details

In this section

TopicDescription
Example RequestsRead some example request and responses to help you when you create your own.
Field InformationBefore you start to build your requests, review the required fields.
Business-to-Business (B2B) TransactionsRead about how Business-to-Business (B2B) are handled.
Digital GoodsRead about how the workflow for digital goods is modelled.
Transaction DetailsYou can use the Transactions object to send transaction information to and from the API.
Product ClassesUse product classes to indicate the type of good or service. You also use them to add shipping information.
Identifiers and ClassificationsUse identifiers and classifications to identify parties such as carriers or other IDs like an Order ID.
Amounts and PricingRead about how to model tax inclusive and exclusive pricing.
AddressesUse addresses to model physical location information, such as a Ship To address.
Buyer DetailsYou can specify the buyer's contact details such as their name or email address.
Custom IDsYou can add the ID from your order or ecommerce software to your requests to help correlate transactions in the service and in your systems.
CurrenciesRead about how currencies are modelled.
Multiple GoodsRead about how to model multiple goods.
Returned Tax InformationRead about the tax information returned by the service
RefundsRead about how you can model refunds.