Get tax forms
Use Get tax forms to return payout years and the tax forms available for the authenticated partner and specified tenant. The response includes a list of taxForms with formType and a unique formId per year.
How it works
- Call the endpoint with required Walmart headers.
- The API returns a payload containing the partner ID, a
paymentProcessorSummaryarray keyed bypayoutYear, and tax form metadata for each year. - Use the returned
formTypeandformIdto drive downloads or to display availability in your UI.
Endpoint
GET https://marketplace.walmartapis.com/v1/settings/gettaxformprofile
Request sample
curl -X GET "https://marketplace.walmartapis.com/v1/settings/gettaxformprofile" \ -H "WM_SEC.ACCESS_TOKEN: <redacted>" \ -H "WM_QOS.CORRELATION_ID: b3261d2d-028a-4ef7-8602-633c23200af6" \ -H "WM_SVC.NAME: Walmart Marketplace" \ -H "WM.PARTNER_ID: 10011478510" \ -H "WM.TENANT_ID: 0" \ -H "WM_CONSUMER.CHANNEL.TYPE: <your-channel-id>" \ -H "Accept: application/json"
import requests url = "https://marketplace.walmartapis.com/v1/settings/gettaxformprofile" headers = { "WM_SEC.ACCESS_TOKEN": "<redacted>", # Replace with your actual token "WM_QOS.CORRELATION_ID": "b3261d2d-028a-4ef7-8602-633c23200af6", "WM_SVC.NAME": "Walmart Marketplace", "WM.PARTNER_ID": "10011478510", "WM.TENANT_ID": "0", "WM_CONSUMER.CHANNEL.TYPE": "<your-channel-id>", # Replace with your channel ID "Accept": "application/json"
} response = requests.get(url, headers=headers) # Check response
if response.status_code == 200: print("Status Code:", response.status_code) print("Response JSON:", response.json())
else: print(f"Failed with Status Code: {response.status_code}") print("Response Text:", response.text)
``
Modify your code
Use this checklist to adapt the sample so the call returns data.
- Set authentication: Replace with a valid token from the Token API. Use the production scope that matches Marketplace APIs.
- Generate a correlation ID: Create a new GUID for each request and set it in WM_QOS.CORRELATION_ID. Example: d5b8e1a1-7a1e-4c2b-8f75-1d1e0b0e9a90.
- Identify your tenant and partner:
- Set
WM.PARTNER_IDto your Marketplace partner ID. - Set
WM.TENANT_IDto the tenant you want to query, for example us.
- Optional channel tracking: If your integration was assigned a channel type at onboarding, add
WM_CONSUMER.CHANNEL.TYPE: <channel-id>. - Test with your account: Run the call. Expect
paymentProcessorSummary[]items for the years you had payouts. - Pick a form for download: From the response, record one
payoutYear, confirmformTypeis1099-K, and capture theformId. You will pass these to the Download tax form endpoint. - Handle empty data: If you receive
404 partner_data_not_found, verifyWM.PARTNER_IDandWM.TENANT_IDvalues, and confirm the account has payouts for that year.
Response sample
200 OK
{ "payload": { "partnerId": "10011478510", "paymentProcessorSummary": [ { "payoutYear": "2024", "taxForms": [ { "formType": "1099-K", "formId": "484202" } ] } ] }
}
Response schema (key fields)
-
payload.partnerIdstring -
payload.paymentProcessorSummary[]array-
payoutYearstring, four-digit year -
taxForms[]arrayformTypestring, currently1099-KformIdstring, unique identifier used to download
-
Errors and remediation
| HTTP status | Error message | Description | Recommended action |
|---|---|---|---|
| 400 | Missing mandatory input parameters | One or more required headers or parameters were not provided. | Check all required headers, especially authentication and tenant/partner fields, and resend the request. |
| 404 | No record found for the given parameters | No tax form data matches the provided partner or tenant values. | Confirm partner/tenant values and that data exists for the requested period. Prompt the user to choose a different year if applicable. |
| 500 | Internal server error occurred while processing the request | The system encountered an unexpected exception. | Retry with exponential backoff and a fresh WM_QOS.CORRELATION_ID. If persistent, open a support ticket with the correlation ID and inputs (exclude secrets). |
Result
The service returns payout years and payment processors for the partner (from context) and tenant (input), plus a list of report types (for example, 1099-K) with flags/identifiers indicating if each report is available for that year.
Next steps
- Store the
formIdfrom this call and use it with the Download tax form API.
Related links
- Tax Forms API Guide
- Download Tax Form API Reference
Updated about 4 hours ago
