download_file
Download Walmart Connect reports, labels, and display snapshots by URL, operation ID, or API method and path; writes to a path or caches the uncompressed payload.
Instructions
[Walmart] Download a report, label, or snapshot. Give a full url — such as the details URL from a display snapshot poll, or a Marketplace report url — or an operation_id, or an api with method and path. Written to dest_path when given, otherwise gunzipped and cached. Redirects are followed for you.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| api | No | Api to call when using method+path. Src: platforms. | |
| url | No | Absolute URL to fetch, e.g. a snapshot or report URL returned by a previous call. | |
| path | No | API path when not using url. | |
| method | No | HTTP method when using path. Defaults to GET. | |
| params | No | Query string parameters as a JSON object. | |
| region | Yes | Region label, e.g. us. Src: platforms. | |
| tenant | No | WAP tenant for non-US walmart:ads regions. Sent as wap-tenant-id. | |
| platform | No | Platform to authenticate as. Required with a bare url; otherwise inferred from operation_id or api. Src: platforms. | |
| dest_path | No | Local path to write the bytes to. Omit to gunzip and cache the payload instead, readable at the returned cached_at resource. | |
| environment | Yes | Target environment. walmart:marketplace accepts production or sandbox; the ads platforms accept whatever the config declares, usually production or staging. Src: platforms. | |
| path_params | No | Values for {placeholders} in path. | |
| operation_id | No | Operation id, qualified or bare. Src: operations. | |
| advertiser_id | No | Required on walmart:marketplace (selects the credential) and by display snapshot downloads, where it is sent as X-Advertiser-ID and as the advertiserId query parameter. Src: platforms. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | ||
| urls | No | ||
| error | No | ||
| cached_at | No | ||
| size_bytes | No | ||
| status_code | No | ||
| content_type | No | ||
| bytes_written | No |