List all claims

Call this endpoint to retrieve a paginated list of shipment-protection claims for your account. Filter by claim group, status, type, purchase order, tracking number, or date so you can drive dashboards, alerts, and reports.

Note: This example uses only the most common query parameters. For the full list of filters and sorting options, see the Shipment Protection API reference.

Endpoint

GET https://marketplace.walmartapis.com/v3/claims/shipment-protection

Sample request

curl -X GET "https://marketplace.walmartapis.com/v3/claims/shipment-protection \ ?limit=5&offset=0&claimsGroup=OPEN&sortBy=claimDate&sortOrder=DESC" \ -H "Authorization: Basic <Base64EncodedConsumerKey:ConsumerSecret>" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_QOS.CORRELATION_ID: 1234567890" \ -H "Accept: application/json"

import requests url = "https://marketplace.walmartapis.com/v3/claims/shipment-protection" params = { "limit": 5, "offset": 0, "claimsGroup": "OPEN", "sortBy": "claimDate", "sortOrder": "DESC"
} headers = { "Authorization": "Basic <Base64EncodedConsumerKey:ConsumerSecret>", "WM_SVC.NAME": "Walmart Marketplace", "WM_QOS.CORRELATION_ID": "1234567890", "Accept": "application/json"
} response = requests.get(url, headers=headers, params=params)
print("Status code:", response.status_code)
print("Response JSON:", response.json())

Request parameters

Parameter	Type	Default	Description
`limit`	Integer	25 (max 300)	Number of claims to return.
`offset`	Integer	0	Results offset for pagination.
`claimsGroup`	Enum	—	`OPEN`, `ACTION_NEEDED`, or `CLOSED`.
`claimNumber`	String	—	Retrieve a single claim by number.
`purchaseOrderId`	String	—	Filter by purchase-order ID.
`trackingNo`	String	—	Filter by carrier tracking number.
`claimTypes`	CSV	—	Comma-separated list of `LIT`, `LAD`, `DAMAGED`.
`claimStatuses`	CSV	—	Filter by status such as `IN_REVIEW`, `APPROVED`.
`sortBy`	String	—	Field to sort by (`claimDate`, etc.).
`sortOrder`	Enum	—	`ASC` or `DESC`.

Modify your code

Adjust limit and offset to page through results.
Combine filters such as claimTypes=LIT,LAD and claimStatuses=NEED_INFO to return only the claims you need.
Insert your Base64-encoded credentials in the Authorization header.
Use a unique WM_QOS.CORRELATION_ID for your request tracking.

Sample response

{ "data": { "claims": [ { "claimNumber": "5778778", "claimDate": "2024-12-23 12:00", "claimType": "LIT", "purchaseOrderId": "123435944395390", "customerName": "Ajay", "claimAmount": { "amount": 4.3, "currency": "USD" }, "trackingNo": "1676033785260", "status": "APPROVED" }, { "claimNumber": "4236778", "claimDate": "2024-12-23 12:00", "claimType": "LIT", "purchaseOrderId": "123435944395390", "partnerId": "10900015773", "customerId": "40035678934512", "claimAmount": { "amount": 84.5, "currency": "USD" }, "trackingNo": "1676033785260", "status": "ACTION_NEEDED" } ], "totalPages": 1, "currentPage": 0, "totalElements": 12 }
}

Result

If successful, the API returns an HTTP 200 OK status with an array of claims plus pagination metadata (totalPages, currentPage, totalElements). Empty arrays indicate no matches for your filters.

Next steps

Show claim details: Call GET /claim/{claimNumber} to display header, order, and payment information for an individual claim.
View the audit trail: Call GET /claim/{claimNumber}/history to review status changes and agent notes.
Provide more information: If any claim in your list has status NEED_INFO, respond with PATCH /claim/{claimNumber} to upload documents or notes.
Download supporting files: Use POST /claim/{claimNumber}/documents to retrieve documents for archiving or charge-back reconciliation.

Updated about 1 month ago