Create ERR Single Coversheet

This API generates a single coversheet for a parcel, with support for Electronic Return Receipt (ERR) and other special services.

SecuritybearerAuth
Request
Request Body schema: application/json
format
string

The file format of the coversheet. Default format is PDF.

Value: "PDF"
size
string

The size of the coversheet. Default size is 10.

Enum: "10" "6X9.5" "6X9" "9.5x12"
type
required
string

The type of the coversheet.

Value: "COVERSHEET"
carrierAccountId
required
string

A unique identifier assigned to the specific carrier account. Its value can be referred from the response of Get Carrier Accounts API.

parcelType
required
string

Type of the parcel, such as Letter or Envelope.

Enum: "LGENV" "PKG" "LTR"
serviceId
required
string

The unique identifier given to the carrier specific service, such as First Class Mail (FCM). It can be referred from response of Get Services API.

required
Array of objects

List of special services applied.

required
object
required
object
required
object
object
Array of objects

Additional metadata that needs to be stored for this shipment can be added here.
Supported values are Cost Account Name, Cost Account Id, Cost Account Code, Account Code and Company Code

object

Contains additional reference fields that can be passed with an ERR request (single piece or batch). While USPS only accepts a single reference, these fields are used for internal tracking, exports, and reporting.

Responses
200

The ERR coversheet has been successfully created.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

post/api/v1/err/coverSheet
Request samples
application/json
{
  • "format": "PDF",
  • "size": "6X9.5",
  • "type": "COVERSHEET",
  • "carrierAccountId": "JPZlE8DldKwx",
  • "parcelType": "LGENV",
  • "serviceId": "FCM",
  • "specialServices": [
    ],
  • "fromAddress": {
    },
  • "parcel": {
    },
  • "toAddress": {
    },
  • "shipmentOptions": {
    },
  • "metadata": [
    ],
  • "shippingReferences": {
    }
}
Response samples
application/json
{
  • "fromAddress": {
    },
  • "toAddress": {
    },
  • "labelLayout": [],
  • "parcel": {
    },
  • "shipmentOptions": {
    },
  • "shipmentId": "670d1820222f6a010ab3152c",
  • "parcelTrackingNumber": "9414809898643517885166",
  • "rate": {
    },
  • "correlationId": "65cc49aa8aeb46c1a77b1fc82a5ecba4"
}