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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Shipping fields

boxDimensions

object

required

Box dimensions and weight for a shipping package.

deliverByDate

string

Estimated delivery date.

shipByDate

string

ShipBy date.

fromAddress

object

required

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

packageType

string

required

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

includeServicesNotMeetingDeliveryPromise

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

purchaseOrderId

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*

addOns

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.

hasBattery

boolean

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

Headers

WM_CONSUMER.CHANNEL.TYPE

string

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

WM_SEC.ACCESS_TOKEN

string

required

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

Market availability: Global

WM_QOS.CORRELATION_ID

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.

WM_SVC.NAME

string

required

Walmart Service Name

string

required

The only supported response media type is application/json.

Response

200Successful Operation