Push Notifications - Claims Status
Push Notifications (WebHook) is a feature enabled by Amazon Shipping (IN marketplace only) which helps shippers/integrators to automatically receive Claim Status updates for eligible tracking IDs without the need to make any external API calls. Developers, including shippers and integrators, can subscribe to claims push notifications via their webhook URL endpoint.
Steps to Subscribe to Push Notification Feature:
- The shipper/integrator needs to provide their -
- Webhook URL
- Authentication Mechanism
- Shipper Account ID or Shipping Party Account ID (for whom push notifications are being setup)
- Point of contact emails.
- Once these details are shared with the Account Manager they will be able to request webhook subscription setup.
- The Account Manager will internally coordinate configuring and activating the subscription for notifications.
Supported Authentication Mechanisms
One of the following must be enabled by the Shipper/Integrator:
| # | Method | Description | Example |
|---|---|---|---|
| 1 | API Key | A token sent by Amazon in the request headers when delivering claim information to your webhook URL. |
X-API-KEY: abcdef12345 |
| 2 | Query Parameter | A key-value pair passed in the URL. Useful when you want to express a request entirely in a URL. |
https://example.com/webhook?X-Amz-Credential=<your-access-key-id> |
| 3 | Username & Password | A key-value pair passed in the header to authenticate the incoming request via username and password. |
Basic Auth header |
| 4 | OAuth 2.0 | Open Authorization framework. Amazon obtains an access token via OAuth 2.0 Client Credentials flow and presents it when calling your webhook. |
Bearer token in Authorization header |
Push Notifications payload follows this envelope structure with detail and few metadata fields: detail Object
| Name | Description | Schema |
|---|---|---|
| claimId | Unique identifier for a claim. | string |
| eventTime | The exact time at which the push notification event was published. | string (date-time) |
| trackingId | Tracking ID for the shipment container against which the claim has been filed. | TrackingId |
| status | Enum that indicates the current claim state. | Status (enum) |
| statusChangeReason | Enum to identify the reason for the change in claim status. | string (enum) |
| refundAmount | The value refunded and its currency unit. | Currency (value, unit) |
| shippingPartyAccountId | The shipping party account ID for which the claim was filed. | string |
Important: Ensure your webhook parser handles additional fields gracefully. We periodically enhance the payload with new attributes to make notifications more informative — these additions are backward-compatible, but if your parser is strict (e.g., fails on unrecognised fields), it may break when new fields are introduced. A flexible/lenient JSON parser that ignores unknown properties is recommended.
Sample event:
{
"version": "0",
"id": "48af9743-336e-00eb-7194-de9975baa012",
"detail-type": "CLAIM",
"source": "AmazonShipping",
"account": "434519225125",
"time": "2024-02-21T19:33:09Z",
"region": "eu-west-1",
"resources": [],
"detail": {
"shippingPartyAccountId": "A1QUX1G6QEPA2X",
"claimId": "1967234896304",
"eventTime": "2026-08-18T11:26:34Z",
"trackingId": "371601855000",
"status": "REFUND_FILED",
"statusChangeReason": "OTHER",
"refundAmount": {
"value": 550.0,
"unit": "INR"
}
}
}
FAQs
Onboarding & Subscription
1. What is the need for push notifications?
Using push notifications helps shippers to automatically receive claim status updates for eligible shipments as they become available, without calling any API.
2. Who can enable Claims Push Notification feature?
Third-party integrators and directly integrated shippers who use the Shipping V2 API to create shipments with Amazon Shipping can use this feature to receive notifications for claims.
3. What details does the Shipper/Integrator need to provide to enable Push Notifications?
| Detail | Description | Example |
|---|---|---|
| Webhook URL | Your HTTPS endpoint for receiving notifications |
https://tracking.notification.xxx/webhook/amazon-shipping/ |
| Authentication Method | Credentials for one of the 4 supported auth types |
API Key: 93GXXXXXXAhq$XXX |
| Contact Email Address | Technical contact to receive alerts if webhook health is bad |
[email protected] |
| Shipping Account Details | Customer's Shipping Account ID or Name |
Name: NewShipper, SPID: AC123TY7890 |
| Application ID (Optional) | AppId from Solution Provider Portal / Seller Central |
amzn1.sp.solution.xx3gh3fc-xx12-4z74-c2c4-u1234567890r |
4. Are HTTPS webhooks required?
Yes. HTTPS is a mandatory requirement for webhook URLs. Amazon will only accept and configure HTTPS-enabled webhook URLs to ensure secure communication and protect sensitive data during transmission.
5. How long does it take to enable push notifications?
Push Notifications are configured via our technical team. You will receive a response within 5 business days.
6. How can a Shipper/Integrator request a Claims Push Notification subscription?
Push Notifications can only be enabled for orders shipped with Amazon Shipping. As the subscription process is currently manual, please contact your Amazon Account Manager for assistance with enabling the Push Notification feature.
7. What are the possible values for status?
IN_REVIEW, APPROVED, REJECTED, REFUND_FILED, REFUND_COMPLETE, INVALID_CLAIM, PENDING_CUSTOMER_INFO
Troubleshooting
8. My webhook is returning 401 Unauthorized — what's wrong?
Common causes:
- API Key mismatch — Verify the key-value pair matches what was configured during onboarding.
- OAuth token expired — Ensure your OAuth endpoint issues tokens with sufficient TTL.
- Username/Password incorrect — Verify the Basic Auth credentials match your endpoint's configuration.
9. I'm not receiving any events after subscription — what should I check?
- Verify your endpoint is publicly accessible (not behind a VPN or firewall).
- Ensure your endpoint returns HTTP 2xx for POST requests.
- Check that your authentication credentials are valid and accessible.
- Contact your Amazon Account Manager to verify your subscription is active and enabled.
Updated 6 days ago
