Download claim documents

Call this endpoint to download one or more supporting documents for a shipment-protection claim. Use this endpoint to retrieve a ZIP file containing the documents you’ve previously uploaded.

Note: This page describes an example using only the required parameters and inputs for downloading claim documents. For a full list of customization options and additional capabilities, refer to the Shipment Protection API reference.

Endpoint

POST https://marketplace.walmartapis.com/v3/claims/shipment-protection/claim/{claimNumber}/documents

Sample request

Replace {claimNumber} with the claim number you want to retrieve documents for.

curl -X POST "https://marketplace.walmartapis.com/v3/claims/shipment-protection/claim/1000004/documents" \ -H "Authorization: Basic <Base64EncodedConsumerKey:ConsumerSecret>" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM_QOS.CORRELATION_ID: 1234567890" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "documentIds": [ "8963F684F4400000D47C1AE5", "896C4BF9E180000086B5363F" ] }'

import requests url = "https://marketplace.walmartapis.com/v3/claims/shipment-protection/claim/1000004/documents"
payload = { "documentIds": [ "8963F684F4400000D47C1AE5", "896C4BF9E180000086B5363F" ]
}
headers = { "Authorization": "Basic <Base64EncodedConsumerKey:ConsumerSecret>", "WM_SVC.NAME": "Walmart Marketplace", "WM_QOS.CORRELATION_ID": "1234567890", "Accept": "application/json", "Content-Type": "application/json"
} response = requests.post(url, json=payload, headers=headers)
# The response will be a binary ZIP file
with open("claim_documents.zip", "wb") as f: f.write(response.content)
print("Downloaded ZIP:", "claim_documents.zip")

Modify your code

Replace 1000004 in the URL with your actual claimNumber.
Update the "documentIds" array with the IDs of the documents you want to download.
Insert your Base64-encoded credentials in the Authorization header.
Use your own unique WM_QOS.CORRELATION_ID for tracing.

Sample response

A successful response returns HTTP status 200 OK and a binary ZIP file containing the requested documents. Your client should save the response body as a .zip file.

Next steps

To attach new documents when requested, see the Submit additional information guide.
To inspect the full lifecycle of a claim, see the Get claim history guide.
To retrieve summary details for a claim, see the Get claim details guide.
To file a new claim, see the Submit a claim guide.

Updated about 7 hours ago