Skip to content

Pickup Bags ​

zr.pickupBags manages the containers that group parcels for driver pickup (8 operations).

Search & get ​

ts
const page = await zr.pickupBags.search({ pageSize: 20 });
for await (const bag of zr.pickupBags.searchAll({ pageSize: 100 })) { /* … */ }

const bag = await zr.pickupBags.get(id);
const byTracking = await zr.pickupBags.getByTrackingNumber('PB-123');

Parcels inside a bag ​

ts
const parcels = await zr.pickupBags.searchParcels(trackingNumber, { pageSize: 50 });
for await (const p of zr.pickupBags.searchParcelsAll(trackingNumber, { pageSize: 100 })) {
  // …
}

Create & modify ​

ts
const created = await zr.pickupBags.create({ /* CreatePickupBagRequest */ });

await zr.pickupBags.addParcels(bagId, { /* AddParcelsToPickupBagRequest */ });
await zr.pickupBags.removeParcel(bagId, { /* RemoveParcelFromPickupBagRequest */ });
await zr.pickupBags.delete(id);

Pickup-bag label ​

The label PDF is generated via zr.labels:

ts
const { fileUrl } = await zr.labels.generatePickupBagPdf({ /* GeneratePickupBagLabelPdfRequest */ });

Modification requests (pending parcel changes awaiting operator validation) live in zr.modificationRequests (search, searchByParcel, create, update, get, delete).

Released under the MIT License. Not affiliated with ZR Express.