walmart

Walmart integration via Apideck's Ecommerce unified API — same methods work across every connector in Ecommerce, switch by changing `serviceId`. Use when the user wants to read, write, or sync orders,

SKILL.md

GitHub

Walmart (via Apideck)

Access Walmart through Apideck's Ecommerce unified API — one of 17 Ecommerce connectors that share the same method surface. Code you write here ports to Shopify, BigCommerce, Shopify (Public App) and 13 other Ecommerce connectors by changing a single serviceId string. Apideck handles auth, pagination, rate limiting, and retries so you don't write per-tenant Walmart plumbing.

Quick facts

At a glance

  • Implementation difficulty: involved — Solution Provider Approval Required + App Review Before Sellers Can Connect
  • Vendor partnership required: yes (Walmart Solution Provider Center) — Approved Solution Providers get sandbox access, production OAuth app credentials and a listing in the Walmart Seller Center App Store.
  • Apideck-managed credentials: not available — Walmart issues OAuth app credentials only to approved Solution Providers, so you register your own app.
  • Account type required: Approved Walmart Marketplace seller account.
  • Consumer access level: A user who can sign in to Walmart Seller Center for the seller account and authorise the app.
  • Sandbox: available (signup) — Issued in the Solution Provider Center once you are approved; for API testing only.
  • Costs: Walmart publishes no fee for API access.
  • Rate limits: Orders: 5,000 requests a minute. Items: 300 a minute, or 60 a minute with query parameters.
  • Authentication: Authorization Code flow.
  • Webhooks: No webhooks - orders, products and the store are read on demand through the API.

Important to know:

  • Sellers connect only by authorising an approved Solution Provider app; they cannot connect with their own Walmart API keys, and Walmart no longer supports Delegated Access.
  • United States sellers can connect today; the connector authorises against the US marketplace only, so sellers on Walmart Canada, Mexico or Chile cannot be connected.

Facts synced from Apideck's connector metadata API — GET /connector/connectors/walmart (overview field) is the live, authoritative version.

When to use this skill

Activate this skill when the user explicitly wants to work with Walmart — for example, "list orders in Walmart" or "sync products in Walmart". This skill teaches the agent:

  1. Which Apideck unified API covers Walmart (Ecommerce)
  2. The correct serviceId to pass on every call (walmart)
  3. Walmart-specific auth and coverage caveats

For the full method surface (parameters, pagination, filtering), use your language SDK skill:

For the raw OpenAPI spec:

Minimal example (TypeScript)

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  apiKey: process.env.APIDECK_API_KEY,
  appId: process.env.APIDECK_APP_ID,
  consumerId: "your-consumer-id",
});

// List orders in Walmart
const { data } = await apideck.ecommerce.orders.list({
  serviceId: "walmart",
});

Portable across 17 Ecommerce connectors

The Apideck Ecommerce unified API exposes the same methods for every connector in its catalog. Switching from Walmart to another Ecommerce connector is a one-string change — no rewrite, no new SDK.

// Today — Walmart
await apideck.ecommerce.orders.list({ serviceId: "walmart" });

// Tomorrow — same code, different connector
await apideck.ecommerce.orders.list({ serviceId: "shopify" });
await apideck.ecommerce.orders.list({ serviceId: "bigcommerce" });

This is the compounding advantage of using Apideck over integrating Walmart directly: code against the unified Ecommerce API once, gain access to every connector in it. New connectors Apideck adds become available to your app without code changes.

Authentication

  • Type: OAuth 2.0
  • Managed by: Apideck Vault — Apideck handles the full OAuth dance (authorization code flow, token exchange, refresh). Never ask the user for API keys or tokens directly.
  • User setup: Users authorize via the Vault modal. Connection state progresses available → added → authorized → callable.
  • Token refresh: automatic. Expired tokens are refreshed transparently on the next API call.

See apideck-best-practices for Vault setup, connection lifecycle, and handling re-auth flows.

Verifying coverage

Not every Ecommerce operation is supported by every connector. Always verify before assuming a method works:

curl 'https://unify.apideck.com/connector/connectors/walmart' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}"

See apideck-connector-coverage for patterns around UnsupportedOperationError and connector-specific fallbacks.

Escape hatch: Proxy API

When an endpoint isn't covered by the Ecommerce unified API, use Apideck's Proxy to call Walmart directly — Apideck injects auth headers and handles token refresh. Set x-apideck-downstream-url to the target endpoint on Walmart's own API:

curl 'https://unify.apideck.com/proxy' \
  -H "Authorization: Bearer ${APIDECK_API_KEY}" \
  -H "x-apideck-app-id: ${APIDECK_APP_ID}" \
  -H "x-apideck-consumer-id: ${CONSUMER_ID}" \
  -H "x-apideck-service-id: walmart" \
  -H "x-apideck-downstream-url: <target endpoint on Walmart>" \
  -H "x-apideck-downstream-method: GET"

See Walmart's API docs for available endpoints.

Sibling connectors

Other Ecommerce connectors that share this unified API surface (same method signatures, just change serviceId):

shopify (beta), bigcommerce (beta), shopify-public-app (beta), woocommerce (beta), amazon-seller-central (beta), ebay (beta), etsy (beta), magento (beta), and 8 more.

See also