Fields Reference Overview

Read this guide to reference all the available fields in the API.

Fields refers to the lines included in the JSON objects that you send to the API attached to the body of the relevant requests.

Fields are grouped as outlined in the following table and linked documentation:

JSON ObjectUse
Transaction Object FieldsModel transactions and group related transaction lines together.
Transaction Lines Object FieldsModel information for specific transaction lines.
Address Object FieldsModel address information for various addresses like ship-to, ship-from, payment and so on.
Refund Object FieldsModel refunds.
Voucher ObjectModel vouchers.

The API is designed so that you can include the majority of the details at the transaction line level, if you want to.