API Reference
My Account

Shipping estimates

post
https://marketplace.walmartapis.com/v3/shipping/labels/shipping-estimates

This API retrieves shipping cost estimates for available shipping services based on address and package (example, customer address, packaged weight.)

Market availability: US only

Body Params

Shipping fields

boxDimensions
object
required

Dimensions and weight of the package being shipped. For CUSTOM_PACKAGE, all dimensions and weight are required.

string

Estimated delivery date.

string

ShipBy date.

fromAddress
object
required

From address - Seller's fulfillment center address.

toAddress
object
required

To Address - Customer's delivery address.

carriers
array of strings

Carriers List. This value maps to 'shortName' from All carriers API response.If not provided, it will fetch response for all service types.

carriers
string
required

Package Type. This value maps to 'packageTypeShortName' from All carrier package types API response.

boolean

Delivery promise date flag. Pass 'false' if only services meeting promised delivery dates needs to be fetched, else 'true' to fetch all supported delivery dates

string
required

An unique identifier associated with the seller's purchase order.

boxItems
array of objects
required

boxItems - A list of items that the seller will be shipping in this package. Each item must correspond to a line item in the specified purchaseOrder. The lineId and SKU fields are used to uniquely identify the specific item being shipped.

boxItems*
boolean

addOns flag. Pass 'true' to fetch all addOns cost and we support two add ons type: SIGNATURE and INSURANCE. To get Insurance Estimate, please provide purchaseOrderId and boxItems details. By default, The value of addOns will be false.

boolean

hasBattery flag. Pass 'true' if the shipment consists of battery. This is a mandatory field for yanwen.

Headers
string
required

Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.
Example: eyJraWQiOiIxNWNhNGIyYi0yODVjLTQ0ZDUtYmExNC05ZDk1NTlkZmUwNjgiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0....

Market availability: Global

string

A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding.

Market availability: Global

string
required

A unique ID which identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.

Market availability: Global

string
required

Specifies the name of the Walmart service being called.
Example: Walmart Marketplace

Market availability: Global

string
enum
required

Case-sensitive market identifier. Valid values: MX, CA, CL

Market availability: Global

Allowed:
string
enum
required

Indicates the global version of the API. The value must be set to 3.1.

Market availability: Global

Allowed:
Responses

Updated 11 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago