Request a cancellation report
Use this report to analyze and reduce order cancellations. It lists cancelled order lines with reasons, dates, and identifiers so you can spot patterns by SKU, region, carrier, or time period.
Endpoint
POST https://marketplace.walmartapis.com/v3/reports/reportRequests?reportType=CANCELLATION&reportVersion=v1
The request body is optional. When the request is accepted, the API returns a requestId you can use to track status and download the file.
Sample request
POST https://marketplace.walmartapis.com/v3/reports/reportRequests?reportType=CANCELLATION&reportVersion=v1
Authorization: Bearer <access_token>
WM_QOS.CORRELATION_ID: <guid>
WM_SVC.NAME: Walmart Marketplace
Accept: application/json
Content-Type: application/json {}
Sample request with filters
Cancellation reports support row filters. Use them to scope the file to a date window, specific reasons, or regions.
POST https://marketplace.walmartapis.com/v3/reports/reportRequests?reportType=CANCELLATION&reportVersion=v1
Authorization: Bearer <access_token>
WM_QOS.CORRELATION_ID: <guid>
WM_SVC.NAME: Walmart Marketplace
Accept: application/json
Content-Type: application/json { "format": "CSV", "rowFilters": { "cancelDate": { "from": "2025-11-01", "to": "2025-11-30" }, "cancelReason": [ "SELLER_CANCEL_OUT_OF_STOCK", "CUSTOMER_REQUESTED_SELLER_TO_CANCEL" ], "destinationState": ["CA", "TX"] }
}
cURL
curl -X POST 'https://marketplace.walmartapis.com/v3/reports/reportRequests?reportType=CANCELLATION&reportVersion=v1' -H 'Authorization: Bearer <access_token>' -H 'WM_QOS.CORRELATION_ID: <guid>' -H 'WM_SVC.NAME: Walmart Marketplace' -H 'Accept: application/json' -H 'Content-Type: application/json' -d '{ "format": "CSV", "rowFilters": { "cancelDate": { "from": "2025-11-01", "to": "2025-11-30" }, "cancelReason": ["SELLER_CANCEL_OUT_OF_STOCK"], "destinationState": ["CA"] } }'
Use a new GUID for each call. Keep the
requestIdto track status and download the report.
Track and download
-
Check status until the report is ready.
GET https://marketplace.walmartapis.com/v3/reports/reportRequests/{requestId}Status values:
RECEIVED,INPROGRESS,READY,ERROR. -
Download once status is
READY.GET https://marketplace.walmartapis.com/v3/reports/downloadReport?requestId={requestId}
If you prefer not to poll, subscribe to Report status notifications and receive a callback when the file is ready.
Filters
Filters are optional. When present, include them as rowFilters in the JSON body. Supported filter types for this report:
- Range filter for date/time or numbers, for example
cancelDate. - Enum filter for enumerated fields.
- Multi-value filter for exact match on strings, for example
cancelReasonordestinationState.
See Use report filters for rules and patterns that apply across reports.
CSV fields
The file contains one row per cancelled order line. The table lists CSV headers exactly as they appear so parsers can match them 1:1.
| Header | Description | Origin |
|---|---|---|
actualDeliveryDate | The date the item was delivered. | Walmart |
cancelDate | The date the item was canceled. | Seller |
cancelReason | The reason the item was canceled. | Walmart/Seller |
carrier | The shipping carrier used to deliver the order. | Seller |
catlgItemId | The unique identifier for the item. | Walmart |
defectType | The defect type. For this report, the value is Cancel. | Walmart/Seller |
destinationState | The two‑letter state code for the shipping address. | Walmart |
estimatedDeliveryDate | The estimated delivery date of the order. | Walmart/Seller |
legacySlrId | The unique identifier for the seller. | Walmart |
offerConditionCode | The item condition code (see table below). | - |
offerId | A unique identifier that combines the SKU and partner ID. | Walmart |
orderPlacedDt | The date the order was placed. | Walmart |
poNum | The purchase order number representing Walmart placing the order with the seller. | Walmart |
returnDate | The date the return request was placed. | Walmart |
returnReason | The reason for the return. | Walmart |
salesOrder | The unique customer order number assigned by Walmart. | Walmart |
trackingNum | The tracking number associated with the order. | Seller |
Item conditions and codes
| Item condition | Code |
|---|---|
| New | 1 |
| New without box | 2 |
| New without tags | 3 |
| Restored: Premium | 4 |
| Restored: Like New | 5 |
| Restored: Good | 6 |
| Restored: Fair | 7 |
| Remanufactured | 8 |
| Open Box | 9 |
| Pre‑Owned: Like New | 10 |
| Pre‑Owned: Good | 11 |
| Pre‑Owned: Fair | 12 |
| New with defects | 13 |
Error handling
Common failures when requesting or downloading reports:
| HTTP | Code (example) | When it happens | How to fix |
|---|---|---|---|
| 400 | MISSING_REQUEST_PARAM | Required parameter missing (for example, reportType). | Add the missing parameter and retry. |
| 400 | INVALID_REQUEST | Unsupported reportType or invalid filter shape. | Check reportType, reportVersion, and filter format. |
| 401 | UNAUTHORIZED | Invalid or missing OAuth token. | Refresh your token and retry. |
| 404 | CONTENT_NOT_FOUND | Unknown or expired requestId. | Verify the requestId and retention. |
| 429 | RATE_LIMIT_EXCEEDED | Too many requests. | Back off and retry with jitter. |
| 500 | INTERNAL_ERROR | Unexpected error. | Retry GET calls; contact support. |
See also
Updated 1 day ago
