Transaction Lines Object Fields

Learn about the fields used to model information at the transaction line level.

These field references describe the fields in a transaction lines object.

The following fields are available:

Field	Type	Pattern	Min	Max	Description
`carrier_id`	String	—	—	64	The carrier identifier.
`import_address.country_code`	String	—	—	—	The country code of the country from which the goods are imported.
`discounted_tax_amount`	Number	—	—	—	The total tax amount associated with all discounts applied to the line.
`seller_kind`	String	`^[BC]$`	1	1	The seller type. Use `B` for business (the default) or `C` for consumer.
`taxes`	Object	—	—	—	See Taxes Object Fields.
`discounts`	Object	—	—	—	See Discount Object Fields.
`product_cn_code`	String	`^\\d[\d\.\s]+\\d$`	—	16	The product code.
`product_reference_number`	String	—	—	32	The tax reference number. This field is used in the United States.
`consignment_id`	String	—	—	64	The consignment identifier.
`parcel_reference`	String	—	—	64	The optional identifier for the parcel.
`invoice_status`	String	—	—	1	Specifies whether an invoice is required, optional, or forbidden. Use `R` for required, `O` for optional, or `F` for forbidden.
`unit_price`	Number	—	—	—	The price of one unit.
`unit_of_measure`	String	—	—	—	The unit of measure for the line item. The service uses this value to calculate quantity-based surcharges. Possible values: `BO`: Bottle `BX`: Box `CR`: Crate `CS`: Case `CT`: Carton `DAY`: Day `EA`: Each `FO`: Fluid Ounce `GLL`: Gallon `HUR`: Hour `KG`: Kilogram `LTR`: Liter `MIN`: Minute `PF`: Pallet `QT`: Quart `STN`: Ton `SYD`: Square Yard `TRK`: Trunk Line
`quantity`	Number	—	—	—	The quantity of units. Defaults to `1`.
`is_seller_permanant`	Boolean	—	—	—	Specifies whether the seller associated with the line exists permanently in the database. The value is `true` for sellers configured through the Sellers API and `false` for sellers provided in the transaction request.
`custom_fields.[key]`	String	—	—	256	The key of a custom field.
`custom_fields.[value]`	String	—	—	256	The value of a custom field.
`invoice_number`	String	—	—	256	The invoice number.
`discounted_total_amount`	Number	—	—	—	The total amount of all discounts applied to the line.
`tax_engine_additional_parameters.[param]`	String	—	—	64	The custom parameter passed to the tax engine.
`tax_engine_additional_parameters.[value]`	String	—	—	256	The custom value passed to the tax engine.
`product_class`	String	—	—	128	Specifies whether the line represents physical goods, digital goods, or shipping.
`amount`	Number	—	—	—	The line amount excluding tax. Required if `total_amount` or both `unit_price` and `quantity` are not provided.
`seller_code`	String	—	1	512	The seller identifier assigned by the service when the seller is created.
`custom_id`	String	—	—	64	The value that helps identify the transaction line in your financial host system. The field is required for schema validation, but the value can be empty.
`tax_amount`	Number	—	—	—	The tax amount for the line. The service calculates this value.
`tax_exempt`	Boolean	—	—	—	Indicates whether the line is exempt from tax. The possible values are `true` and `false`.
`invoice_place`	String	—	—	256	The place where the invoice was issued.
`total_amount`	Number	—	—	—	The total line amount. Required if `amount` or both `unit_price` and `quantity` are not provided.
`ship_from_address`	Object	—	—	—	See Address Object Fields.
`description`	String	—	—	256	The description of the transaction line.
`tax_liability_owner_code`	String	—	—	256	The code that identifies the seller, marketplace, or buyer responsible for the tax liability.
`discounted_amount`	Number	—	—	—	The total amount of all discounts applied to the line.
`reverse_charge`	Boolean	—	—	—	Indicates whether the reverse-charge mechanism applies. The possible values are `true` and `false`.
`tax_country_code`	String	`^[A-Z]{2}$`	2	2	The two-letter ISO country code used for tax determination, such as `CA` for Canada.
`product_tax_code`	String	—	—	—	The product tax code.

Updated 3 months ago

Did this page help you?