Replacement Request

The replacement.requested webhook represents a request from Shipped Suite to your Order Management System to create a replacement order for a customer.

❗️
You must handle the webhook to get reimbursed
You must use the ReplacementRequest API to confirm creation of the replacement order. If you do not complete this step, you will not be reimbursed for the replacement order.

Below is an example of the payload included in this Webhook. The affected_itemsproperty holds the items for which a replacement is being requested. Please create a replacement order for the affected_items and then confirm the replacement request using the ReplacementRequest API.

{
   "id":1,
   "claim":{
      "note":"",
      "number":"2611027400",
      "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-30T17:26:22.964-07:00",
      "resolution_type":"replacement",
      "rejection_reason":null,
      "final_resolution_type":"replacement"
   },
   "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"
         }
      }
   ],
   "replaceable_type":"Claim"
}

❗️You must handle the webhook to get reimbursed

❗️
You must handle the webhook to get reimbursed