---
title: "Create Box"
method: POST
path: "/print-mail/v1/boxes"
tags: ["Boxes"]
---

# Create Box

`POST /print-mail/v1/boxes`

This endpoint allows you to create a box containing up to 100 cheques.
A Box is mailed to a single destination.

To create a box. You must specify:
- `to`: The recipient (contact or contact ID)
- `from`: The sender (contact or contact ID)
- `cheques`: An array of cheques to go in the box

For each cheque You must specify:
- `to`: The recipient (contact or contact ID)
- `from`: The sender (contact or contact ID)
- `bankAccount`: The bank account ID
- `amount`: The amount to be sent
- `number`: The cheque number

## Request body

- BoxCreate
  - `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.
  - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
  - `metadata` object — See the section on Metadata.
  - `sendDate` string, date-time — This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date.
  - `mailingClass` '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'
  - `to` union, required — The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.
    - union
      - ContactCreateWithFirstName
        - `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.
        - `companyName` string — Company name of the contact.
        - `lastName` string — Last name of the contact.
        - `email` string — Email of the contact.
        - `phoneNumber` string — Phone number of the contact.
        - `jobTitle` string — Job title of the contact.
        - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
        - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
        - `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.
        - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
        - `metadata` object — See the section on Metadata.
        - `firstName` string, required
      - ContactCreateWithCompanyName
        - `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.
        - `firstName` string — First name of the contact.
        - `lastName` string — Last name of the contact.
        - `email` string — Email of the contact.
        - `phoneNumber` string — Phone number of the contact.
        - `jobTitle` string — Job title of the contact.
        - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
        - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
        - `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.
        - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
        - `metadata` object — See the section on Metadata.
        - `companyName` string, required
    - string
  - `from` union, required — The 'from' (sender) of the entire box. Accepts inline ContactCreate or a contactID.
    - union
      - ContactCreateWithFirstName
        - `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.
        - `companyName` string — Company name of the contact.
        - `lastName` string — Last name of the contact.
        - `email` string — Email of the contact.
        - `phoneNumber` string — Phone number of the contact.
        - `jobTitle` string — Job title of the contact.
        - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
        - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
        - `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.
        - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
        - `metadata` object — See the section on Metadata.
        - `firstName` string, required
      - ContactCreateWithCompanyName
        - `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.
        - `firstName` string — First name of the contact.
        - `lastName` string — Last name of the contact.
        - `email` string — Email of the contact.
        - `phoneNumber` string — Phone number of the contact.
        - `jobTitle` string — Job title of the contact.
        - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
        - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
        - `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.
        - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
        - `metadata` object — See the section on Metadata.
        - `companyName` string, required
    - string
  - `cheques` BoxChequeCreate[], required — The cheques to be mailed in the box. Only 100 cheques can be included in a box at a time.
    - `bankAccount` string, required — The bank account (ID or reference) from which the cheque amount is drawn.
    - `amount` integer, required — The amount on the cheque.
    - `memo` string — The memo text on the cheque (optional).
    - `logoURL` string, 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` integer, required — The cheque number.
    - `mergeVariables` object — A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

## Response `201`

The created Box.

- Box
  - `status` 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled', required
  - `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.
  - `trackingNumber` string — The tracking number of this order. Populated after an express/certified order has been processed for delivery.
  - `imbStatus` '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` string, date-time — The last date that the IMB status was updated. See `imbStatus` for more details.
  - `cancellation` Cancellation
    - `reason` 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class', required
    - `cancelledByUser` string — The user ID who cancelled the order.
    - `note` string — An optional note provided by the user who cancelled the order.
  - `url` string, 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.
  - `id` 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.
  - `live` boolean, required — `true` if this is a live mode resource else `false`.
  - `createdAt` string, date-time, required — The UTC time at which this resource was created.
  - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
  - `sendDate` string, 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` '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', required
  - `to` Contact, required
    - `id` 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.
    - `live` boolean, required — `true` if this is a live mode resource else `false`.
    - `createdAt` string, date-time, required — The UTC time at which this resource was created.
    - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
  - `object` 'box', required — Always "box".
  - `from` Contact, required
    - `id` 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.
    - `live` boolean, required — `true` if this is a live mode resource else `false`.
    - `createdAt` string, date-time, required — The UTC time at which this resource was created.
    - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
  - `cheques` BoxCheque[], required — The cheques inside this box (in read mode).
    - `bankAccount` string, required — The bank account (ID or reference) from which the cheque amount is drawn.
    - `amount` integer, required — The amount on the cheque.
    - `memo` string — The memo text on the cheque (optional).
    - `logoURL` string, 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` integer, required — The cheque number.
    - `mergeVariables` object — A set of dynamic merge variables for customizing the cheque or accompanying documents (optional).

## Other responses

- `400` — The created Box.
- `401` — The created Box.
- `404` — The created Box.
- `422` — The created Box.
- `429` — The created Box.
- `500` — The created Box.

---

[API](https://skmtc.net/postgrid/apis/postgrid-address-verification-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-address-verification-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-address-verification-api/revisions/537d2bbc624a/schema)