Walmart APIs

The Walmart APIs SDK for TypeScript provides typed access to the Walmart APIs REST APIs from Node.js and the browser.

[!TIP] Looking for a specific signature, request field, model, enum or error type? This SDK ships a generated, machine-readable SDK map — a lookup index of the whole TypeScript surface. Consult it before grepping or scanning the source tree; it answers most contract questions directly and, where a source file is genuinely needed, names the exact one to open. Details under SDK map.

The Walmart Marketplace APIs use OAuth for token-based authentication and authorization. We also introduced OAuth 2.0 for solution providers to enable new authorizations using authorization code grant type. Sellers can now connect with solution provider apps seamlessly through this new Walmart's OAuth 2.0 user experience. Refer to the Guide section for comprehensive instructions. Existing seller connections using the previous authorization method will remain operational., The Advertising API provides comprehensive advertising solutions for Walmart sellers, including:

Search Engine Marketing (SEM)

Search Engine Marketing allows you to promote your listings through Google Shopping Ads and reach customers who are searching on Google for products like yours.

Walmart Seller Affiliate Program (WSR)

The Attribution Reports API provides sellers with detailed performance analytics and item-level metrics for their affiliate marketing campaigns. This API enables sellers to track campaign effectiveness, monitor click-through rates, conversions, and revenue attribution across different campaign hierarchies.Market availability: US only

Authentication

All API requests require authentication using Walmart's standard OAuth 2.0 authentication. Include the following headers with each request:

• WM_SEC.ACCESS_TOKEN: Your access token
• WM_CONSUMER.CHANNEL.TYPE: Consumer Channel Type received during onboarding
• WM_SVC.NAME: Walmart Service Name
• WM_QOS.CORRELATION_ID: Unique request correlation ID

Rate Limits

• 10 requests per second per seller
• 1000 requests per hour per seller

Data Freshness

Performance data is updated daily. Data for the current day may be incomplete., Assortment recommendations help sellers understand customer demand in Walmart and the external market by providing personalized item recommendations. These insights are generated by leveraging demand signals like:

• Internal and external search
• Best Sellers
• Trending items

The assortment recommendations API can be used to view customer favorites (In-demand items), demand trends, filter, reject, and bulk download the recommendations. These recommended items can be set up using the Item Setup API. Sellers need to provide API access key on developer portal for ‘Analytics & Growth’ to solution providers and channel partners to be able to access Assortment Growth APIs., Endpoints for creating and tracking Ship with Walmart (SWW) shipment-protection claims., The Dispute Management APIs allows you to raise a dispute and check the status of an item under dispute.

Throttling: These APIs are limited to an aggregated total of 10 transactions per minute (TPM) per seller., Feeds are constructed to handle bulk functions. A feed consists of an HTTP request with an attached file. Once you upload the Feeds, you can use the Feed ID to track the status of the feeds and the status of the item within those Feeds., The Insights Management API provides sellers with actionable information to optimize their listings:

• Sellers can locate best-selling items with Trending Items API so they can add those to their catalog of item offerings.

• Sellers can find out reasons why items go unpublished, fix the issue and republish those items.

• Sellers can use Listing Quality APIs to gather listing quality metrics about their items and find out any post-production issues that they can fix.

