Shipment Protection API overview
Use the Walmart Marketplace Shipment Protection API to manage claims for Ship with Walmart (SWW) labels that are lost in transit, lost after delivery, or damaged. Walmart sellers and approved Solution Providers can:
- Submit a new shipment-protection claim.
- Retrieve claim status, history, and payout details.
- Provide additional documents or notes when Walmart requests more information.
- Download claim documents for auditing and reconciliation.
How it works
Overall seller journey
In a typical Marketplace flow, a seller or approved Solution Provider might complete the following steps:
- Item setup: Create or register SKUs with Walmart by using the Item Management API.
- Shipping: Buy SWW labels by calling the Buy Shipping API.
- Shipment protection (this guide): File and track claims with the Shipment Protection API when shipments are lost or damaged.
- Order management: Confirm orders, shipments, and cancellations by using the Orders API.
Shipment protection flow
After a shipment problem occurs, you can complete the following actions:
Scenario | View | Create or update |
---|---|---|
File a new claim | — | POST /v3/claims/shipment-protection/claim |
Track all open claims | GET /v3/claims/shipment-protection?claimsGroup=OPEN | — |
Get one claim by claim number | GET /v3/claims/shipment-protection/claim/{claimNumber} | — |
See claim history and notes | GET /v3/claims/shipment-protection/claim/{claimNumber}/history | — |
Respond to a Walmart request for documents or notes | — | PATCH /v3/claims/shipment-protection/claim/{claimNumber} |
Download one or more uploaded documents | POST /v3/claims/shipment-protection/claim/{claimNumber}/documents | — |
Reference guide
This guide explains how to use the Shipment Protection API, providing practical examples and step-by-step instructions for integrating claims management into your application.
For full technical details, including endpoints, parameters, and brief descriptions, refer to the Shipment Protection API reference guide.
Prerequisites
Complete the following before you integrate the Shipment Protection API:
- Follow the steps in the Getting started guide:
- If you are a seller, see the Marketplace getting started guide for sellers.
- If you are an approved Solution Provider, see the Marketplace getting started guide for solution providers.
- Enable OAuth 2.0 authentication. Ensure you have obtained the required credentials and tokens. For details, see OAuth 2.0 authorization.
- Buy shipping labels through the Buy Shipping API. Only shipments created with SWW labels are covered by automatic protection.
Commonly used terms
Term | Description |
---|---|
Claim | A formal request for reimbursement submitted through the Shipment Protection API. |
Claim type | One of three categories: lost in transit (LIT), lost after delivery (LAD), or damaged. |
Claim status | The current state of a claim such as INITIATED , IN_REVIEW , NEED_INFO , APPROVED , or REJECTED . |
Claim document | A file, such as an invoice or picture proof of delivery, that supports a claim. |
Market availability
The Shipment Protection API is available for sellers listing on Walmart marketplaces in the U.S. marketplace.
Next steps
Read Choose a Shipment Protection API to decide which endpoints best fit your workflow.
See also
- Learn how to create event notifications to receive alerts when claim statuses change.
- Review best practices for purchasing SWW labels to reduce the risk of shipment issues.
Updated about 2 months ago