claim.created
{
"id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
"topic": "claim.created",
"created_at": "2024-03-20T10:00:00Z",
"body": {
"claim_id": "cm6v2zdt10002j20vqs7f74hc",
"order_id": "order-1",
"source_order_id": "100",
"created_at": "2024-03-20T10:00:00Z",
"claim_description": "Item arrived damaged",
"claim_type": "DAMAGED",
"claim_state": "NEW",
"items": [
{
"product_id": "prod001",
"variant_id": "var001",
"sku": "SKU123",
"item_id": "item001",
"item_name": "Wireless Mouse",
"quantity": 1
}
]
}
}
{
"id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
"topic": "claim.created",
"created_at": "2024-03-20T10:00:00Z",
"body": {
"claim_id": "cm6v2zdt10002j20vqs7f74hc",
"order_id": "order-1",
"source_order_id": "100",
"created_at": "2024-03-20T10:00:00Z",
"claim_description": "Item arrived damaged",
"claim_type": "DAMAGED",
"claim_state": "NEW",
"items": [
{
"product_id": "prod001",
"variant_id": "var001",
"sku": "SKU123",
"item_id": "item001",
"item_name": "Wireless Mouse",
"quantity": 1
}
]
}
}
This webhook is triggered when a new claim is created.
Request Body
The webhook will send a JSON payload with the following structure:
Properties
Unique identifier for the webhook event
The webhook topic
ISO 8601 timestamp of when the webhook was created
The webhook payload
Unique identifier for the claim
Unique identifier for the order within Order Protection
Unique identifier for the order within your system
ISO 8601 timestamp of when the claim was created
Description of the claim provided by the customer
Type of claim
Available options: DAMAGED, DEFECTIVE_ITEM, MISSING_ITEM, MULTIPLE, ORDER_DELIVERED_NOT_RECEIVED, RETURNED_TO_SENDER, STOLEN, WRONG_ITEM
Current state of the claim
Available options: APPROVED, ARCHIVED, CLOSED, COMMUNICATING, DENIED, DISMISSED, NEW, OPEN, RESOLVED, RESOLVED_BY_BRAND, TEMPORARILY_DISMISSED, WAITING_FOR_BRAND, WAITING_FOR_CUSTOMER, WAITING_FOR_OP
{
"id": "aa58a883-1e6f-4ec1-aa06-556908167f46",
"topic": "claim.created",
"created_at": "2024-03-20T10:00:00Z",
"body": {
"claim_id": "cm6v2zdt10002j20vqs7f74hc",
"order_id": "order-1",
"source_order_id": "100",
"created_at": "2024-03-20T10:00:00Z",
"claim_description": "Item arrived damaged",
"claim_type": "DAMAGED",
"claim_state": "NEW",
"items": [
{
"product_id": "prod001",
"variant_id": "var001",
"sku": "SKU123",
"item_id": "item001",
"item_name": "Wireless Mouse",
"quantity": 1
}
]
}
}