Outbound Shipment

The outbound_shipment.asn webhook type is triggered when an outbound shipment from Happy Returns enters a carrier’s system to a retailer. The payload consists of an array of item, where the items are the items being shipped out from a Happy Returns hub to the retailer.

Purpose

For partners who receive bulk shipments from Happy Returns Hubs and want to track bulk shipments from Happy Returns Hub for 1 or more of their retailers.

Fields

Below are the fields in the report of items shipped from a Happy Returns Hub to a warehouse for restock. Each line item in the report is one physical item. NOTE: For some fields, such as the SKU, in order for a value to be populated the information must be passed from the retailer’s ecommerce platform to the Happy Returns system:

• purchasedDate - String - The date the order is created.
• orderNumber - String - A unique identifier for the order as provided by the retailer.
• orderID - String - A unique identifier for the order as provided by the retailer.
• orderLineItemID - String - A unique identifier for each SKU in the order. If an order contains two items of the same SKU, they commonly share the same order line item ID. If the retailer’s ecommerce platform allows multiple items to be represented by the same line item id, we will suffix the line item id with the offset of the current item and then the total refundable quantity. As an example, if the ecommerce platform had a line item id of ‘12345’ and a quantity of two, there would be up to two items in the return, with orderLineItemID’s of 12345-0-2 and 12345-1-2.
• sku - String - A stock keeping unit (SKU) is a unique identifier for a purchasable item in the product catalog.
• upc - String - A universal product code (UPC) is a unique identifier for a purchasable item in the product catalog.
• productVariantID - String - A product variant ID is a unique identifier for a purchasable item in the product catalog.
• labelBarcode - String - The string that is printed as a barcode symbol on the item label. It is commonly the UPC, SKU, or serial number.
• productName - String - Text that describes the product.
• returnReason - String - The reason the customer returned the item.
• returnReasonNote - String - Additional notes about why customer returned item.
• categoryID - String - For retailers who use the return reason by product category feature, the category ID is the identifier used by the retailer to identify the product category.
• refundType - String - The refund type is what the customer is getting for the returned item - a Refund, Site credit, or an Exchange.
• oneClickExchange - String - This field is marked "true" when the customer has chosen a one-click exchange; otherwise it is empty.
• location - String - The name of the location that hosts the Return Bar where the item was dropped off.
• locationMetro - String - The name of the metropolitan area where the Return Bar is located.
• country - String - The country that appears in the shipping address associated to the order.
• startedDate - String - The date the customer starts the return of the item(s).
• approvedDate - String - The date the return of the item is confirmed, and the customer is due their refund or exchange. This field is blank when the item is not yet approved.
• inspectionOutcome -String - The result of the item inspection at a Happy Returns Hub.
• poNumber -String - The Happy Returns PO number for the shipment.
• palletNumber - Number - The Happy Returns pallet tally number that the shipping box is associated to. It is empty for parcel shipments.
• shippingBoxBarcode - String - The Happy Returns shipping box barcode displayed on the label that is affixed to the shipping box.
• shippingBoxKind - String - The Happy Returns shipping box kind.
• tracking - String - The shipment tracking number. It is always set.
• carrier - String - A company that transports shipments from an origin to a destination.
• departureDate - String - The date the carrier records the shipment as being ingested in their system.
• happyReturnsRetailerID - String - The unique identifier for the retailer in the Happy Returns system.
• destinationAddressID - Number - The unique identifier for the destination address.
• happyReturnsExpressCode - String - The unique identifier for the return transaction.
• happyReturnsItemID - String - The unique identifier for the returned item.

• Request (application/json)

  • Headers

      X-Hr-Signature: bab3130e011ba9522d5919bcf9075649b24f9fdfc928b3d2accc99a53aaf3c34
    

  • Body

    {
        "items": [
            {
                  "purchasedDate": "2020-06-18",
                  "orderNumber": "#700249564",
                  "orderID": "2471665434699",
                  "orderLineItemID": "5372677128267",
                  "sku": "AP5520N3R1",
                  "upc": "841206162051",
                  "productVariantID": "31901804298315",
                  "labelBarcode": "841206162051",
                  "productName": "Product name",
                  "returnReason": "Changed mind",
                  "returnReasonNote": "I felt like it was not a good gift",
                  "categoryID": "HR-bags",
                  "refundType": "Refund",
                  "oneClickExchange": "",
                  "location": "Paper Source - Santana Row",
                  "locationMetro": "San Jose",
                  "country": "United States",
                  "startedDate": "2020-06-24",
                  "approvedDate": "2020-06-24",
                  "inspectionOutcome": "Pass",
                  "poNumber": "PO-101172",
                  "palletNumber": 1,
                  "shippingBoxBarcode": "SB-41571",
                  "shippingBoxKind": "all",
                  "tracking": "394711818079",
                  "carrier": "mothership",
                  "departureDate": "2020-07-10",
                  "happyReturnsRetailerID": "hr-plus",
                  "destinationAddressID": 1055,
                  "happyReturnsExpressCode": "ABCDEF",
                  "happyReturnsItemID": "fceb127b-b642-21ea-83bd-0242ac110004"
            },
            {
                  "purchasedDate": "2020-06-07",
                  "orderNumber": "CCEC128171",
                  "orderID": "2480811999306",
                  "orderLineItemID": "5430444228682",
                  "sku": "100103N06W085",
                  "upc": "192882003382",
                  "productVariantID": "31901804298316",
                  "labelBarcode": "192882003382",
                  "productName": "Low Washed Burn Sand Canvas Thread Sneaker",
                  "returnReason": "Too big/wide",
                  "returnReasonNote": "My toes had too much room",
                  "categoryID": "",
                  "refundType": "Exchange",
                  "oneClickExchange": "true",
                  "location": "Cost Plus World Market - Arlington",
                  "locationMetro": "Dallas",
                  "country": "United States",
                  "startedDate": "2020-07-01",
                  "approvedDate": "2020-07-03",
                  "inspectionOutcome": "Pass",
                  "poNumber": "PO-101172",
                  "palletNumber": 1,
                  "shippingBoxBarcode": "SB-40249",
                  "shippingBoxKind": "all",
                  "tracking": "394711818079",
                  "carrier": "mothership",
                  "departureDate": "2020-07-10",
                  "happyReturnsRetailerID": "hr-plus",
                  "destinationAddressID": 1055,
                  "happyReturnsExpressCode": "HVHHJ8",
                  "happyReturnsItemID": "0100c2fe-bbba-11ea-83bc-0242ac110004"
            }
        ]
    }