Developers
API referenceBusiness sign in

Schema

WebhookClaimEvent

Body for claim.* events, for claims on your parcels (filed in the Business workspace or with a LIVE key). No description, evidence or contact details.

Fields

WebhookClaimEvent fields
FieldTypeDescription
idRequiredstring (uuid)Stable event ID; deduplicate on it.
typeRequiredenumOne of claim.submitted, claim.under_review, claim.approved, claim.partly_approved, claim.rejected, claim.paid, claim.withdrawn
created_atRequiredstring (date-time)
dataRequiredobject
claimRequiredobject
idRequiredstringClaim IDPattern ^(?:QD-CLM-[A-F0-9]{24}|QDCLM[A-Z0-9]{3,31})$
reasonRequiredClaimReasonLOSS, DAMAGE, MISSING_ITEMS, DELAY (the delivery promise was missed) or WRONG_DELIVERY.
statusRequiredClaimStatusAWAITING_APPROVAL: approved above the threshold and waiting for a second supervisor. PAID: the compensation was sent.
declared_value_minorOptionalinteger
approved_minorOptionalinteger or null
currencyOptionalstring
shipmentRequiredobject
idRequiredstring
tracking_numberRequiredstring
created_atOptionalstring (date-time)

Used by