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. Shipments

Get Shipments

Fetch a list of all shipments available for a user.

/shipments

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

This endpoint allows you to get a list of shipments available for a user.

Query Parameters

Name
Type
Description

perPage

string

Specify how many results will be returned in a single request. Defaults to 100.

page

string

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

popluate

boolean

Indicate if full details should be provided for select fields including address_from, address_return, address_to, carrier, parcel.

status

string

Status of shipment. Must be one of cancelled, confirmed, delivered, draft, in-transit, pending

Headers

Name
Type
Description

Authorization*

string

Set value to Bearer ACCESS_TOKEN

{
	status: true,
	message: 'Shipments retrieved successfully',
	data: [{
		address_from: {
			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'			
		},
		address_return: {
			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'		
		},
		address_to: {
			address_id: 'AD-95918335217',	
			city: 'London',
			coordinates: {
					lat: 43.653226,
					lng: -79.3831843
			},	
			country: 'GBR',
			email: 'timothy@shipmonk.ng',
			first_name: 'Timothy',
			id: 'S3YLVnGo9eKpMMbEQcWjgCraLqnNY2Oy',
			is_residential: true,
			last_name: 'Odunubi',
			line1: '45 Greenwich Lane, London',
			line2: '',
			metadata: {
				my_app_customer_id: 10567
			},
			name: 'Timothy Odunubi',
			phone: '+447514022567',
			state: '',
			zip: 'SE5 4HB'		
		},
		events: [],
		id: 'BUbL05Ecprhc2q17Xh9woRSwNpXJehay',
		metadata: {},
		parcel: {
			description: true,
			id: 'Zt4Xh2pbbCmeVcr5YH9lsFHGqoW3i5w3',
			items: [{
				description: 'Shoes purchased from Shipmonk Store',
				name: 'Rubber Boots',
				currency: 'NGN',
				value: 25000',
				weight: 2.5
				quantity: 1
			}],
			metadata: {},		
			packaging: 'LsuiGzcYlz4dKRYnEXeobJu9gnVbQVXN',
			parcel_id: 'PC-25164820699',
			total_weight: 2.51,
			weight: 2.5,
			weight_unit: 'kg'		
		},
		rate: '',
		shipment_id: 'SH-40208776515',
		status: 'draft',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'		
	}],
	pageData: {
    		"total": 1,
    		"perPage": 100,
    		"page": 1,
    		"pageCount": 1		
	}
	
}
PreviousUpdate ShipmentNextGet Shipments v2

Last updated 1 year ago

Was this helpful?