Terminal Shipping API
  • Introduction
  • Example Book Shipment Flow
  • Ship with Code
  • Authentication
  • Errors
  • Libraries & Plugins
  • API ENDPOINTS
  • Addresses
    • Create Address
    • Get Addresses
    • Get Address
    • Update Address
    • Validate Address
    • Set Default Sender Address
    • Get Default Sender Address
  • Carriers
    • Get Carriers
    • Get Carrier
    • Enable Carrier
    • Enable Multiple Carriers
    • Disable Carrier
    • Disable Multiple Carriers
    • Drop-off Locations
  • Claims
    • Get Claims
    • Get Claim
    • File Claim
  • HS Codes
    • Get HSCodes
    • Get HSCode Chapters
    • Get HSCode Categories
    • Get HSCode Details
    • Search HSCodes
  • Insurance
    • Get Insurance
    • Get Insurances List
    • Get Insurance Premium
    • Get Insurance Premium Using Parcel Value
    • Purchase Insurance
  • Packaging
    • Create Packaging
    • Update Packaging
    • Get Packaging
    • Terminal Default Packaging
    • Get Specific Packaging
  • Parcels
    • Create Parcel
    • Update Parcel
    • Get Parcels
    • Get Parcel
  • Rates
    • Get Rates for Shipment
    • Get Quotes for Shipment
    • Get Rates for Multi-Parcel Shipment
    • Get Rates
    • Get Rate
  • Simplified HS Codes
    • Get Simplified HSCodes
    • Get Simplified HSCode Chapters
    • Get Simplified HSCode Categories
    • Get Simplified HSCode Details
    • Search Simplified HSCodes
  • Shipments
    • Create Shipment
    • Create Quick Shipment
    • Update Shipment
    • Get Shipments
    • Get Shipments v2
    • Get Shipment
    • Track a Shipment
    • Cancel Shipment
    • Delete Shipment
    • Duplicate Shipment
    • Arrange Pickup & Delivery for Shipment
  • Transactions
    • Get Transactions
    • Get Transaction
  • Users
    • Get User
    • Get Wallet Info
    • Get Wallet Balance
    • Get User Carriers
  • Webhooks
    • Create Webhook
    • Delete Webhook
    • Disable Webhook
    • Enable Webhook
    • Get Webhooks
    • Get Webhook
  • MISCALLANEOUS
    • Carriers Available
    • Carrier Object
    • Cities
    • Countries
    • File Claim Object
    • Parcel Item
    • Quick Shipments
      • Parcel
      • Pickup / Delivery Address
    • Shipment Events
    • Shipment Extras
    • States
    • Webhook Events
      • Handling Webhook Events
    • Volumetric Weight
Powered by GitBook
On this page

Was this helpful?

Addresses

The Addresses API allows you to create and manage pickup and delivery locations.

The Address Object

This section describes the different attributes available for an address.

address_id

string

Unique reference for address.

city

string

coordinates

object

Geo coordinates for address.

coordinates.lat

number

Latitude for address coordinates

coordinates.lng

number

Longitude for address coordinates

country

string

email

string

Email of person at address.

first_name

string

First name of person at address.

is_residential

boolean

Indicates if address is a residential address or not.

last_name

string

Last name of person at address.

line1

string

Street address.

line2

string

Second line of street address.

metadata

object

Provide additional information for an address.

name

string

Full name of person at address.

phone

string

International phone number for person at address. Must match country provided.

place_id

string

Unique google place id for address location.

state

string

zip

string

Zip / Postal code for address.

created_at

datetime

Time address created.

updated_at

datetime

Time address last updated.

PreviousLibraries & PluginsNextCreate Address

Last updated 11 months ago

Was this helpful?

Valid address .

ISO 2 code for address. e.g. NG

Valid address .

Page cover image
city
country
state