API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Boxes

Create and manage box orders.

Create Box

client.printMail.boxes.create(BoxCreateParams { cheques, from, to, 5 more } body, RequestOptionsoptions?): BoxCreateResponse { id, cheques, createdAt, 17 more }

POST/print-mail/v1/boxes

List Boxes

client.printMail.boxes.list(BoxListParams { limit, search, skip } query?, RequestOptionsoptions?): SkipLimit<BoxListResponse { id, cheques, createdAt, 17 more } >

GET/print-mail/v1/boxes

Get Box

client.printMail.boxes.retrieve(stringid, RequestOptionsoptions?): BoxRetrieveResponse { id, cheques, createdAt, 17 more }

GET/print-mail/v1/boxes/{id}

Cancel Box

client.printMail.boxes.delete(stringid, RequestOptionsoptions?): BoxDeleteResponse { id, cheques, createdAt, 17 more }

DELETE/print-mail/v1/boxes/{id}

Progress Status

client.printMail.boxes.progressions(stringid, RequestOptionsoptions?): BoxProgressionsResponse { id, cheques, createdAt, 17 more }

POST/print-mail/v1/boxes/{id}/progressions

ModelsExpand Collapse

BoxCreateResponse { id, cheques, createdAt, 17 more }

id: string

A unique ID prefixed with box_

cheques: Array<Cheque>

The cheques inside this box (in read mode).

amount: number

The amount on the cheque.

formatint32

bankAccount: string

The bank account (ID or reference) from which the cheque amount is drawn.

from: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

number: number

The cheque number.

formatint32

to: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

logoURL?: string

A URL to a logo for the cheque (optional).

formaturi

memo?: string

The memo text on the cheque (optional).

mergeVariables?: Record<string, unknown>

A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

messageTemplate?: string

An optional message template to be printed on or with the cheque.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact of the ‘from’ field in read mode should be a fully expanded Contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "first_class" | "standard_class" | "express" | 23 more

The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "box"

Always “box”.

sendDate: string

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

formatdate-time

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "entered_mail_stream" | "out_for_delivery" | "returned_to_sender"

The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

metadata?: Record<string, unknown>

See the section on Metadata.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

url?: string

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

formaturi

BoxListResponse { id, cheques, createdAt, 17 more }

id: string

A unique ID prefixed with box_

cheques: Array<Cheque>

The cheques inside this box (in read mode).

amount: number

The amount on the cheque.

formatint32

bankAccount: string

The bank account (ID or reference) from which the cheque amount is drawn.

from: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

number: number

The cheque number.

formatint32

to: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

logoURL?: string

A URL to a logo for the cheque (optional).

formaturi

memo?: string

The memo text on the cheque (optional).

mergeVariables?: Record<string, unknown>

A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

messageTemplate?: string

An optional message template to be printed on or with the cheque.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact of the ‘from’ field in read mode should be a fully expanded Contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "first_class" | "standard_class" | "express" | 23 more

The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "box"

Always “box”.

sendDate: string

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

formatdate-time

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "entered_mail_stream" | "out_for_delivery" | "returned_to_sender"

The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

metadata?: Record<string, unknown>

See the section on Metadata.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

url?: string

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

formaturi

BoxRetrieveResponse { id, cheques, createdAt, 17 more }

id: string

A unique ID prefixed with box_

cheques: Array<Cheque>

The cheques inside this box (in read mode).

amount: number

The amount on the cheque.

formatint32

bankAccount: string

The bank account (ID or reference) from which the cheque amount is drawn.

from: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

number: number

The cheque number.

formatint32

to: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

logoURL?: string

A URL to a logo for the cheque (optional).

formaturi

memo?: string

The memo text on the cheque (optional).

mergeVariables?: Record<string, unknown>

A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

messageTemplate?: string

An optional message template to be printed on or with the cheque.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact of the ‘from’ field in read mode should be a fully expanded Contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "first_class" | "standard_class" | "express" | 23 more

The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "box"

Always “box”.

sendDate: string

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

formatdate-time

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "entered_mail_stream" | "out_for_delivery" | "returned_to_sender"

The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

metadata?: Record<string, unknown>

See the section on Metadata.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

url?: string

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

formaturi

BoxDeleteResponse { id, cheques, createdAt, 17 more }

id: string

A unique ID prefixed with box_

cheques: Array<Cheque>

The cheques inside this box (in read mode).

amount: number

The amount on the cheque.

formatint32

bankAccount: string

The bank account (ID or reference) from which the cheque amount is drawn.

from: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

number: number

The cheque number.

formatint32

to: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

logoURL?: string

A URL to a logo for the cheque (optional).

formaturi

memo?: string

The memo text on the cheque (optional).

mergeVariables?: Record<string, unknown>

A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

