Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 7.43 KB

README.md

File metadata and controls

105 lines (72 loc) · 7.43 KB

Walmart Partner API SDK for .NET


The Walmart Partner API SDK for .NET allows you to build applications that easily integrates with the Walmart Marketplace API

This is a .NET SDK (written in C#) containing convenience libraries and examples of their usage for e-commerce merchants to conduct business on Walmart's marketplace platform.

Walmart's marketplace provides several secure HTTP REST end-points for merchants to submit their items for listing on Walmart's marketplace - Walmart.com. There are also secure HTTP REST end-points for updating prices and inventories, and retrieve order and update their status.

This .NET package demonstrates how to invoke the HTTP REST end-points using C#. It does not include examples in other programming languages such as Java, Perl, Python and PHP which also can be used to invoke the same HTTP REST end-points. The package consists of a zip file containing a .Net Standard 1.3 Library and .Net Core 2.0 (or .NET Framework v4.6) project.

In order to invoke secure HTTP REST end-points, your company must be a registered seller on Walmart.com marketplace. Registration will provide you with a consumer ID and a private key to make secure calls.

Or you can use the "mock" end-points to get an idea of how the real end-points work. This can help you to start and test your integration even before you complete your registration.

Target Frameworks

  • .NET Framework 4.6
  • .NET Standard 1.3

Sample Application

You can find documentation here.

Docker Image for Sample Application

This repository provides a Dockerfile to build an image for sample application. Before you start, make sure Docker is installed and running (instructions).

This project supply Dockerfile to build a Docker image with Sample application. To build it on your local machine run

docker build -t <image-name> .

The following command starts a container

docker run -it -v <folder-with-creds>:/app/settings <image-name>

Example:

unzip WalmartMarketplaceClient.zip # in any folder, i.e /Users//test
cd /Users//test/WalmartMarketplaceClient/Sample
docker build -t partnerapi-app .
docker run -v $(pwd)/settings:/app/settings -it partnerapi-app

Code Snippets

You can find list of examples here

Usage

Installation

This package is distributed as a source code, you need to manually build it and link library from your project. NuGet repository will be available soon, stay tuned!

Build

To build dotnet build Source/

To run tests:

Unit & Integration tests - scripts/run_mp_fast_tests.cmd

E2E tests - scripts/run_mp_e2e_tests.cmd

API Coverage

Object Operation V2/V3 SDK Class -> Method Tests V2/V3
Feeds Get all feed statuses Yes/Yes FeedEndpoint.GetAllFeedStatuses No / No
Get a feedItems status Yes/Yes FeedEndpoint.GetFeedStatus Yes/Yes
Get a feed status Yes/Yes FeedEndpoint.GetFeedStatus Yes/Yes
Items Get all items Yes/Yes ItemEndpoint.GetAllItems Yes/Yes
Get an item Yes/Yes ItemEndpoint.GetItem Yes/Yes
Retire an item Yes/Yes ItemEndpoint.RetireItem Yes/Yes
Bulk create/update items Yes/Yes ItemEndpoint.BulkItemsUpdate Yes/Yes
Prices Update a price Yes/Yes PriceEndpoint.UpdatePrice Yes/Yes
Update bulk prices Yes/Yes PriceEndpoint.UpdateBulkPrices Yes/Yes
Set up CPA SKU Opt-in/Opt-out NA/Yes PriceEndpoint.OptInOutBulkCpaSku NA/No
Set up CPA SKU All NA/Yes PriceEndpoint.SetupAllCpaSku NA/No
Promotions Update Bulk Promotional Prices Yes/Yes PromotionEndpoint.UpdatePromotionPricesInBulk Yes/Yes
Promotional Prices NA/Yes PromotionEndpoint.GetPromotionPrice NA/Yes
Update a Promotional Price NA/Yes Promotion.Endpoint.UpdatePromotionPrice NA/Yes
Orders Get all released orders Yes/Yes OrderEndpoint.GetAllReleasedOrders No / No
Get all orders Yes/Yes OrderEndpoint.GetAllOrders No/No
Get an order Yes/Yes OrderEndpoint.GetOrderById No/No
Acknowledge purchase order Yes/Yes OrderEndpoint.AckOrder No/No
Cancel order lines Yes/Yes OrderEndpoint.CancelOrderLines No/No
Refund order lines Yes/Yes OrderEndpoint.RefundOrderLines No/No
Shipping notification/updates Yes/Yes OrderEndpoint.ShippingUpdates No/No
Inventory Get inventory for an item Yes/NA Inventory.GetInventory Yes/NA
Update inventory for an item Yes/NA Inventory.UpdateInventory Yes/NA
Bulk update inventory Yes/Yes Inventory.UpdateBulkInventory Yes/Yes

Disclaimer

This software is distributed free of cost.

  • Walmart assumes no responsibility for its support
  • Copyright (c) 2018 Walmart Corporation