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 requestId to track status and download the report.

Track and download

  1. Check status until the report is ready.

    GET https://marketplace.walmartapis.com/v3/reports/reportRequests/{requestId}
    

    Status values: RECEIVED, INPROGRESS, READY, ERROR.

  2. 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 cancelReason or destinationState.

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.

HeaderDescriptionOrigin
actualDeliveryDateThe date the item was delivered.Walmart
cancelDateThe date the item was canceled.Seller
cancelReasonThe reason the item was canceled.Walmart/Seller
carrierThe shipping carrier used to deliver the order.Seller
catlgItemIdThe unique identifier for the item.Walmart
defectTypeThe defect type. For this report, the value is Cancel.Walmart/Seller
destinationStateThe two‑letter state code for the shipping address.Walmart
estimatedDeliveryDateThe estimated delivery date of the order.Walmart/Seller
legacySlrIdThe unique identifier for the seller.Walmart
offerConditionCodeThe item condition code (see table below).-
offerIdA unique identifier that combines the SKU and partner ID.Walmart
orderPlacedDtThe date the order was placed.Walmart
poNumThe purchase order number representing Walmart placing the order with the seller.Walmart
returnDateThe date the return request was placed.Walmart
returnReasonThe reason for the return.Walmart
salesOrderThe unique customer order number assigned by Walmart.Walmart
trackingNumThe tracking number associated with the order.Seller

Item conditions and codes

Item conditionCode
New1
New without box2
New without tags3
Restored: Premium4
Restored: Like New5
Restored: Good6
Restored: Fair7
Remanufactured8
Open Box9
Pre‑Owned: Like New10
Pre‑Owned: Good11
Pre‑Owned: Fair12
New with defects13

Error handling

Common failures when requesting or downloading reports:

HTTPCode (example)When it happensHow to fix
400MISSING_REQUEST_PARAMRequired parameter missing (for example, reportType).Add the missing parameter and retry.
400INVALID_REQUESTUnsupported reportType or invalid filter shape.Check reportType, reportVersion, and filter format.
401UNAUTHORIZEDInvalid or missing OAuth token.Refresh your token and retry.
404CONTENT_NOT_FOUNDUnknown or expired requestId.Verify the requestId and retention.
429RATE_LIMIT_EXCEEDEDToo many requests.Back off and retry with jitter.
500INTERNAL_ERRORUnexpected error.Retry GET calls; contact support.

See also