Form Guide

This guide explains how to generate shipping Forms for purchased shipments using the EasyPost API.

Easypost supports several shipping forms. Some forms are requested by creating a Form after purchasing a shipment, while others are automatically generated by the carrier or enabled through shipment options. The sections below describe how each form is generated and which carriers support it.


Prerequisites

  • Purchase the shipment before creating a Form.
  • Some forms require carrier-specific configuration.
  • Some forms are generated automatically or by shipment options.

Forms Created by Request

Create these forms by making a Form request after purchasing a shipment.

Form
Parameters
Carrier
Label QR CodeFormUSPS. See Label Broker Guide
Return Packing SlipReturn packing slip parametersAll carriers
RMA QR CodeRMA QR Code parametersFedex (Note: This requires account provisioning. Please contact support to use this feature.)

Forms Generated Automatically

These forms are automatically generated when the shipment meets the carrier’s requirements. No Form request is required.

Form
Carrier
Cod Return LabelFedEx
Commercial InvoiceAll carriers that support international shipments commercial invoice
CN22Select carriers like USPS. The CN22 form will be included on your postage label when available.
CRN ReportFedEx
High Value ReportUPS (note: UPS automatically creates this based on the shipment)
Order SummaryAustralia Post, Deutsche Post, and FedEx Fuse

Forms Generated by Shipment Options

These forms are generated when the corresponding shipment option is enabled.

Form
Shipment Option
Carrier
NAFTA Certificate of Origin (USMCA)nafta_certificate_of_origin: trueFedEx (REST)

Note: Although the shipment option is named nafta_certificate_of_origin, the trade agreement is now known as the United States-Mexico-Canada Agreement (USMCA). For eligible FedEx REST shipments between the United States, Canada, and Mexico, setting nafta_certificate_of_origin: true causes FedEx to generate and electronically submit the certificate when applicable.


Examples

Label QR Code Parameters

{
  "form": {
    "type": "label_qr_code"
  }
}

Return Packing Slip Parameters

{
  "form": {
    "type": "return_packing_slip",
    "barcode": "RMA12345678900",
    "line_items": [
      {
        "product": {
          "title": "Square Reader",
          "barcode": "123456789"
        },
        "units": 8
      }
    ]
  }
}

RMA QR Code Parameters

{
  "form": {
    "type": "rma_qr_code",
    "rma": {
      "pack_and_return": true,
      "label_image_data": "{{label_image_data}}",
      "include_packing_slip": true,
      "email_notification": true,
      "affiliated_merchant": "example",
      "order": {
        "order_date": "2020-09-22",
        "order_number": "123456",
        "line_items": [
          {
            "quantity": 2,
            "return_reason": "Custom String reason",
            "sku": "1234SKU"
          },
          {
            "quantity": 1,
            "return_reason": "Return requested",
            "sku": "1235SKU"
          }
        ]
      }
    }
  }
}

Additional Resources