Documentation

Paazl Create Return Label

Creates a return shipping label in Paazl for a given order and carrier service. Use it in returns flows to generate a label the customer can use to send items back.

What it does

  • Creates a Paazl shipping label for the order and carrier service you specify.
  • Returns the label itself as a base64-encoded PDF.
  • Provides the tracking number and barcode for the newly created label.
  • Reports whether the label was created through the Success flag.

Inputs

NameTypeDescription
Web ShopStringWeb Shop code
Order ReferenceStringOrder number -1
ServiceStringCarrier service code
PasswordStringPaazl password

Outputs

NameTypeDescription
SuccessBooleanWether the shipping label was created
LabelStringShipping label PDF file encoded in base64
Tracking NumberStringTracking number for newly created label
BarcodeStringBarcode for newly created label

Notes

  • The Label output is a base64-encoded PDF; decode it to produce the printable return label.
  • Service is the carrier service code that determines which carrier and service the return label is created for.

API reference