claim.approved

{
  "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",
    "source_order_number": "#1001",
    "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

string

Unique identifier for the webhook event

string

The webhook topic

string

ISO 8601 timestamp of when the webhook was created

object

The webhook payload

Show Webhook Payload

string

Unique identifier for the claim

string

Unique identifier for the order within Order Protection

string

Unique identifier for the order within your system

string

Order number within your system

array

List of resolution actions taken

Show Resolution Object

enum

Type of resolution.Available options: REFUND, RESHIP, FLAT_RATE, STORE_CREDIT

object

Details of the resolution

Show Details Object

array

List of items involved in the resolution

Show Item Object

string

Unique identifier for the product

string

Identifier for the product variant

string

Stock keeping unit

string

Unique identifier for the item

string

Name of the item

number

Original price of the item prior to discounts and taxes

number

Discount amount applied

number

Tax amount

number

Percentage of refund/credit (if applicable)

number

Fixed amount for refund/credit. If FLAT_RATE isn’t the resolution type, this will be null

integer

Number of items

array

Custom options selected for this item, such as size or color.

Show Product Option Object

string

The name of the product option (e.g., “Color”, “Size”)

string

The selected value for the option (e.g., “Red”, “Large”)

string

Currency code

number

Total amount of the refund

number

Amount related to shipping

number

Tax amount related to shipping

object

Shipping address reship should be shipped to.This is only present if the resolution type is RESHIP.

Show Address Object

string

Primary address line

string

Secondary address line (optional)

string

City name

string

State or province

string

Postal or ZIP code

string

Country name

Webhooks

Claims

Message

Protection

Request Body

Properties

​Request Body

​Properties

Request Body

Properties