Documentation

Royal Mail Return Label via Sapient

Generates a Royal Mail return label through Sapient (Intersoft) so a customer can post an item back to you. Use it inside return flows when you need to hand the shopper a printable label.

What it does

  • Authenticates with Sapient (Intersoft) using your client credentials.
  • Creates a return shipment from the shipper and recipient addresses you provide.
  • Returns the printable return label as a base64-encoded PDF.

Inputs

NameTypeDescription
Shipping Account IdStringShipping Account Id from intersoft
Shipper Address Line 1StringShipper address line 1
Shipper TownStringShipper town
Shipper contact NameStringShipper Name
Shipper country codeStringShipper country code
Shipper Address Line 2StringShipper address line 2
Shipper Post CodeStringShipper zip code
Recipient Company NameStringRecipient Company Name
Recipient address line 1StringRecipient address addresss line 1
Recipient address line 2StringRecipient address addresss line 3
Recipient address line 3StringRecipient address addresss line 3
Recipient Post CodeStringRecipient post code
Recipient townStringRecipient city/town)
Recipient Country CodeStringRecipient coutry code
Order NumberStringCustomer Order Number used as shipping reference
Sapient Client IdString (sensitive)Sapient Client Id
Sapient Client SecretString (sensitive)Sapient Client Secret

Outputs

NameTypeDescription
SuccessBooleanWhether the label was succesfully created
Return LabelStringThe return label in base64

Notes

  • The label is returned as base64-encoded PDF content, so decode or attach it before showing it to the customer.
  • The action uses the Royal Mail returns service via Sapient/Intersoft, so you need valid Sapient client credentials.

API reference