Each heading below is the name of the database table as it should be spelled in your queries.
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
firstName | VARCHAR | | | |
lastName | VARCHAR | | | |
email | VARCHAR | | | |
phoneNumber | VARCHAR | | | |
addressLine1 | VARCHAR | | | |
addressLine2 | VARCHAR | | | |
city | VARCHAR | | | |
provinceOrState | VARCHAR | | | |
postalOrZip | VARCHAR | | | |
countryCode | VARCHAR | | | |
addressStatus | VARCHAR | | | |
addressErrors | JSON | | | |
skipVerification | BOOLEAN | | | |
forceVerifiedStatus | BOOLEAN | | | |
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
sendDate | TIMESTAMP | | | Scheduled print date. Defaults to the next business day if omitted. |
from_id | VARCHAR | | contacts | Sender contact ID (foreign key into contacts). |
to_id | VARCHAR | | contacts | Recipient contact ID (foreign key into contacts). |
user | VARCHAR | | | User that created the record (dashboard/API). |
status | VARCHAR | | | Order status in the delivery pipeline (e.g., ready → printing → processed_for_delivery → completed; cancelled possible). |
pageCount | INTEGER | | | Number of pages in the generated mail piece. |
trackingNumber | VARCHAR | | | Carrier tracking number (US orders get a USPS tracking number once processed). |
imbStatus | VARCHAR | | | Intelligent Mail Barcode status (US-only; e.g., entered_mail_stream, out_for_delivery, returned_to_sender). |
imbZIPCode | VARCHAR | | | ZIP code from IMB scan metadata (US-only). |
imbDate | TIMESTAMP | | | Timestamp of the latest IMB scan (US-only). |
express | BOOLEAN | | | Express shipping flag (expedited printing/shipping; extra charge). |
mailingClass | VARCHAR | | | Selected mail class (e.g., First Class vs Standard/Marketing Mail). |
mergeVariables | JSON | | | JSON used to populate {{ }} placeholders in templates at render time. |
color | BOOLEAN | | | |
doubleSided | BOOLEAN | | | |
addressPlacement | VARCHAR | | | |
envelope | VARCHAR | | | Return envelope resource to include with the mailing, if supplied. |
returnEnvelope | VARCHAR | | | |
size | VARCHAR | | | Print size/format for this collateral. |
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
sendDate | TIMESTAMP | | | Scheduled print date. Defaults to the next business day if omitted. |
from_id | VARCHAR | | contacts | Sender contact ID (foreign key into contacts). |
to_id | VARCHAR | | contacts | Recipient contact ID (foreign key into contacts). |
user | VARCHAR | | | User that created the record (dashboard/API). |
status | VARCHAR | | | Order status in the delivery pipeline (e.g., ready → printing → processed_for_delivery → completed; cancelled possible). |
pageCount | INTEGER | | | Number of pages in the generated mail piece. |
trackingNumber | VARCHAR | | | Carrier tracking number (US orders get a USPS tracking number once processed). |
imbStatus | VARCHAR | | | Intelligent Mail Barcode status (US-only; e.g., entered_mail_stream, out_for_delivery, returned_to_sender). |
imbZIPCode | VARCHAR | | | ZIP code from IMB scan metadata (US-only). |
imbDate | TIMESTAMP | | | Timestamp of the latest IMB scan (US-only). |
express | BOOLEAN | | | Express shipping flag (expedited printing/shipping; extra charge). |
mailingClass | VARCHAR | | | Selected mail class (e.g., First Class vs Standard/Marketing Mail). |
mergeVariables | JSON | | | JSON used to populate {{ }} placeholders in templates at render time. |
size | VARCHAR | | | Print size/format for this collateral. |
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
sendDate | TIMESTAMP | | | Scheduled print date. Defaults to the next business day if omitted. |
from_id | VARCHAR | | contacts | Sender contact ID (foreign key into contacts). |
to_id | VARCHAR | | contacts | Recipient contact ID (foreign key into contacts). |
user | VARCHAR | | | User that created the record (dashboard/API). |
status | VARCHAR | | | Order status in the delivery pipeline (e.g., ready → printing → processed_for_delivery → completed; cancelled possible). |
pageCount | INTEGER | | | Number of pages in the generated mail piece. |
trackingNumber | VARCHAR | | | Carrier tracking number (US orders get a USPS tracking number once processed). |
imbStatus | VARCHAR | | | Intelligent Mail Barcode status (US-only; e.g., entered_mail_stream, out_for_delivery, returned_to_sender). |
imbZIPCode | VARCHAR | | | ZIP code from IMB scan metadata (US-only). |
imbDate | TIMESTAMP | | | Timestamp of the latest IMB scan (US-only). |
express | BOOLEAN | | | Express shipping flag (expedited printing/shipping; extra charge). |
mailingClass | VARCHAR | | | Selected mail class (e.g., First Class vs Standard/Marketing Mail). |
mergeVariables | JSON | | | JSON used to populate {{ }} placeholders in templates at render time. |
size | VARCHAR | | | Print size/format for this collateral. |
bankAccount | VARCHAR | | | Bank account used to issue the cheque. |
amount | INTEGER | | | Cheque amount. |
currencyCode | VARCHAR | | | ISO currency code for the cheque (e.g., USD, CAD). |
envelope | VARCHAR | | | Return envelope resource to include with the mailing, if supplied. |
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
sendDate | TIMESTAMP | | | Scheduled print date. Defaults to the next business day if omitted. |
from_id | VARCHAR | | contacts | Sender contact ID (foreign key into contacts). |
to_id | VARCHAR | | contacts | Recipient contact ID (foreign key into contacts). |
user | VARCHAR | | | User that created the record (dashboard/API). |
status | VARCHAR | | | Order status in the delivery pipeline (e.g., ready → printing → processed_for_delivery → completed; cancelled possible). |
pageCount | INTEGER | | | Number of pages in the generated mail piece. |
trackingNumber | VARCHAR | | | Carrier tracking number (US orders get a USPS tracking number once processed). |
imbStatus | VARCHAR | | | Intelligent Mail Barcode status (US-only; e.g., entered_mail_stream, out_for_delivery, returned_to_sender). |
imbZIPCode | VARCHAR | | | ZIP code from IMB scan metadata (US-only). |
imbDate | TIMESTAMP | | | Timestamp of the latest IMB scan (US-only). |
express | BOOLEAN | | | Express shipping flag (expedited printing/shipping; extra charge). |
mailingClass | VARCHAR | | | Selected mail class (e.g., First Class vs Standard/Marketing Mail). |
mergeVariables | JSON | | | JSON used to populate {{ }} placeholders in templates at render time. |
size | VARCHAR | | | Print size/format for this collateral. |
| Column | Type | PK | FK | Description |
|---|
id | VARCHAR | Yes | | PostGrid resource ID (returned on creation; used to retrieve later). |
createdAt | TIMESTAMP | | | Timestamp when the record was created. |
updatedAt | TIMESTAMP | | | Timestamp when the record was last updated. |
description | VARCHAR | | | Freeform description for your order/campaign (helps you identify the mailing in the dashboard). |
metadata | JSON | | | Arbitrary key–value JSON attached to the object for analytics/segmentation (size-limited). |
tracker | VARCHAR | | | Tracker ID (QR code / PURL definition) that generated this visit. |
orderID | VARCHAR | | | Order ID (letter/postcard/cheque/self-mailer) associated with this tracker visit. |
device | VARCHAR | | | Device classification captured for the visit (e.g., mobile/desktop). |
ipAddress | VARCHAR | | | Visitor IP captured for the visit. |
