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.
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. Standard 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 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 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.
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.
These APIs can be integrated with directly. 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:
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.
Samples for Shipping Template Creation
To create a shipping template, see the sample shipping template in the API Reference section.
Sample Request Body:
When Seller invokes “CREATE SHIPPING TEMPLATE” API , the attribute “type” in the request payload needs to be set as “CUSTOM”.
Seller can create total 60 CUSTOM templates.
Seller can update DEFAULT and CUSTOM shipping templates.
Seller can have total of 60 CUSTOM templates and 1 Default Template.
Template Type
“type” attribute of template can be DEFAULT and CUSTOM templates.
“type” attribute in the request payload of the Shipping Template cannot be updated.
A CUSTOM shipping template can have 1 combinations of Ship method
Standard and any other Ship Methods
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)
STANDARD
0-25
EXPRESS
2-4
Max Charges allowed for Ship Methods
No limit currently, but we recommend Shipping Charges to be as low as possible.
Standard Ship Method
Granular subregions must be supplied for 10 regions and address type Street and PO_BOX
Express Ship Method
Granular subregions must be supplied for 10 regions and address type Street and PO_BOX
Coverage Areas
10 regions along with PO box is supported. Overlapping of areas is not 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.
Available List of Regions
RegionCode
RegionName
SubregionCode
SubregionName
StateCode
StateName
StateSubRegionCode
StateSubRegionName
2001
Greater Toronto
2001
Greater Toronto
GT
Greater Toronto
GT
Greater Toronto
2003
Greater Montreal
2003
Greater Montreal
GM
Greater Montreal
GM
Greater Montreal
2009
Rest of Canada
2009
Rest of Canada
RC
Rest of Canada
RC
Rest of Canada
3017
Urban Ontario
3017
Urban Ontario
UO
Urban Ontario
UO
Urban Ontario
3019
Rural Ontario
3019
Rural Ontario
RO
Rural Ontario
RO
Rural Ontario
3025
Eastern Canada
3025
Eastern Canada
EC
Eastern Canada
EC
Eastern Canada
3023
Rural Quebec
3023
Rural Quebec
RQ
Rural Quebec
RQ
Rural Quebec
2005
Urban British Columbia
2005
Urban British Columbia
UC
Urban British Columbia
UC
Urban British Columbia
3005
Rural British Columbia
3005
Rural British Columbia
RB
Rural British Columbia
RB
Rural British Columbia
3007
Urban Prairies (MB, SK, AB)
3007
Urban Prairies (MB, SK, AB)
UP
Urban Prairies (MB, SK, AB)
UP
Urban Prairies (MB, SK, AB)
2002
Greater Toronto – PO Box
2002
Greater Toronto – PO Box
GT-PO
Greater Toronto – PO Box
GT-PO
Greater Toronto – PO Box
2004
Greater Montreal – PO Box
2004
Greater Montreal – PO Box
GM-PO
Greater Montreal – PO Box
GM-PO
Greater Montreal – PO Box
2010
Rest of Canada – PO Box
2010
Rest of Canada – PO Box
RC-PO
Rest of Canada – PO Box
RC-PO
Rest of Canada – PO Box
3018
Urban Ontario – PO Box
3018
Urban Ontario – PO Box
UO-PO
Urban Ontario – PO Box
UO-PO
Urban Ontario – PO Box
3020
Rural Ontario – PO Box
3020
Rural Ontario – PO Box
RO-PO
Rural Ontario – PO Box
RO-PO
Rural Ontario – PO Box
3026
Eastern Canada – PO Box
3026
Eastern Canada – PO Box
EC-PO
Eastern Canada – PO Box
EC-PO
Eastern Canada – PO Box
3024
Rural Quebec – PO Box
3024
Rural Quebec – PO Box
RQ-PO
Rural Quebec – PO Box
RQ-PO
Rural Quebec – PO Box
2006
Urban British Columbia – PO Box
2006
Urban British Columbia – PO Box
UC-PO
Urban British Columbia – PO Box
UC-PO
Urban British Columbia – PO Box
3006
Rural British Columbia – PO Box
3006
Rural British Columbia – PO Box
RB-PO
Rural British Columbia – PO Box
RB-PO
Rural British Columbia – PO Box
3008
Urban Prairies (MB, SK, AB) – PO Box
3008
Urban Prairies (MB, SK, AB) – PO Box
UP-PO
Urban Prairies (MB, SK, AB) – PO Box
UP-PO
Urban Prairies (MB, SK, AB) – PO Box
Update a shipping template
You can update or delete a shipping template with the Settings APIs.
Update a shipping template
To update a shipping template, Call the Update Shipping Template API: PUT /v3/settings/shipping/templates/{templateId}
View shipping template samples
We provide several sample shipping templates for various shipping scenarios. To view samples, see Payload Samples in Update Shipping Templates API Reference.
Template 3
This sample shows a payload example to update the Template 3 that is described above.
The response includes all shipping templates that a seller has configured, including Custom, Default 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 shipping costs, address types, shipping times and regions for that method.