Get Box

get https://api.postgrid.com/print-mail/v1/boxes/{id}

Retrieve a box by ID.

Responses

Response body

object

status

string

required

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

ready printing processed_for_delivery completed cancelled

mergeVariables

object

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.

Has additional fields

trackingNumber

string

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

imbStatus

string

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.

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.

imbDate

date-time

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

cancellation

object

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

reason

string

required

The reason for the cancellation.

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.

url

uri

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.

string

required

A unique ID prefixed with box_

description

string

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

metadata

object

See the section on Metadata.

Has additional fields

live

boolean

required

true if this is a live mode resource else false.

createdAt

date-time

required

The UTC time at which this resource was created.

updatedAt

date-time

required

The UTC time at which this resource was last updated.

sendDate

date-time

required

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.

mailingClass

string

required

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

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

required

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

object

string

required

Always contact.

contact

addressLine1

string

required

The first line of the contact's address.

addressLine2

string

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

city

string

The city of the contact's address.

provinceOrState

string

Province or state of the contact's address.

postalOrZip

string

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

countryCode

string

required

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

addressStatus

string

required

One of verified, corrected, or failed.

verified corrected failed

addressErrors

string

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

companyName

string

Company name of the contact.

firstName

string

First name of the contact.

lastName

string

Last name of the contact.

string

Email of the contact.

phoneNumber

string

Phone number of the contact.

jobTitle

string

Job title of the contact.

skipVerification

boolean

Defaults to false

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

forceVerifiedStatus

boolean

Defaults to false

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

string

required

A unique ID prefixed with contact_

description

string

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

metadata

object

See the section on Metadata.

Has additional fields

live

boolean

required

true if this is a live mode resource else false.

createdAt

date-time

required

The UTC time at which this resource was created.

updatedAt

date-time

required

The UTC time at which this resource was last updated.

object

string

required

Always "box".

box

from

object

required

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

object

string

required

Always contact.

contact

addressLine1

string

required

The first line of the contact's address.

addressLine2

string

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

city

string

The city of the contact's address.

provinceOrState

string

Province or state of the contact's address.

postalOrZip

string

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

countryCode

string

required

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

addressStatus

string

required

One of verified, corrected, or failed.

verified corrected failed

addressErrors

string

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

companyName

string

Company name of the contact.

firstName

string

First name of the contact.

lastName

string

Last name of the contact.

string

Email of the contact.

phoneNumber

string

Phone number of the contact.

jobTitle

string

Job title of the contact.

skipVerification

boolean

Defaults to false

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

forceVerifiedStatus

boolean

Defaults to false

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

string

required

A unique ID prefixed with contact_

description

string

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

metadata

object

See the section on Metadata.

Has additional fields

live

boolean

required

true if this is a live mode resource else false.

createdAt

date-time

required

The UTC time at which this resource was created.

updatedAt

date-time

required

The UTC time at which this resource was last updated.

cheques

array of objects

required

The cheques inside this box (in read mode).

cheques*

object

from

object

required

object

required

bankAccount

string

required

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

amount

int32

required

The amount on the cheque.

memo

string

The memo text on the cheque (optional).

logoURL

uri

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

messageTemplate

string

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

number

int32

required

The cheque number.

mergeVariables

object

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

Has additional fields

Language

Credentials

Header


xxxxxxxxxx
1
const options = {method: 'GET', headers: {accept: 'application/json'}};
2
3
fetch('https://api.postgrid.com/print-mail/v1/boxes/id', options)
4
  .then(res => res.json())
5
  .then(res => console.log(res))
6
  .catch(err => console.error(err));

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The retrieved Box.

401The retrieved Box.

404The retrieved Box.

422The retrieved Box.

429The retrieved Box.