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 into the JSON objects or arrays as outlined in the following table and linked documentation:

JSON Object


Transaction Object Fields

Model transactions and group related transaction lines together.

Transaction Lines Object Fields

Model information for specific transaction lines.

Address Object Fields

Model address information for various addresses like ship-to, ship-from, payment and so on.

Refund Object Fields

Model refunds.

Voucher Object

Model vouchers.

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

If you need further help, contact support at

Did this page help you?