Transaction Lines Object Fields
You use the Transaction Line object to specify details for a transaction line.
This object contains the following fields:
Field | Details | Description |
---|---|---|
carrier_id | Type: String Max: 64 | The identifier of the carrier. |
import_address.country_code | Type: String | The country code that represents the country where the goods are imported from. |
discounted_tax_amount | Type: Number | The sum of discount tax amounts of all discounts applied to this line. |
seller_kind | Type: String Max: 1 Pattern: | The type of seller. It can be |
taxes | See Taxes Object Fields. | |
discounts | See Discount Object Fields. | |
product_cn_code | Type: String Max: 16 Pattern: | Product code. |
product_reference_number | Type: String Max: 32 | The Tax Reference number. This is is used in the USA. |
consignment_id | Type: String Max: 64 | Identifier for the consignment. |
parcel_reference | Type: String Max: 64 | Identifier reference for the parcel. This is optional. |
invoice_status | Specifies whether the invoice is required, optional or not allowed. There are 3 possible values:
| |
unit_price | Type: Number | The price of a unit. |
unit_of_measure | Type: String | The unit of measure for the line item to be used in surcharges based on quantity and not price. Possible values: BO - Bottle BX - Box CR - Crate CS - Case CT - Carton DAY - Day EA - Each FO - Fluid Ounce GLL - Gallon (US) HUR - Hour KG - Kilogram LTR - Liter MIN - Minutes PF - Pallet QT - Quart (US) STN - Ton (US) SYD - Square Yard TRK - Trunk Line |
quantity | Type: Number | Quantity. Defaults to 1 |
is_seller_permanant | Type: Boolean | Whether seller associated with this line permanently exists in the database. True for sellers configured using the Sellers API. False for sellers provided in the transaction request. |
custom_fields.[key] | Max: 256 | Key value for a custom field. |
custom_fields.[value] | Max: 256 | Value of a custom field. |
invoice_number | Type: String Max: 256 | The invoice number. |
discounted_total_amount | Type: Number | The sum of all the discounts that have been applied to this transaction line. |
tax_engine_additional_parameters.[param] | Type: String Max: 64 | Custom additional parameter that is passed to the tax engine. |
tax_engine_additional_parameters.[value] | Type: String Max: 256 | Custom additional value that is passed to the tax engine. |
product_class | Type: String | This field is mandatory. Identifies whether the goods are physical goods or services. The values are:
|
amount | Type: Number | Amount of transaction line without tax. Required if total amount or both unit price and quantity are not provided. |
seller_code | Min: 1 Max: 512 | The identifier of the seller. This is assigned by the service when the seller is created. |
custom_id | Type: String Max: 64 | Field where you can add a value to help identify the transaction line in your ecommerce system. The custom_id field is required for schema validation but you do not have to enter a value. |
tax_amount | Type: Number | The amount of tax amount for the line. This is calculated by the service. |
tax_exempt | Type: Boolean | Identifies whether the line is exempt from tax or not. The possible values are true or false . |
invoice_place | Type: String Max: 256 | The place where the invoice was issued from. |
total_amount | Type: Number | Total amount for the transaction line. This is only required if either the amount field or both unit price and quantity fields are not provided. |
ship_from_address | See Address Object Fields. | |
description | Type: String Max: 256 | Description for the transaction line. |
tax_liability_owner_code | Type: String Max: 256 | This code can reference a seller, a marketplace or a buyer. |
discounted_amount | Type: Number | The sum of all discounts applied to this transaction line. |
reverse_charge | Type: Boolean | Identifies if a reverse charge applies. Possible values are true and false . |
tax_country_code | Min: 2 Max: 2 Pattern: | The two-letter ISO country code. For example, FR for France. |
Updated 23 days ago