Line Item Types

Retrieve the list of line item types used in shipping estimates and invoices.

Endpoint

GET /line_item_types

Description

Fetch all available line item types that appear in shipping estimates and invoices. These categorize different types of charges that may be applied to shipments.

Request Example

curl -X GET \
  https://orders-api-production.vatit-stream.com/client_api/v2/line_item_types \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"

Success Response (200 OK)

[
  {
    "id": 1,
    "description": "Shipment Protection Fee",
    "accounting_dimension": {
      "id": 1,
      "description": "Additional Charges"
    }
  },
  {
    "id": 2,
    "description": "Fuel Surcharge",
    "accounting_dimension": {
      "id": 2,
      "description": "Base Rate Fees"
    }
  },
  {
    "id": 3,
    "description": "Remote Area Surcharge",
    "accounting_dimension": {
      "id": 1,
      "description": "Additional Charges"
    }
  },
  {
    "id": 4,
    "description": "Customs Clearance Fee",
    "accounting_dimension": {
      "id": 3,
      "description": "Customs & Duties"
    }
  }
]

Response Fields

Field	Type	Description
id	integer	Unique identifier for the line item type
description	string	Name/description of the line item type
accounting_dimension	object	Accounting category information

Accounting Dimension Object

Field	Type	Description
id	integer	Unique identifier for the accounting dimension
description	string	Name of the accounting category

Common Line Item Types

Type	Description	Category
Base Rate	Standard shipping charge	Base Rate Fees
Fuel Surcharge	Variable fuel cost adjustment	Base Rate Fees
Shipment Protection Fee	Insurance/protection coverage	Additional Charges
Remote Area Surcharge	Extra charge for remote locations	Additional Charges
Customs Clearance Fee	Customs processing charges	Customs & Duties
Liftgate Service	Special delivery equipment fee	Additional Services
Residential Delivery	Extra charge for home delivery	Additional Services
Saturday Delivery	Weekend delivery surcharge	Additional Services

Usage in API Responses

Line item types appear in the line_items arrays within estimates and order invoice data:

{
  "line_items": [
    {
      "description": "Fuel Surcharge",
      "cost": 127.50,
      "currency_id": "USD"
    }
  ]
}

Error Responses

401 Unauthorized

Access token is missing or invalid.

Important Notes

• Reference Data: This endpoint provides reference information to help understand charges in estimates and invoices
• Accounting Integration: The accounting dimensions can be used for financial system integration
• Charge Categories: Line items are grouped by accounting dimensions for better cost categorization
• Carrier Specific: Different carriers may have different line item types and descriptions
• Invoice Reconciliation: Use this data to understand and reconcile invoice line items

Caching Recommendations

Line item type data is relatively stable and can be cached in your application. Consider refreshing this data weekly or monthly as new charge types may occasionally be added.