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.
Form | Parameters | Carrier |
---|---|---|
Label QR Code | Form | USPS. See Label Broker Guide |
Return Packing Slip | Return packing slip parameters | All carriers |
RMA QR Code | RMA QR Code parameters | Fedex (Note: This requires account provisioning. Please contact support to use this feature.) |
Form | Parameters | Carrier |
---|---|---|
Cod Return Label | N/A | FedEx |
Commercial Invoice | N/A | All carriers that support international shipments commercial invoice |
CN22 | N/A | Select carriers like USPS. The CN22 form will be included on your postage label when available. |
CRN Report | N/A | FedEx |
High Value Report | N/A | UPS (note: UPS automatically creates this based on the shipment) |
NAFTA Certificate of Origin | N/A | FedEx |
Order Summary | N/A | Australia Post, Deutsche Post, and FedEx Fuse |
{
"form": {
"type": "label_qr_code"
}
}
{
"form": {
"type": "return_packing_slip",
"barcode": "RMA12345678900",
"line_items": [
{
"product": {
"title": "Square Reader",
"barcode": "123456789"
},
"units": 8
}
]
}
}
{
"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"
}
]
}
}
}
}