Skip to main content

UpsLandedcostClient Python SDK 1.0.0

Welcome to the UpsLandedcostClient SDK documentation. This guide will help you get started with integrating and using the UpsLandedcostClient SDK in your project.

Versions

  • SDK version: 1.0.0

About the API

The Landed Cost Quote API allows you to estimate the all-inclusive cost of international shipments - including applicable duties, VAT, taxes, brokerage fees, and other fees. Required parameters include the currency and shipment details, such as the commodity ID, price, quantity, and country code of origin.

Table of Contents

Setup & Configuration

Supported Language Versions

This SDK is compatible with the following versions: Python >= 3.7

Installation

To get started with the SDK, we recommend installing using pip:

pip install ups_landedcost_client

Authentication

Basic Authentication

The UpsLandedcostClient API uses Basic Authentication.

You need to provide your username and password when initializing the SDK.

Setting the Username and Password

When you initialize the SDK, you can set the username and password as follows:

UpsLandedcostClient(
username="YOUR_USERNAME",
password="YOUR_PASSWORD"
)

If you need to set or update the username and password after initializing the SDK, you can use:

sdk.set_basic_auth("YOUR_USERNAME", "YOUR_PASSWORD")

Services

The SDK provides various services to interact with the API.

Below is a list of all available services with links to their detailed documentation:

Models

The SDK includes several models that represent the data structures used in API requests and responses. These models help in organizing and managing the data efficiently.

Below is a list of all available models with links to their detailed documentation:
NameDescription
LandedCostRequestThe root element for the Landed Cost document.
LandedCostResponse
LandedCostRequestShipmentEvery Landed Cost request must be based on a shipment.
RequestShipmentItems
ShipmentEvery Landed Cost response must be based on a shipment.
BrokerageFeeItems
ResponseShipmentItems
PerfStatsSee ALPerfStats
ErrorsError code and description

License

This SDK is licensed under the MIT License.

See the LICENSE file for more details.

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →