Form Guide

This guide will explain how to create various Forms for a purchased shipment using the EasyPost API.

There are multiple forms that can be created for a purchased shipment. Some forms will automatically be created, in which case no action is required. However, other forms must be created by request after a shipment has been purchased. In this case, you can input any necessary information in the request parameters.

In the section below, you will find the list of forms you can create, their supported carriers, and the parameters each form accepts.

These forms can be created after the shipment is purchased

FormParametersCarrier
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.)

These forms will be automatically created after a shipment is purchased

FormParametersCarrier
Cod Return LabelN/AFedEx
Commercial InvoiceN/AAll carriers that support international shipments commercial invoice
CN22N/ASelect carriers like USPS. The CN22 form will be included on your postage label when available.
CRN ReportN/AFedEx
High Value ReportN/AUPS (note: UPS automatically creates this based on the shipment)
NAFTA Certificate of OriginN/AFedEx
Order SummaryN/AAustralia Post, Deutsche Post, and FedEx Fuse

Examples of Forms requiring parameters:

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"
              }
          ]
      }
    }
  }
}