Return Label

The return.label.{action} webhook type is triggered when an event occurs on return label. Return label = the Bag Barcode which is the sticker on Happy Returns poly bags

Actions

  • update If the label on a return changes.

Purpose

Single Scan Returns

For partners using Single Scan Returns, this webhook provides an association between RMAs and Bag Barcodes. If a partner already leverages the outbound_shipment.asn webhook/API, there is no need to additionally consume this webhook, as the data is consistent for both. However, partners that do not require the entire outbound shipment payload but want to know the return/bag association, should use this webhook.

Fields

  • event - String - The event that triggered the webhook. This will be return_label_{action}.
  • retailerID - String - The unique identifier for the retailer in the Happy Returns system.
  • webhookType - String - The exact name of the webhook subscription.
  • labelID - String - The label that appears on all bags associated to the return (Bag Barcode).
  • happyReturnsReturnID - String - The unique identifier for the return transaction.
  • happyReturnsExpressCode - String - The human-friendly identifier for the return transaction.

  • Request (application/json)

    • Headers

        X-Hr-Signature: bab3130e011ba9522d5919bcf9075649b24f9fdfc928b3d2accc99a53aaf3c34

    • Body

        {
      "event": "return_label_update",
      "typeID": "",
      "retailerID": "retailer-id",
      "webhookType": "return.label.update",
      "labelID": "HR2ABCDEFGHI",
      "happyReturnsReturnID": "515764c3-2ff3-11eb-b93e-2a27f3aba64d",
      "happyReturnsExpressCode": "HRVPBGPR"
  }