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

Create Parcel

Create a parcel for a shipment.

/parcels

POST https://api.terminal.africa/v1/parcels

This endpoint allows you to create a new parcel for a shipment.

Headers

Name
Type
Description

Authorization*

string

Set value to Bearer SECRET_KEY

Content-Type

string

Set value to application/json

Request Body

Name
Type
Description

description

string

Description of parcel.

items*

array

Object array of items in parcel. See Parcel Item object under MISCALLANEOUS for attributes required for each item.

metadata

object

Additional information for a parcel.

packaging*

string

Unique id of packaging used to wrap items in parcel.

proof_of_payments

array

An array of string containing urls to documents/files

rec_docs

array

An array of string containing urls of images of parcel on a scale or with measuring tape

weight_unit*

string

Weight unit of parcel. Only kg is allowed at this time.

{
	status: true,
	message: 'Parcel created successfully',
	data: {
		description: true,
		id: 'Zt4Xh2pbbCmeVcr5YH9lsFHGqoW3i5w3',
		items: [{
			description: 'Shoes purchased from Shipmonk Store',
			name: 'Rubber Boots',
			currency: 'NGN',
			value: 25000',
			weight: 2.5
			quantity: 1
		}],
		metadata: {},		
		proof_of_payments: [],
		rec_docs: [],
		packaging: 'PA-97263925515',
		parcel_id: 'PC-25164820699',
		totalWeight: 2.51,
		weight: 2.5,
		weight_unit: 'kg',
		created_at: '2021-07-13T20:25:53.011Z',
		updated_at: '2021-07-13T20:25:53.011Z'
	}
}
PreviousParcelsNextUpdate Parcel

Last updated 10 months ago

Was this helpful?