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.

200 Parcel created successfully.

{
	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'
	}
}