Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.orderprotection.com/llms.txt

Use this file to discover all available pages before exploring further.

{
  "id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
  "topic": "claim.approved",
  "created_at": "2024-03-20T10:00:00Z",
  "body": {
    "claim_id": "cm6v2zdt10002j20vqs7f74hc",
    "order_id": "order-1",
    "source_order_id": "100",
    "resolutions": [
      {
        "type": "REFUND",
        "details": {
          "items": [
            {
              "product_id": "prod001",
              "variant_id": "var001",
              "sku": "sku001",
              "item_id": "item001",
              "item_name": "Wireless Mouse",
              "price": 30.0,
              "discount": 5.0,
              "tax": 2.0,
              "resolution_percentage": 80,
              "resolution_flat_amount": null,
              "quantity": 1
            }
          ],
          "currency": "USD",
          "total_refund_amount": 27.6,
          "shipping_amount": 5.0,
          "shipping_amount_tax": 1.0,
      },
      {
        "type": "RESHIP",
        "details": {
          "items": [
            {
              "product_id": "prod002",
              "variant_id": "var002",
              "sku": "sku002",
              "item_id": "item002",
              "item_name": "Wireless Mouse",
              "price": 50.0,
              "discount": 0.0,
              "tax": 5.0,
              "resolution_percentage": 100,
              "resolution_flat_amount": null,
              "quantity": 1,
              "product_options": [
                {
                  "name": "Color",
                  "value": "Red"
                },
                {
                  "name": "Size",
                  "value": "Large"
                }
              ]
            }
          ],
          "currency": "USD",
          "total_refund_amount": 55.0,
          "shipping_amount": 0.0,
          "shipping_amount_tax": 0.0,
          "shipping_address": {
            "address1": "123 Main St",
            "address2": "Apt 4B",
            "city": "San Francisco",
            "state": "California",
            "zip": "94105",
            "country": "United States"
          }
        }
      }
    ]
  }
}
This webhook is triggered when a claim is approved, providing structured data about the resolution actions taken. It includes the type of resolution, along with details on the refunded or credited items, shipping amounts, and total reimbursement. When this webhook is triggered, a JSON payload is sent, containing key details such as the list of resolutions applied. Each resolution object specifies the type of resolution, item details and the final refund or credit amount. When a resolution is of type REFUND, the total_refund_amount amount should be used to refund the order.

​
Request Body

The webhook will send a JSON payload with the following structure:

​
Properties

​
id
string
Unique identifier for the webhook event
​
topic
string
The webhook topic
​
created_at
string
ISO 8601 timestamp of when the webhook was created
​
body
object
The webhook payload