Getting Started with Walmart APIs

Introduction

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, 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.

Install the Package

Run the following command from your project directory to install the package from npm:

npm install [email protected]

For additional package details, see the Npm page for the [email protected] npm.

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

| Parameter | Type | Description | | --- | --- | --- | | environment | Environment | The API environment. Default: Environment.Production | | timeout | number | Timeout for API calls.Default: 30000 | | httpClientOptions | Partial<HttpClientOptions> | Stable configurable http client options. | | unstableHttpClientOptions | any | Unstable configurable http client options. | | logging | PartialLoggingOptions | Logging Configuration to enable logging | | basicAuthCredentials | BasicAuthCredentials | The credential object for basicAuth |

The API client can be initialized as follows:

Code-Based Client Initialization

import { Client, Environment, LogLevel } from 'walmart-apimatic-sdk';

const client = new Client({
  basicAuthCredentials: {
    username: 'username',
    password: 'password'
  },
  timeout: 30000,
  environment: Environment.Production,
  logging: {
    logLevel: LogLevel.Info,
    logRequest: {
      logBody: true
    },
    logResponse: {
      logHeaders: true
    }
  },
});

Configuration-Based Client Initialization

import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'walmart-apimatic-sdk';

// Provide absolute path for the configuration file
const absolutePath = path.resolve('./config.json');

// Read the configuration file content
const fileContent = fs.readFileSync(absolutePath, 'utf-8');

// Initialize client from JSON configuration content
const client = Client.fromJsonConfig(fileContent);

See the Configuration-Based Client Initialization section for details.

Environment-Based Client Initialization

import * as dotenv from 'dotenv';
import * as path from 'path';
import * as fs from 'fs';
import { Client } from 'walmart-apimatic-sdk';

// Optional - Provide absolute path for the .env file
const absolutePath = path.resolve('./.env');

if (fs.existsSync(absolutePath)) {
  // Load environment variables from .env file
  dotenv.config({ path: absolutePath, override: true });
}

// Initialize client using environment variables
const client = Client.fromEnvironment(process.env);

See the Environment-Based Client Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

| Name | Description | | --- | --- | | Production | Default |

Authorization

This API uses the following authentication schemes.

• basic (Basic Authentication)

List of APIs

• Strategy Collection Id
• Strategy
• Strategies
• Wfpreference
• Incentives
• Get Pricing Insights
• Price
• Repricer Feeds
• Feeds
• Feeds ? Feed Type PRICE and PROMOTION
• Feeds ? Feed Type WALMART FUNDED INCENTIVES ENROLLMENT
• Feeds ? Feed Type INCENTIVE ENROLLMENT
• Cppreference
• Detail
• Token
• Misc

SDK Infrastructure

Configuration

• HttpClientOptions
• RetryConfiguration
• ProxySettings
• Configuration-Based Client Initialization
• Environment-Based Client Initialization
• PartialLoggingOptions
• PartialRequestLoggingOptions
• PartialResponseLoggingOptions
• LoggerInterface

HTTP

• HttpRequest

Utilities

• ApiResponse
• ApiError