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?

  1. Addresses

Get Addresses

Fetch list of addresses available for a user.

/addresses

GET https://api.terminal.africa/v1/addresses

This endpoint allows you to get a list of all addresses available.

Query Parameters

Name
Type
Description

perPage

Number

Specify how many records will be sent in a single response. Defaults to 100.

page

Number

Specify what page of records will be sent in response. Defaults to 1.

Headers

Name
Type
Description

Authorization*

String

Set value to Bearer SECRET_KEY

{
    "status": true,
    "message": "Addresses retrieved successfully",
    "data": {
        "addresses": [
            {
                "address_id": "AD-00632494667",
                "city": "Lagos",
                "coordinates": {
                    "lat": 6.5969424,
                    "lng": 3.3542992
                },
                "country": "NGA",
                "email": "augustus_obi@shipmonk.ng",
                "first_name": "Augustus",
                "id": "d799c2679e644279b59fe661ac8fa488",
                "is_residential": true,
                "last_name": "Obi",
                "line1": "1121 Allen Avenue, Ikeja",
                "line2": "",
                "metadata": {
                    "my_app_customer_id": 11234
                },
                "name": "Augustus Obi",
                "phone": "+2348122340000",
                "state": "Lagos",
                "zip": "121006",
                "created_at": "2021-07-13T20:25:53.011Z",
                "updated_at": "2021-07-13T20:25:53.011Z"
            }],
        "pagination": {
            "perPage": 100,
            "prevPage": null,
            "nextPage": 2,
            "currentPage": 1,
            "total": 3,
            "pageCount": 3,
            "pagingCounter": 1,
            "hasPrevPage": false,
            "hasNextPage": true	
        }
    }
}

PreviousCreate AddressNextGet Address

Last updated 2 years ago

Was this helpful?