Tracking the status of a mailing

Note: most cheaper postage services don't provide tracking once an item has left our facility. Where tracking is provided, the tracking number is included in the API response.

Each mail item in a print job has its own status — while most items in a job might already have been sent, larger items can still be in production.

const printJob = await ip.prints.retrieve('print-job-id')

for (const item of printJob.letters) {
  console.log(`Letter ${item.id} is: ${item.status}`)
  // For tracked postage services, the tracking number is on item.tracking_number.
}

Mail item statuses

• draft — the print job hasn't been confirmed yet.
• waiting_to_print — the mail item is waiting to be printed.
• printing — the mail item is being printed.
• enclosing — the mail item is being enclosed.
• shipping — the mail item is waiting to be picked up by the postage service.
• sent — the mail item has been sent.
• returned — the mail item was returned to Intelliprint; a reason and date are attached in the item's returned field.
• cancelled — the mail item was cancelled by the user.
• invalid_address — the postage service refused to pick up the item because the address was deemed invalid. This is rare and only possible on tracked postage services.

See the full parameter reference in the developer docs.