messageTemplate?: string

An optional message template to be printed on or with the cheque.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact of the ‘from’ field in read mode should be a fully expanded Contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "first_class" | "standard_class" | "express" | 23 more

The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "box"

Always “box”.

sendDate: string

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

formatdate-time

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "entered_mail_stream" | "out_for_delivery" | "returned_to_sender"

The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

metadata?: Record<string, unknown>

See the section on Metadata.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

url?: string

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

formaturi

BoxProgressionsResponse { id, cheques, createdAt, 17 more }

id: string

A unique ID prefixed with box_

cheques: Array<Cheque>

The cheques inside this box (in read mode).

amount: number

The amount on the cheque.

formatint32

bankAccount: string

The bank account (ID or reference) from which the cheque amount is drawn.

from: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

number: number

The cheque number.

formatint32

to: Contact { id, addressLine1, addressStatus, 21 more }

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

logoURL?: string

A URL to a logo for the cheque (optional).

formaturi

memo?: string

The memo text on the cheque (optional).

mergeVariables?: Record<string, unknown>

A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

messageTemplate?: string

An optional message template to be printed on or with the cheque.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

from: Contact { id, addressLine1, addressStatus, 21 more }

The contact of the ‘from’ field in read mode should be a fully expanded Contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

live: boolean

true if this is a live mode resource else false.

mailingClass: "first_class" | "standard_class" | "express" | 23 more

The mailing class of this order. This determines the speed and cost of delivery. See OrderMailingClass for more details.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

object: "box"

Always “box”.

sendDate: string

This order will transition from ready to printing on the day after this date. For example, if this is a date on Tuesday, the order will transition to printing on Wednesday at midnight eastern time.

formatdate-time

status: "ready" | "printing" | "processed_for_delivery" | 2 more

See OrderStatus for more details on the status of this order.

One of the following:

"ready"

"printing"

"processed_for_delivery"

"completed"

"cancelled"

to: Contact { id, addressLine1, addressStatus, 21 more }

The recipient of this order. This will be provided even if you delete the underlying contact.

id: string

A unique ID prefixed with contact_

addressLine1: string

The first line of the contact’s address.

addressStatus: "verified" | "corrected" | "failed"

One of verified, corrected, or failed.

One of the following:

"verified"

"corrected"

"failed"

countryCode: string

The ISO 3611-1 country code of the contact’s address.

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

object: "contact"

Always contact.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

addressErrors?: string

A series of human-readable errors/warnings that were raised when running the provided address through our address verification.

addressLine2?: string

Second line of the contact’s address, if applicable.

city?: string

The city of the contact’s address.

companyName?: string

Company name of the contact.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

email?: string

Email of the contact.

firstName?: string

First name of the contact.

forceVerifiedStatus?: boolean

If true, PostGrid will force this contact to have an addressStatus of verified even if our address verification system says otherwise.

jobTitle?: string

Job title of the contact.

lastName?: string

Last name of the contact.

metadata?: Record<string, unknown>

See the section on Metadata.

phoneNumber?: string

Phone number of the contact.

postalOrZip?: string

The postal or ZIP code of the contact’s address.

provinceOrState?: string

Province or state of the contact’s address.

secret?: boolean

If true, the contact’s details are hidden from the dashboard and API responses apart from the final print. The contact ID can then be used as a token for sending mail without giving access to the underlying data.

skipVerification?: boolean

If true, PostGrid will skip running this contact’s address through our address verification system.

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

cancellation?: Cancellation { reason, cancelledByUser, note }

The cancellation details of this order. Populated if the order has been cancelled.

reason: "user_initiated" | "invalid_content" | "invalid_order_mailing_class"

The reason for the cancellation.

One of the following:

"user_initiated"

"invalid_content"

"invalid_order_mailing_class"

cancelledByUser?: string

The user ID who cancelled the order.

note?: string

An optional note provided by the user who cancelled the order.

description?: string

An optional string describing this resource. Will be visible in the API and the dashboard.

imbDate?: string

The last date that the IMB status was updated. See imbStatus for more details.

formatdate-time

imbStatus?: "entered_mail_stream" | "out_for_delivery" | "returned_to_sender"

The Intelligent Mail Barcode (IMB) status of this order. Only populated for US-printed and US-destined orders. This is the most detailed way to track non-express/certified orders.

One of the following:

"entered_mail_stream"

"out_for_delivery"

"returned_to_sender"

imbZIPCode?: string

The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an imbStatus is present.

mergeVariables?: Record<string, unknown>

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

metadata?: Record<string, unknown>

See the section on Metadata.

trackingNumber?: string

The tracking number of this order. Populated after an express/certified order has been processed for delivery.

url?: string

PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all GET endpoints which produce this order.

This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the GET endpoint again.

formaturi