• Sellers can obtain their overall Listing Quality score, and locate any categories that show items with listing quality issues., Maintaining up-to-date inventory for your items on Walmart.com ensures a great experience for your customers and greater sales opportunities for you., This API allows the retrieval of Lag Time for an item with a given SKU., Notifications Management API, The On Request Reports API allows you to request reports immediately about your items for faster retrieval. You can request the report, check status on the report availability, and then download the report URL when report is ready. You can also get a list of all reports requested., These APIs are specifically designed for payment use cases within the Walmart Marketplace., The price is a fundamental building block for your listing on Walmart.com. You can use the price management APIs to set up and manage the price for a given item, Sellers can set regular or promotional prices for their items. Setting the Promotional prices is an option to create unique pricing for events such as clearance sales or to call out a comparison price, APIs for providing recommendations to sellers., Please transition ASAP to using onRequest Reports (https://developer.walmart.com/doc/us/us-mp/us-mp-onrequestreports/). On July 29th, all PreGenerated reports other than recon report will be retired and only available onRequest. The Pregenerated Reports API allows you to obtain any pregenerated report that you need, including: item, item performance, buy box, CAP, promotions, reconciliation, return item override, shipping program and shipping configuration., The Reviews Acceleration API provides sellers with capability to view and enroll items into review accelerator programs:

• Sellers can view their eligible product catalog that can be enrolled into Review Accelerator program(RAP) using Get RAP post-purchase items API

• Sellers can view their currently enrolled products using Get RAP post-purchase items API

• Sellers can leverage Get RAP post-purchase items API to get all products that have attained target reviews after enrolment into the program

• Sellers can filter the products on the basis of category and price. They can also sort based on item priority and search using product name and SKU

• Sellers can enroll a product/multiple products into the program using update item status API, Use the rich media management APIs to upload, link, delink, and manage 360-spin images and videos for Walmart Marketplace items. After registration, use your consumer ID and private key to authenticate and begin integration., SEO recommendations powered by Walmart AI-LLM model to optimize SEO traffic. This will help sellers enhance their product listings with keywords suggestions, improved content, optimized meta descriptions, and actionable insights, driving more organic traffic and increasing visibility and sales., The Ship With Walmart (SWW) APIs enables walmart.com sellers to buy shipping at competitively discounted rates directly from Walmart to ship their goods to US customers., The Simplified Shipping Settings APIs allows sellers to manage all the simplified shipping configuration for better shipping and delivery promise experience, API for bulk enrollment/unenrollment of items in Walmart Plus program

Installation

To add the SDK to your project from npm:

npm install apimatic-wm-v4-sdk

To install from the SDK source instead, compile it to dist/ — run its build script once in the SDK folder — then add it to your project by path:

npm install <path-to-sdk>

Quick Start

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { ServerEnvironment, WalmartApIsClient } from "apimatic-wm-v4-sdk";

const client = new WalmartApIsClient({
  serverEnvironment: ServerEnvironment.Production,
  basicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
  bearerAuth: "YOUR_BEARER_TOKEN",
  accessToken: "YOUR_API_KEY",
});

Nothing in ClientOptions is required — new WalmartApIsClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJS

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("apimatic-wm-v4-sdk");

const client = new sdk.WalmartApIsClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  basicAuth: { username: "YOUR_USERNAME", password: "YOUR_PASSWORD" },
  bearerAuth: "YOUR_BEARER_TOKEN",
  accessToken: "YOUR_API_KEY",
});

Usage

For code examples and error responses, see API Reference.

SDK map

This SDK ships a generated SDK map — sdk-map.md plus the pages under map/operations/ — a deterministic, lookup-oriented table of contents of the TypeScript surface, generated alongside the SDK.

Read it before scanning the source. Whether you are an AI coding assistant or searching by hand, the map answers "what is the exact …" by lookup for every call-level contract, and for anything it does not carry it names the one file that does:

• sdk-map.md — the index: client construction, the one error family, the non-throwing .asApiResult() form, servers, environments and auth, the model locator, the runtime facts, and the SDK-wide defaults every operation relies on.
• map/operations/ — one page per resource: the exact signature and return type, the verb and route, the request body and its media type, a Fields table giving every request field its channel, and a Type sources table naming the file and schema value of every type the operation mentions.

Model shapes — object properties with their wire names, enum member names and wire values, union variants — are not duplicated in the map, and not in the API reference either. Both name the type and the file to read; take the pair from the operation's Type sources table and read the declaring file. That file is the single source of truth and cannot go stale against the code.

Each operation block states only what is specific to it. The SDK-wide defaults are stated once in sdk-map.md — the call shape, the base ApiError, the default server group — and a block departs from one only by saying so, so a block silent on a point is telling you the default applies. Take it and move on rather than opening the source to confirm.

Which one to reach for

The map and the API reference answer different questions, and both are generated from this SDK so they stay in lockstep with the code.

| Use | For | | --- | --- | | sdk-map.md + map/operations/ | Traversing the SDK and working out its surface — locating the operation you need (this SDK exposes 117 operations), its exact signature, which credential it sends, which channel every request field travels on, which error type it rejects with and how to read it, and the file behind any type. This is the index to consume the SDK from, and the one to reach for first. | | api-reference.md | Usage guidance for a single operation once you know which one you want — a code sample for each of the two call forms (awaiting it, and the non-throwing .asApiResult()), per-parameter descriptions, and the success and error types it resolves or rejects with. |

License

This SDK is distributed under the MIT License.

Support

Refer to the API reference for detailed information on available operations with code samples.