EasyPost return labels

WPReturns can buy prepaid return labels from your own EasyPost account with your own API key. Buy return label on a request buys the cheapest rate for the customer’s address and emails the label to the customer. Automatic labels buys them on approval instead.

Available in: Pro. You need your own EasyPost account and API key. WPReturns does not resell labels or charge per label.

Caution

The EasyPost integration was written to EasyPost’s documented API. It was not run live against a real account before release because that needs a merchant’s API key.

Uploading your own label file is the tested path. Try EasyPost with a test key first.

Set up EasyPost

1. Sign in to your EasyPost account and copy an API key from easypost.com > Account > API keys. Use the test key to try it out.
2. In WordPress, go to DevDiggers Plugins > WPReturns > Configuration > Shipping Labels.
3. Set Label provider to EasyPost.
4. Paste the key into EasyPost API key.
5. Under Return address and package, fill in Recipient name and Phone. Packages go to your store address from WooCommerce > Settings > General.
6. Set the default box: Default weight (oz), Length (in), Width (in) and Height (in).
7. Select Save Changes.

The screen above shows the tab before setup, with I upload labels myself selected. The EasyPost API key field shows on the tab whichever provider is picked.

To send labels without any clicks, turn on Automatic labels: “Buy and email the label as soon as a request is approved”. If a purchase fails, the request gets an internal note starting “Automatic label failed:”. See Shipping labels settings.

Buy a label for a request

1. Open the request and approve it.
2. In the sidebar under Return shipping, select Buy return label.
3. WPReturns buys one label that covers every item in the request.

The request moves to Awaiting return. The customer gets the Return label ready email and a Download return label button on their request page. The tracking number and carrier fill in on their own.

The sidebar shows the label cost, for example “Label cost: $7.40”. Use Buy a new label if the first one is lost.

Note

The label cost is shown and not deducted from the refund. To charge customers for return shipping, set a return shipping fee on the Resolutions tab.

How the label is bought

Step	Detail
Shipment	WPReturns creates a shipment at api.easypost.com marked as a return (is_return)
Rate	It picks the lowest rate EasyPost returns
Purchase	It buys that rate
Storage	It downloads the label file and stores it in the private uploads folder. Provider links can expire.

Each call times out after 30 seconds. EasyPost errors show on the request screen, for example “EasyPost returned no rates for this address.”

Data sent to EasyPost

EasyPost receives this data only when a label is bought, by hand or on approval.

Data	Source
Customer name, address, phone and email	The order’s shipping address, or billing address when there is no shipping address
Your return address	Store name, address, the return phone and the store email
Package size and weight	The defaults on the Shipping Labels tab

Nothing goes to EasyPost while the provider is set to “I upload labels myself”. Mention EasyPost in your privacy policy if you use it. See the EasyPost terms and privacy policy.

Change the package for some requests

Developers can change the package per request with the ddwcwr_label_parcel filter. Sizes are in inches and weight in ounces. See Hooks.

Related

• Shippo return labels
• Shipping labels settings
• The request screen
• Return labels feature