Parcels
Parcels can currently only be created through fulfillments, manifests or shipments.
Updates an existing parcel and its contents using the id of the parcel.
The request body accepts properties for both the parcel and its contents. All fields are optional and only provided fields will be updated.
{
// Core Properties
type: string, // Type of the parcel
status: string,
special_handling_tags: string[],
// Dimensions and Weight
length: number,
width: number,
height: number,
weight: number,
// Identifiers and References
external_container_id: string,
container_number: string,
tracking_number: string,
label_url: string,
layout_id: string,
// Status Flags
defective: boolean,
missing: boolean,
received: boolean,
unpacked: boolean,
contents: [
{
id: string,
special_handling_tags: string[],
item_id: string,
sku: string,
gtin: string
packed_qty: number,
is_asset: boolean,
comment: string,
verified_qty: number,
requested_qty: number,
defective_qty: number,
value_added_services: string[]
}
]
}
The parcel and its contents can be updated as follows
{
"status": "inbound_transit",
"layout_id": "lay_XkTCC8FvgM65akxw",
"special_handling_tags": ["fragile", "dry_cleaning"],
"length": 20,
"width": 20,
"height": 20,
"weight": 70,
"contents": [
{
"id": "cont_abc1231xyz",
"special_handling_tags": ["fragile"],
"item_id": "item_czhgjrk5JaVvyATPDbyURp",
"verified_qty": 2,
"requested_qty": 3,
"defective_qty": 5
}
]
}
const res = await fetch(`https://api.packagex.io/v1/parcels/${parcel_id}`, {
method: "POST",
headers: {
"PX-API-KEY": process.env.PX_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify(data),
}).then((res) => res.json());