Refund Request

The refund.requested webhook represents a request from Shipped Suite to your Order Management System to issue a refund to a customer.

❗️
You must handle the webhook to get reimbursed
You must use the RefundRequest API to confirm execution of the refund request. If you do not complete this step, you will not be reimbursed for the refund.

Below is an example of the payload included in this Webhook. The affected_items property holds the items for which a refund is being requested, and the order property holds the information for the order on which to issue the refund. Please create a refund for the affected_items and then confirm the refund request using the RefundRequest API.

{
   "id":2,
   "claim":{
      "note":"",
      "number":"4773257638",
      "reason":"lost",
      "status":"approved",
      "claim_items":[
         {
            "quantity":1,
            "order_item":{
               "sku":"TMASADOSAMPLE",
               "tax":"16.52",
               "discount":null,
               "quantity":1,
               "subtotal":"275.0",
               "unit_price":"275.0",
               "description":"Asado Sampler Box // 12 lb",
               "external_id":"34188136",
               "external_product_id":"640195",
               "external_variant_id":"2109400"
            }
         }
      ],
      "resolved_at":"2022-03-31T16:00:24.146-07:00",
      "resolution_type":"refund",
      "rejection_reason":"",
      "final_resolution_type":"refund"
   },
   "order":{
      "email":"[email protected]",
      "number":"O2163385031",
      "shield":{
         "fee":"2.56",
         "payer_type":"customer"
      },
      "customer":{
         "email":"[email protected]",
         "notes":"",
         "phone":"+18888398218",
         "last_name":"Doe",
         "first_name":"John",
         "external_id":"1",
         "accepts_sms_marketing":false,
         "accepts_email_marketing":true
      },
      "placed_at":"2020-12-23T10:38:46.000-08:00",
      "shipments":[
         {
            "external_id":"8446504",
            "shipment_items":[
               {
                  "quantity":1,
                  "external_id":"10413131",
                  "external_order_item_id":"34188136"
               }
            ]
         }
      ],
      "canceled_at":null,
      "external_id":"20776138",
      "order_items":[
         {
            "sku":"TMASADOSAMPLE",
            "tax":"16.52",
            "discount":null,
            "quantity":1,
            "subtotal":"275.0",
            "unit_price":"275.0",
            "description":"Asado Sampler Box // 12 lb",
            "external_id":"34188136",
            "external_product_id":"640195",
            "external_variant_id":"2109400"
         }
      ],
      "transactions":[
         {
            "amount":"210.77",
            "status":"success",
            "gateway":"stripe",
            "category":"sale",
            "currency":"USD",
            "gateway_id":"ch_0I1cETTgBbZtgJMGP9neO4NP",
            "external_id":"11071198",
            "processed_at":"2020-12-23T10:38:49.000-08:00"
         }
      ],
      "payment_status":null,
      "shipping_address":{
         "zip":"22832",
         "city":"Telluride",
         "phone":"+18888398218",
         "state":"CA",
         "company":null,
         "country":"US",
         "address1":"One Kings Lane",
         "address2":"",
         "last_name":"Doe",
         "first_name":"John"
      },
      "order_adjustments":[
         {
            "tax":"0.0",
            "amount":"-80.75",
            "category":"discount",
            "discount":null,
            "description":"Loyalty Discount",
            "external_id":"77425282"
         }
      ],
      "fulfillment_status":null
   },
   "affected_items":[
      {
         "quantity":1,
         "order_item":{
            "sku":"TMASADOSAMPLE",
            "tax":"16.52",
            "discount":null,
            "quantity":1,
            "subtotal":"275.0",
            "unit_price":"275.0",
            "description":"Asado Sampler Box // 12 lb",
            "external_id":"34188136",
            "external_product_id":"640195",
            "external_variant_id":"2109400"
         }
      }
   ],
   "refundable_type":"Claim"
}

❗️You must handle the webhook to get reimbursed

❗️
You must handle the webhook to get reimbursed