# Terminal Shipping API

## Terminal Shipping API

- [Introduction](https://docs.terminal.africa/tship/master.md): Learn how to integrate logistics into your application with our APIs.
- [Example Book Shipment Flow](https://docs.terminal.africa/tship/example-book-shipment-flow.md): This Doc highlight steps to follow in order to book a shipment using terminal API
- [Ship with Code](https://docs.terminal.africa/tship/ship-with-code.md): This is a general guide for anyone integrating delivery services. It provides a step guide to arrange your first delivery along with a description of the flow of events once your delivery is arranged.
- [Sample Use Cases](https://docs.terminal.africa/tship/sample-use-cases.md): In this section, we're going to illustrate how to use the API in real-world use cases.
- [Online Marketplace](https://docs.terminal.africa/tship/sample-use-cases/online-marketplace.md)
- [Authentication](https://docs.terminal.africa/tship/authentication.md): Authenticate your API calls by including your access token in the Authorization header of every request you make. You can retrieve your access token under the settings tab on the dashboard.
- [Errors](https://docs.terminal.africa/tship/errors.md): This section describes the nature of errors you might encounter while interacting with the API.
- [Libraries & Plugins](https://docs.terminal.africa/tship/libraries-and-plugins.md): In this section you can find a list of available libraries that could streamline your integration process.
- [Addresses](https://docs.terminal.africa/tship/address.md): The Addresses API allows you to create and manage pickup and delivery locations.
- [Create Address](https://docs.terminal.africa/tship/address/create-address.md): Create an address for getting rates or arranging pickup and delivery.
- [Get Addresses](https://docs.terminal.africa/tship/address/get-addresses.md): Fetch list of addresses available for a user.
- [Get Address](https://docs.terminal.africa/tship/address/get-address.md): Fetch details of a specific address.
- [Get Default Address](https://docs.terminal.africa/tship/address/get-default-address.md): Set an address a default address
- [Set Default Address](https://docs.terminal.africa/tship/address/set-default-address.md): Set an address a default address
- [Update Address](https://docs.terminal.africa/tship/address/update-address.md): Update information for an existing address.
- [Validate Address](https://docs.terminal.africa/tship/address/validate-address.md): Validate details for an address
- [Carriers](https://docs.terminal.africa/tship/carrier.md): The Carriers API allows you to manage information on available carriers for your account.
- [Get Carriers](https://docs.terminal.africa/tship/carrier/get-carriers.md): Fetch list of all carriers available on TShip API.
- [Get Carrier](https://docs.terminal.africa/tship/carrier/get-carrier.md): Fetch details of a specific carrier.
- [Enable Carrier](https://docs.terminal.africa/tship/carrier/enable-carrier.md): Enable a specific carrier for a user.
- [Enable Multiple Carriers](https://docs.terminal.africa/tship/carrier/enable-multiple-carriers.md): Enable multiple carriers for a user.
- [Disable Carrier](https://docs.terminal.africa/tship/carrier/disable-carrier.md): Disable a specific carrier for a user.
- [Disable Multiple Carriers](https://docs.terminal.africa/tship/carrier/disable-multiple-carriers.md): Disable multiple carriers for a user.
- [Drop-off Locations](https://docs.terminal.africa/tship/carrier/drop-off-locations.md): Fetch list of all carriers available on TShip API.
- [Claims](https://docs.terminal.africa/tship/claims.md): The Claims API allows you to create and manage claims on lost or damaged parcels in your shipment.
- [Get Claims](https://docs.terminal.africa/tship/claims/get-claims.md): Fetch list of all claims available for a specific user.
- [Get Claim](https://docs.terminal.africa/tship/claims/get-claim.md): Fetch details of a specific claim.
- [File Claim](https://docs.terminal.africa/tship/claims/file-claim.md): File a new claim for a lost or damaged parcel in transit.
- [HS Codes](https://docs.terminal.africa/tship/hs-codes.md): The HS Codes API allows you generate accurate, customs ready descriptions for your items when you ship.
- [Get HSCodes](https://docs.terminal.africa/tship/hs-codes/get-hs-codes.md): Fetch list of HS Codes available
- [Get HSCode Chapters](https://docs.terminal.africa/tship/hs-codes/get-hs-codes-1.md): Fetch list of HS Code Chapters available
- [Get HSCode Categories](https://docs.terminal.africa/tship/hs-codes/get-hs-codes-2.md): Fetch list of HS Code Categories for a specific chapter
- [Get HSCode Details](https://docs.terminal.africa/tship/hs-codes/get-hs-code.md): Fetch details of a specific hs code.
- [Search HSCodes](https://docs.terminal.africa/tship/hs-codes/search-hscodes.md): Search from the list of HS Codes available
- [Add Favorite HS Code](https://docs.terminal.africa/tship/hs-codes/add-favorite-hs-code.md): Add specific HSCode to Favorite.
- [Find a HS Code](https://docs.terminal.africa/tship/hs-codes/find-a-hs-code.md): Generate customs standard item descriptions and find accurate HS Codes - powered by AI.
- [Get Favorite HSCodes](https://docs.terminal.africa/tship/hs-codes/get-favorite-hscodes.md): Fetch available Favorite HSCodes
- [Update Favorite HSCode Description](https://docs.terminal.africa/tship/hs-codes/update-favorite-hscode-description.md): Update the description of a saved hscode
- [Remove HSCode from Favorites](https://docs.terminal.africa/tship/hs-codes/remove-hscode-from-favorites.md): Remove specific HSCode from favorite
- [Import Duties](https://docs.terminal.africa/tship/import-duties.md): The Import Duties API allows you to estimate and manage landed costs for deliveries.
- [Get Duties](https://docs.terminal.africa/tship/import-duties/get-duties.md): Fetch list of all claims available for a specific user.
- [Get Duty](https://docs.terminal.africa/tship/import-duties/get-duty.md): Fetch details of a specific duty.
- [Estimate Duty](https://docs.terminal.africa/tship/import-duties/estimate-duty.md): Estimate import duty required for a shipment.
- [Insurance](https://docs.terminal.africa/tship/insurance.md): The Insurance API allows you to purchase and manage insurance premiums on parcels included in your shipment.
- [Get Insurance](https://docs.terminal.africa/tship/insurance/get-insurance.md): Fetch details of a specific insurance.
- [Get Insurances List](https://docs.terminal.africa/tship/insurance/get-insurances-list.md): Fetch list of insurances available for a user.
- [Get Insurance Premium](https://docs.terminal.africa/tship/insurance/get-insurance-premium.md): Retrieves total premium for insurance on a specific parcel.
- [Get Insurance Premium Using Parcel Value](https://docs.terminal.africa/tship/insurance/get-insurance-premium-using-parcel-value.md): Retrieves total premium for insurance on a specific parcel.
- [Purchase Insurance](https://docs.terminal.africa/tship/insurance/purchase-insurance.md): Purchase insurance for a specific shipment.
- [Packaging](https://docs.terminal.africa/tship/packaging.md): The Packaging API allows you to create and manage packaging used on parcels.
- [Create Packaging](https://docs.terminal.africa/tship/packaging/create-packaging.md): Create new packaging for wrapping parcels
- [Get Packaging](https://docs.terminal.africa/tship/packaging/get-packaging.md): Fetch list of packaging available for a user.
- [Get Specific Packaging](https://docs.terminal.africa/tship/packaging/get-specific-packaging.md): Fetch details of a specific packaging.
- [Terminal Default Packaging](https://docs.terminal.africa/tship/packaging/terminal-default-packaging.md): Get Terminal Default Packaging
- [Update Packaging](https://docs.terminal.africa/tship/packaging/update-packaging.md): Update information for an existing packaging.
- [Parcels](https://docs.terminal.africa/tship/parcel.md): The Parcels API allows you to create and manage your parcels.
- [Create Parcel](https://docs.terminal.africa/tship/parcel/create-parcel.md): Create a parcel for a shipment.
- [Update Parcel](https://docs.terminal.africa/tship/parcel/update-parcel.md): Update a parcel for a shipment.
- [Get Parcels](https://docs.terminal.africa/tship/parcel/get-parcels.md): Fetch a list of parcels available for a user.
- [Get Parcel](https://docs.terminal.africa/tship/parcel/get-parcel.md): Fetch details of a specific parcel.
- [Rates](https://docs.terminal.africa/tship/rate.md): The Rates API allows you to retrieve shipping rates from available carriers.
- [Get Quotes for Shipment](https://docs.terminal.africa/tship/rate/get-quotes-for-shipment.md): Fetch available shipping quotes for a shipment
- [Get Rate](https://docs.terminal.africa/tship/rate/get-rate.md): Fetch details of a specific rate.
- [Get Rates](https://docs.terminal.africa/tship/rate/get-rates.md): Fetch a list of rates generated by a user.
- [Get Rates for Multi-Parcel Shipment](https://docs.terminal.africa/tship/rate/get-rates-for-shipment.md): Fetch available shipping rates for a multi-parcel shipment.
- [Get Rates for Shipment](https://docs.terminal.africa/tship/rate/get-rates-for-shipment-1.md): Fetch available shipping rates for a shipment.
- [Get Rates for Shipment \[STREAM\]](https://docs.terminal.africa/tship/rate/get-rates-for-shipment-2.md): Fetch available shipping rates for a shipment via stream endpoint.
- [Simplified HS Codes](https://docs.terminal.africa/tship/hs-codes-1.md): The HS Codes API allows you get accurate description to use for your shipment item
- [Get Simplified HSCodes](https://docs.terminal.africa/tship/hs-codes-1/get-hs-codes.md): Fetch list of simplified HS Codes available
- [Get Simplified HSCode Chapters](https://docs.terminal.africa/tship/hs-codes-1/get-hs-codes-1.md): Fetch list of simplified HS Code Chapters available
- [Get Simplified HSCode Categories](https://docs.terminal.africa/tship/hs-codes-1/get-hs-codes-2.md): Fetch list of Simplified HS Code Categories for a specific chapter
- [Get Simplified HSCode Details](https://docs.terminal.africa/tship/hs-codes-1/get-hs-code.md): Fetch details of a specific simplified hs code.
- [Search Simplified HSCodes](https://docs.terminal.africa/tship/hs-codes-1/search-simplified-hscodes.md): Search from the list of Simplified HS Codes available
- [Shipments](https://docs.terminal.africa/tship/shipment.md): The Shipments API allows you to create shipment tasks, track status of shipments and retrieve information about shipments.
- [Create Shipment](https://docs.terminal.africa/tship/shipment/create-shipment.md): Create a shipment
- [Create Quick Shipment](https://docs.terminal.africa/tship/shipment/create-quick-shipment.md): Create a quick shipment. Pass all required details, including address and parcel in a single API call.
- [Update Shipment](https://docs.terminal.africa/tship/shipment/update-shipment.md): Update information for an existing draft shipment.
- [Get Shipments](https://docs.terminal.africa/tship/shipment/get-shipments.md): Fetch a list of all shipments available for a user.
- [Get Shipments v2](https://docs.terminal.africa/tship/shipment/get-shipments-1.md): Fetch a list of all shipments available for a user.
- [Get Shipment](https://docs.terminal.africa/tship/shipment/get-shipment.md): Fetch details of a specific shipment.
- [Track a Shipment](https://docs.terminal.africa/tship/shipment/track-a-shipment.md): Get tracking details for a shipment.
- [Cancel Shipment](https://docs.terminal.africa/tship/shipment/cancel-shipment.md): Cancel pickup for a shipment.
- [Delete Shipment](https://docs.terminal.africa/tship/shipment/create-shipment-1.md): Delete a shipment
- [Duplicate Shipment](https://docs.terminal.africa/tship/shipment/duplicate.md): Duplicate an existing shipment to create a new draft shipment.
- [Arrange Pickup & Delivery for Shipment](https://docs.terminal.africa/tship/shipment/arrange-pickup-and-delivery-for-shipment.md)
- [Transactions](https://docs.terminal.africa/tship/transaction.md): The Transactions API allows you to retrieve information on all charges and top-ups on your account.
- [Get Transactions](https://docs.terminal.africa/tship/transaction/get-transactions.md): Fetch a list of all transactions for an account.
- [Get Transaction](https://docs.terminal.africa/tship/transaction/get-transaction.md): Fetch details of a specific transaction.
- [Users](https://docs.terminal.africa/tship/user.md): The Users API allows you to retrieve your account information.
- [Get User](https://docs.terminal.africa/tship/user/get-user.md): Fetch details of a user account.
- [Get Wallet Info](https://docs.terminal.africa/tship/user/get-wallet-info.md): Fetch details of a user's wallet
- [Get Wallet Balance](https://docs.terminal.africa/tship/user/get-wallet.md): Fetch details of a user's wallet balance
- [Get User Carriers](https://docs.terminal.africa/tship/user/get-user-carriers.md): Fetch list of all carriers available for a user.
- [Webhooks](https://docs.terminal.africa/tship/webhooks.md): The Wallets API allows you to create and retrieve information on all webhooks on your account.
- [Create Webhook](https://docs.terminal.africa/tship/webhooks/create-webhook.md): Add a webhook
- [Delete Webhook](https://docs.terminal.africa/tship/webhooks/delete-webhook.md): Delete an existing webhook.
- [Disable Webhook](https://docs.terminal.africa/tship/webhooks/disable-webhook.md): Disable a webhook.
- [Enable Webhook](https://docs.terminal.africa/tship/webhooks/enable-webhook.md): Enable a webhook.
- [Get Webhooks](https://docs.terminal.africa/tship/webhooks/get-webhooks.md): Fetch a list of all webhooks available for a user.
- [Get Webhook](https://docs.terminal.africa/tship/webhooks/get-webhook.md): Fetch details of a specific webhook.
- [Replay Webhook](https://docs.terminal.africa/tship/webhooks/replay-webhook.md): Add a webhook
- [Simulate Webhook](https://docs.terminal.africa/tship/webhooks/simulate-webhook.md)
- [Webhook Deliveries](https://docs.terminal.africa/tship/webhooks/webhook-deliveries.md): Add a webhook
- [API Pricing](https://docs.terminal.africa/tship/miscallaneous/api-pricing.md): You can find a full list of paid services available on the API as well as the charges that apply for using each service..
- [Carriers Available](https://docs.terminal.africa/tship/miscallaneous/carriers-available.md): You can find a full list of carriers available on the API as well as which user countries can access each carrier.
- [Carrier Object (Enable / Disable)](https://docs.terminal.africa/tship/miscallaneous/carrier-object-enable-disable.md): Carrier object describes the carriers included in a multi enable / disable request.
- [Cities](https://docs.terminal.africa/tship/miscallaneous/cities.md): Get list of cities available in a given country.
- [Countries](https://docs.terminal.africa/tship/miscallaneous/countries.md): Get list of countries available for shipping.
- [File Claim Object](https://docs.terminal.africa/tship/miscallaneous/file-claim-object.md): This section describes the attributes contained in the file claim object sent when filing a claim for insurance.
- [Parcel Item](https://docs.terminal.africa/tship/miscallaneous/parcel-item.md): Parcel item object describes the items included in a parcel.
- [Quick Shipments](https://docs.terminal.africa/tship/miscallaneous/quick-shipments.md): Here you can find a description of the quick shipments process. This method allows you to complete all the tasks required to create a shipment in a single API call.
- [Parcel](https://docs.terminal.africa/tship/miscallaneous/quick-shipments/parcel.md): Parcel object describes the attributes required for a parcel in a quick shipment.
- [Pickup / Delivery Address](https://docs.terminal.africa/tship/miscallaneous/quick-shipments/pickup-delivery-address.md): Pickup and delivery address object describes the attributes required for pickup\_address and delivery\_address in quick shipment. For description of objects, please see the Address Object.
- [Rates Stream Handling](https://docs.terminal.africa/tship/miscallaneous/rates-stream-handling.md): Sample code for handling rates streaming in Node.js.
- [Shipment Events](https://docs.terminal.africa/tship/miscallaneous/shipment-event.md): Every shipment generated on the API has an event data point which provides information on the lifecycle of a shipment. This section describes the information contained within the shipment event object
- [Shipment Extras](https://docs.terminal.africa/tship/miscallaneous/shipment-extras.md): The extras object attached to each shipment contains additional information relevant to each shipment outside the scope of the API such as carrier waybills, commercial invoices and much more.
- [States](https://docs.terminal.africa/tship/miscallaneous/states.md): Get states available for a given country.
- [Validation Countries](https://docs.terminal.africa/tship/miscallaneous/validation-countries.md): You can find a full list of countries where our APIs support address validation.
- [Webhook Events](https://docs.terminal.africa/tship/miscallaneous/webhook-events.md): Here you can find a list of webhook event types along with descriptions of each event.
- [Handling Webhook Events](https://docs.terminal.africa/tship/miscallaneous/webhook-events/handling-webhook-events.md): Sample code for handling webhook events in Node.js.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.terminal.africa/tship/master.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.