Update Parcel

Update a parcel for a shipment.

/parcels/:parcel_id

PUT https://api.terminal.africa/v1/parcels/:parcel_id

This endpoint allows you to update information in an existing parcel. Only unused parcels can be updated.

Path Parameters

Name	Type	Description
parcel_id*	String	Unique parcel_id for parcel.

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 items in parcel.
items	Array	List of items in parcel. Array of parcel item objects representing the items in the parcel.
packaging	String	Unique packaging_id to be used in parcel.
metadata	Object	Additional information for a parcel.

200: OK Parcel updated successfully.

{
	status: true,
	message: 'Parcel updated successfully',
	data: {
		description: "Cardboard box containing shoes from Shipmonk store",
		id: 'Zt4Xh2pbbCmeVcr5YH9lsFHGqoW3i5w3',
		items: [{
			description: 'Shoes purchased from Shipmonk Store',
			name: 'Rubber Boots',
			currency: 'NGN',
			value: 25000',
			weight: 2.5
			quantity: 1
		}],
		metadata: {},		
		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'
	}
}