Walmart.com

Orders API

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

Endpoints 9

Version 3

  • GETGet all orders/v3/orders?shipNode=string&sku=string&customerOrderId=string&purchaseOrderId=string&status=string&createdStartDate=string&createdEndDate=string&fromExpectedShipDate=string&toExpectedShipDate=string&limit=10You can display a list of all orders with the query parameter filter criteria.
  • GETGet all released orders/v3/orders/released?shipNode=string&createdStartDate=string&limit=0You can display all released orders that have been created and are ready for fulfilment.
  • GETGet released orders for next page/v3/orders/released:nextCursorYou can display all released orders that have been created and are ready for fulfilment with nextCursor path parameter.
  • GETGet an order/v3/orders/:purchaseOrderId?shipNode=stringYou can display details of a specific order based on the purchaseOrderId.
  • POSTAcknowledge orders/v3/orders/:purchaseOrderId/acknowledge?shipNode=stringYou can acknowledge an entire order, including all of its order lines. Walmart business rules require to acknowledge orders within four hour of receipt of the…
  • POSTCancel order lines/v3/orders/:purchaseOrderId/cancel?shipNode=stringYou can cancel one or more order lines. You must include a purchaseOrderLineNumber when cancelling an order. After cancelling your order, update the inventory…
  • POSTRefund order lines/v3/orders/:purchaseOrderId/refund?shipNode=stringYou can refund one or more order lines that have been shipped. The response to a successful call contains the order with the refunded line item.
  • POSTShipping updates/v3/orders/:purchaseOrderId/shipping?shipNode=stringYou can change the status of order lines to "Shipped" and trigger the charge to a customer. You must acknowledge your orders before sending a shipping update…
  • GETGet orders for next page/v3/orders:nextCursorYou can display a list of all orders with nextCursor path parameter pagination criteria.

API details

Base URL
https://developer.walmart.com/orderProxy/order-api-doc-app/rest
Authentication
None declared in the description
Operations
9 operations on 9 pathsGET 5POST 4
Main resources
Version 3 9
Description format
Swagger 2.0, API version 3.0.1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Orders API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Orders API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get all orders” (GET /v3/orders?shipNode=string&sku=string&customerOrderId=string&purchaseOrderId=string&status=string&createdStartDate=string&createdEndDate=string&fromExpectedShipDate=string&toExpectedShipDate=string&limit=10), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Orders API?

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu. It is listed under E-commerce and has 9 endpoints.

Who publishes the Orders API?

It is listed from Walmart.com's public API description (an OpenAPI document), not published by Walmart.com on Swastik Codes. Anyone who controls walmart.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Orders API?

Requests go to https://developer.walmart.com/orderProxy/order-api-doc-app/rest. Endpoint paths are added to this base URL.

How do I authenticate with the Orders API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Orders API have?

9 operations on 9 paths (5 GET, 4 POST). The largest groups are Version 3.

Is forking the Orders API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.