The Settings API allows you to configure shipping delivery and fulfillment settings your items. You can create shipping templates to specify the precise delivery speed for your items. You can specify fulfillment center choices for your items.
You can create a precise delivery with new shipping speed options:
TwoDay shipping
ThreeDay shipping
Expedited delivery
About Fulfillment Center Settings
You can use the Settings API to make changes to the fulfillment centers and the shipping program you elect for your items (e.g. TwoDay shipping).
Fulfillment centers were also known as “Ship Nodes,” so you might see some parameter names with Ship Node nomenclature.
You can manage your Fulfillment Centers (Ship Nodes) through the following Apis:
While creating and updating non-third-party fulfillment centers, you can pass in an optional Calendar Day Configuration block. This calendar day configuration block provides the flexibility to define Working Days of Week (days on which there is active order processing) along with the cutoff time (time at which order processing stops for the day) for each day in respective timezones. In addition to that, there is a provision of defining additional non-working dates for a fulfillment center (ship node). There is no default Working Days of a Week.
Please note if cutoff time is not explicitly configured for a fulfillment center, the default is taken as 2 pm of fulfillment center’s respective time zone. The configuration is done in a 24hour format (HH:mm) and any value from 00:00 (12 am)to 23:59 (11:59 pm ) can be set.
To fetch Calendar Day Configuration for a fulfillment center, use the optional includeCalendarDayConfiguration flag in the URL. For non-third-party fulfillment centers, where no calendar day configuration is set explicitly, no Calendar Day Configuration will be present while fetching.
You can also access fulfillment and shipping choices via Walmart Seller Center. The APIs use the standard header parameters as with other APIs listed in Developer Portal: Marketplace Settings Program.
Walmart provides an enhanced free TwoDay Shipping Program to enable US marketplace sellers to add multiple fulfillment centers along with capability to manage them and easily configure item assortment setup for TwoDay program.
You can use Shipping Templates to support a fast and precise delivery experience to bridge the gap between promise and actual delivery time. The Settings API allows you to create and manage these settings as a Shipping Template. You can create a shipping template to specify faster shipping for specific regions. First specify the regions, and the ship speed buyers in that region can get their items shipped. Next, you assign the product SKU to that shipping template.
The Shipping Rules API provide access to configure the TwoDay shipping program. For more details about Shipping Rules, see Shipping Rule Managements.
If you would like to provide more shipping options, such as ThreeDay and expedited, you can now use Shipping Templates instead of the shipping rules for TwoDay.
If you onboard to the TwoDay program and create shipping rules with the Rules API, you can migrate to the precise delivery options with Shipping Templates.
These APIs can be integrated with directly or via channel partners that have adopted these changes. These changes can also be accessed via Walmart Seller Center. The APIs use the standard header parameters as with other APIs listed in Developer Portal.
Download the Shipping Templates APIs JSON Schema from:
Use shipping overrides to specify shipping attributes such as ShipMethod, ShipRegion, ShipPrice. Use the Update Items in Bulk API, and use the Shipping Override feed.
The program offers qualified sellers a way to offer free, two-day shipping to our customers with dynamic, location-based logic that will automatically display the “2-Day Shipping” banner on eligible items. Two-day shipping is made available through additions to the request body during Item setup.
We provide several sample shipping templates for various shipping scenarios. To view samples, see Payload Samples in Create Shipping Templates API Reference.
Note: Each template description corresponds to a template sample. See all Payload Samples in Create Shipping Templates API Reference.
General Request Template
To create a general request, see the sample shipping template in the API Reference section, Sample Request Body: SAMPLE 1.
This samples provides for the scenario with 48 States Street + 48 states PO Box + (AK andHI Street and PO Box + US Protectorates Street and PO Box) + APO/FPO .48 States Street has granular subregions -> state -> stateSubRegions.
Template 3
48 States Street + PO Box => Cannot be clubbed with any other regions. will create an individual rule (configuration).
Template 4
Hawaii & Alaska + US Protectorates + Street + PO Box => creates one rule with both regions and both PO Box and Street selected. Otherwise 2 rules needs be created
Template 5
APO/FPO => Cannot be clubbed with any other regions Has MILITARY address Type.
Template 6
(Hawaii & Alaska and US Protectorates + PO Box) + US Protectorates Street => creates 2 rule
Template 7
Seller Selects subset of 48 State Street Subregions.
Template 8
When PARTNER invokes “CREATE SHIPPING TEMPLATE” API , the attribute “type” needs to be set as ” CUSTOM”
Template 9
Third-party delivers the item, and invokes “CREATE SHIPPING TEMPLATE” API , the attribute “type” needs to be set 3PL Specific (for example: “DELIVER”)
Template 10
A tiered shipping template example.
Template 11
This sample shows a payload example to create or update the Paid Standard shipping template.with the option to add a ship charge. for a “Paid Standard” shipping template.
This differs from the typical usage, where the Paid Standard Shipping template provides free shipping.
For “VALUE” shipping, HI and AK states can be selected while template creation or updation.
Freight Template
Freight templates are a type of custom template, that allows sellers to define their settings specific to oversized/heavy items. Freight shipping templates can have transit time ranging from 6 – 10 days and are paid shipping templates. See the sample shipping template in the API Reference section, Sample Request Body: FREIGHT TEMPLATE.
When Seller invokes “CREATE SHIPPING TEMPLATE” API , the attribute “type” in the request payload needs to be set as “CUSTOM”.
Seller can create total 15 CUSTOM templates.
Seller can update DEFAULT, CUSTOM and 3PL-specific (DELIVER) shipping templates.
Seller can have total of 15 CUSTOM templates, 4 3PL specific and 1 Default Template.
Delegate access for Solution Providers
Third-party Solution Providers must use delegated access for invoking this API with proper External Headers.
When 3PL partner invokes “CREATE SHIPPING TEMPLATE” API , the attribute “type” in the request payload needs to be set as template specific to 3PL e.g. if DELIVER invokes the API, template type should be set as “DELIVER”.
3PL can create total 4 templates per seller.
3PL cannot create Freight Shipping Templates.
3PL can only update 3PL-specific templates e.g. DELIVER can update only DELIVER template.
Template Type
“type” attribute of template can be DEFAULT, CUSTOM or 3PL-specific (e.g. DELIVER) templates.
“type” attribute in the request payload of the Shipping Template cannot be updated.
A CUSTOM shipping template can have two combinations of Ship method
Only Freight Ship Method
Value and any other Ship Methods (Except Freight)
The DEFAULT shipping template cannot be created/ deleted/ disabled.
Template Naming Conventions
Only alphanumeric characters (a-z, A-Z, 0-9) and spaces are allowed in the template name. Spaces will be removed from the start and end of the name. Name having only spaces will be considered empty.
Max template length allowed is 25 chars.
Template Name must be unique for a seller, and it is case insensitive
Allowable Shipping Method per Transit Time
Allowable shipping methods and transit time combinations are:
Method
Transit Time (days)
VALUE
6,7
TWO_DAY
2
STANDARD
3,4,5
FREIGHT
6,7,8,9,10
Note: Use the VALUE ship method for free shipping with a transit time of 6 or 7 days. Use the FREIGHT ship method for paid shipping with a transit time of 6 to 10 days.
Max Charges allowed for Ship Methods
Max Charges allowed for Ship Methods:
Method
Shipping and Handling
Charge Per Weight
Charge Per Item
Tiered Charges
VALUE
0
0
0
0
STANDARD
200
200
200
200
TWO_DAY
0
0
0
0
FREIGHT
200
200
200
200
Freight Ship Method
Only allowed for Custom templates.
No granular subregions supported.
Two Day (Expedited) Ship method
Only allowed for Sellers approved on Two Day Program.
Free shipping always for Expedited Shipping Methods (Both rate models).
Value Ship Method
Can have multiple shipping rules.
Value Ship-method should have 48 STATE region and address type should be STREET.
HI and AK states and other uncommon regions can be selected if required.
For VALUE ship method No granular subregions supported.
Free shipping always for Value Shipping Methods (Both rate models).
Standard Ship Method
Granular subregions must be supplied for 48 states and address type Street.
Coverage Areas
No Granular subregion support for regions : HI and AK, Street, US Protec, APO/FPO.No Granular subregion support for 48 States PO BOX.No Overlapping of areas allowed in different shipping rules for the same shipping method in a template.
Rate Model
If the attribute “rateModelType” is set to “PER_SHIPMENT_PRICING” then only Per Shipment charges must be supplied.If the attribute “rateModelType” is set to “TIERED_PRICING” then only a list of Tiered shipping charges must be supplied.If the attribute “rateModelType” is set to “TIERED_PRICING”, then the range of “minLimit” to “maxLimit” for the attribute “tieredShippingCharges” should be continuous. e.g. minLimit=0, maxLimit=5 ; minLimit=5.01, maxLimit=-1-1 for attribute “maxLimit” indicates highest value of charges for the ship method.
Update a shipping template
You can update or delete a shipping template with the Settings APIs.
We provide several sample shipping templates for various shipping scenarios. To view samples, see Payload Samples in Update Shipping Templates API Reference.
This sample shows a payload example to update the Paid Standard shipping template, with the option to add a ship charge for a “Paid Standard” shipping template.
This differs from the typical usage, where the Paid Standard Shipping template provides free shipping.
The response includes all shipping templates that a seller has configured, including Custom, Default and third-party specific (e.g. DELIVERR) templates.
Authentication Requirements for sellers and solution providers
Sellers must use seller authentication with proper external headers. To set up your API key, see Authentication.
For third-party partner access, make sure to provide delegated access permissions to the partner. To create an API key for a solution provider, see Authorization.
Make a call to Get All Shipping Details API and specify the templateId for the Shipping Template you want to view as a path parameter, for example:
/v3/settings/shipping/templates{templateId}
The response returns all the details about that shipping template.
Template type – this can be either DEFAULT, CUSTOM or DELIVERR.
Rate Models – Configures either tiered pricing or per-shipment pricing. For example, TIERED_PRICING means that you charge shipping rates based on item price. PER_SHIPMENT_PRICING means that you charge shipping based on item weight in pounds, or based on the number of items purchased in an order.
Shipping Methods – For each shipMethod (e.g. TWO_DAY or VALUE) it provides the region, shipping costs, address types, shipping times and regions for that method.
Find out template activation status
To find out if a seller has Shipping Templates program activated, you can get the activation status with the Shipping Template Activation Status API.
Note: The activation status represents whether or not the seller has onboarded to the Shipping Templates program. This is different from the active or inactive setting the seller can specify for the template.
The API call returns activationStatus, either NOT_ACTIVATED or ACTIVATED and the date of program activation. The createdDate is the date that the Shipping Template was activated in the Seller Center.
The modifiedDate is that last date the Shipping Template activation status has changed.
Get Partner Configurations
Get Partner Configurations API provides Partner (Seller) level configurations like Account Status and Feed Throttling Configurations.
The Partner block will have the following fields:
partnerId – The partner/seller ID
partnerName – The seller’s legal name
partnerDisplayName – The seller name shown on walmart.com
partnerStoreId – The partner/seller ID for Walmart store URL
businessRegNumber – A registered distinct identifier such as US Tax ID / Foreign Tax ID
countryOfIncorporation – The country from where seller conducts their business | ISO 3166 Country code
Account Status of a Partner (Seller) Can be:
TERMINATED
ONBOARDING_ACTIVE
ACTIVE
ONBOARDING_INACTIVE
SUSPENDED
TNS_DECLINED
The Feed Throttling configurations block provides Partner (Seller) Level Throttling configurations for various kinds of Feeds, viz.
item
RETIRE_ITEM
MP_ITEM
MP_WFS_ITEM
MP_ITEM_MATCH
MP_MAINTENANCE
SKU_TEMPLATE_MAP
SHIPPING_OVERRIDES
For more details on the types of feed please refer here. Please note that the default throttling configuration across Walmart and the API Throttling Response Headers can be found here. If Partner (Seller) throttling limits are updated by Walmart, the updated limits are reflected in Get Partner Configurations API.
Get Shipping Configurations
This API can be used to retrieve shipping configurations like Lag Time Exceptions configured for Partners (Sellers). It returns lag time for exception categories that were configured for the Partner (Seller) through Request Lag Time Exceptions process. Normally, a lag time of 0 and 1 can be set for an Item if the item does not belong to an Exception category. In case there are no exceptions set for a Partner (Seller) or Lag Time Exceptions are removed, the API will return an empty response. The Lagtime Exception Categories can be: “Art & Craft” , “Garden & Patio” etc.
The fulfillmentLagTime value returned by the API is the maximum lag time that can be set against Items belonging to these categories. The lag time exception categories are the same categories found under Item Spec -> “properties -> MPItem -> items -> properties -> Visible -> properties”. Item setup can be performed using the “Bulk Item Setup” API here.
The Lagtime of an Item can be fetched using the “Lag Time” API here. Updation of Lag Time can be done using the “Update lag time” API here.
The Partner block will have the following fields:
partnerId – The partner/seller ID
partnerName – The seller’s legal name
partnerDisplayName – The seller name shown on walmart.com
partnerStoreId – The partner/seller ID for Walmart store URL
