About service endorsements

Ancillary service endorsements are a USPS feature that allows the sender to obtain a shipment addressee's new (forwarding) address, if the addressee has filed a Change of Address order with USPS, for packages that are undeliverable as addressed. Additional carrier fees may apply.

This feature is currently supported for carriers DHL eCommerce, FedEx (REST, not SOAP), FirstMile, and UPS.

Include a service endorsement in your API call

If you'd like to request an optional service endorsement, you'll include the optional endorsement type you're requesting in your calls to Shipium's APIs. A return address is required on the package when using ancillary service endorsements.

The following is a snippet of a JSON request call to Shipium's APIs. The field required for requesting a service endorsement is included in the sample request and is defined in the table below. This field is included in the shipmentParameters or multiParcelShipmentParameters of the call. Only one service endorsement may be included per shipment.

{
  ...
"shipmentParameters": {
    ...
   "endorsementType": "AddressServiceRequested"
  ...
  }
}

Field	Required / Optional	Type	Description
`shipmentParameters .endorsementType`	Required	String enumeration Values are: `AddressServiceRequested` (forwarding and return; new separate address notification provided) `ForwardingServiceRequested` (forwarding and return; new address notification provided only with return) `ChangeServiceRequested` (no forwarding or return; new address notification provided) `ReturnServiceRequested` (no forwarding, only return; new address notification provided) `CarrierLeaveIfNoResponse` (instructs carriers to leave a parcel at the delivery address if no one is available to accept it, without requiring a signature)	The ancillary service endorsement type you want to request

Field

Required / Optional

Type

Description

shipmentParameters
  .endorsementType

Required

String enumeration
Values are:

AddressServiceRequested (forwarding and return; new separate address notification provided)
ForwardingServiceRequested (forwarding and return; new address notification provided only with return)
ChangeServiceRequested (no forwarding or return; new address notification provided)
ReturnServiceRequested (no forwarding, only return; new address notification provided)
CarrierLeaveIfNoResponse (instructs carriers to leave a parcel at the delivery address if no one is available to accept it, without requiring a signature)

The ancillary service endorsement type you want to request

Endorsements supported by carrier

Endorsement	Carriers Supporting Endorsement
`AddressServiceRequested`	DHL eCommerce, FedEx, FirstMile, UPS
`ForwardingServiceRequested`	DHL eCommerce, FedEx, FirstMile, UPS
`ChangeServiceRequested`	DHL eCommerce, FedEx, FirstMile, UPS
`ReturnServiceRequested`	DHL eCommerce, FedEx, FirstMile, UPS
`CarrierLeaveIfNoResponse`	FedEx

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful: