New Features for Precise Delivery
Introduction
As a part of the Precise Delivery program, we are bringing new features for Marketplace sellers that will enable sellers to support a fast and precise delivery experience. This program aims to bridge the gap between promise and actual delivery time by giving granular region level customisation capability to the sellers for their assortment and fulfilment options management.
Capabilities included as a part of the new features are –
- Sellers can CREATE and MANAGE ship-settings as Shipping Template
- Sellers can assign custom SKUs to Shipping Template via Bulk Upload/API or ItemSpec
- Sellers can get visibility into Item to Ship-template mapping details through Reports
Timelines and Updates
The changes are targeted to be available in production by late-September 2020. API specification below is for early preview, so you can plan your development, prior to the actual release. If there are any API changes prior to release based on integrator's feedback, they will be updated in this page itself.
API Specification
|
S.No. |
Features |
Applicable To |
API Specifications |
|
1 |
Template Creation & Management |
|
Get ALL ShipTemplates Get Details of a Shipping Template Create Shipping Template Update Shipping Template Delete a shipping template |
|
2 |
Assign custom SKUs to Shipping Template via Bulk Upload/API |
|
SKU to Template Association |
|
3 |
Deliverr Overrides |
|
Sample Deliverr Request |
|
4 |
Configuration Reports |
|
Shipping Configuration Report Shipping Program Report |
Base URL - https://marketplace.walmartapis.com/v3/settings/shipping
API Headers
| Accept | */* |
| Authentication Headers | <<Authentication Headers>> |
| Content Type | application/json |
| Host | marketplace.walmartapis.com |
Request/Response JSON Parameter Details
|
JSON Key |
Type |
Sample Value |
Description |
|
id |
String |
4557281627891219 |
Shipping Template ID |
| name |
String |
West Coast template |
Shipping Template Name |
| type |
String |
|
Shipping Template Type |
| status |
String |
|
Shipping Template/ Configurations active or inactive status |
| createdDate |
String |
1594630961156 |
Template Creation Date |
| modifiedDate |
String |
1594630961156 |
Template Modified Date |
| totalRecords |
String |
123 |
Total Number of records in the response of the API. |
| rateModelType |
String |
|
This is the shipping model type.
|
| shippingMethods |
Array of Object |
Array of different ship methods of a Shipping Template |
|
| shipMethod |
String |
VALUE STANDARD TWO_DAY FREIGHT |
VALUE: All Marketplace Sellers must offer Value shipping to Walmart.com customers for items that can't ship within expected transit times for standard shipping. STANDARD: You are required to offer standard shipping to Walmart.com customers. FREIGHT: Heavy items which takes 8,9,10 days. |
|
configurations |
Array of Object |
Contains an array of Regions, an array of Address Type, Transit Time and Per shipping charge or array of Tired Shipping Charge |
|
|
regions |
Array of Object |
Supported Regions includes 48 State Street, 48 State – Street Po Box/Street, AK and HI – Street etc |
|
|
regionCode |
String |
C |
Supported Region Code |
|
regionName |
String |
48 State |
Supported Region Name |
|
subRegions |
Array of Objects |
Supported Sub-region |
|
|
subRegionCode |
String |
NE |
Supported Sub-region Code |
|
subRegionName |
String |
NE |
Supported Sub-region Name |
|
states |
Array Of Objects |
Supported States |
|
|
stateCode |
String |
PA |
Supported State Code |
|
stateName |
String |
Pennsylvania |
Supported State Name |
|
stateSubregions |
Array of Objects |
Supported Subregions of a State |
|
|
stateSubregionCode |
String |
PA3 |
Supported state subregion code |
|
stateSubregionName |
String |
PA3 |
Supported state subregion name |
|
addressType |
String |
· PO_BOX · STREET · MILITARY |
Supported address type |
|
transitTime |
Number |
1 |
Time in transit |
|
perShippingCharge |
Object |
Charge per shipping |
|
|
unitOfMeasure |
String |
LB |
Unit of Measure |
|
shippingAndHandling |
Object |
Shipping and Handling Charge Object |
|
|
amount |
Number |
0.05 |
The numerical amount for that charge. Example: 9.99 |
|
currency |
String |
USD |
The type of currency for the charge. Example: USD for US Dollars |
|
chargePerWeight |
Object |
Per Weight Charge |
|
|
chargePerItem |
Object |
Per Item Charge |
|
|
tieredShippingCharges |
Object |
Shipping Charges |
|
|
minLimit |
Number |
minimum Limit |
|
|
maxLimit |
Number |
Maximum Limit |
|
|
shipCharge |
Object |
Details of Shipping Charge |
Get All Shipping Templates
|
Use Case |
Get all the shipping template for a Seller |
||||||||
|
Prerequisites |
1. Deliverr Partner must use delegated access for invoking this API with proper External Headers 2. Seller must use seller authentications while using this API with proper External Headers |
||||||||
|
Conditions |
1. Deliverr will be able to see only Deliverr Templates 2. Partner will be able to see Deliverr, Custom and Default Template |
||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/templates?mediaType={mediaType} |
||||||||
|
Request Parameters |
|
||||||||
|
Http Method |
GET |
||||||||
|
Request Payload |
NA |
||||||||
|
Response Body |
{ "shippingTemplates": [ { "id": "6149582897525423", "name": "Custom Template 1", "type": "CUSTOM", "status": "ACTIVE", "rateModelType": "TIERED_PRICING", "createdDate": "1594378810740", "modifiedDate": "1594378810740" }, { "id": "24451553786425", "name": "Custom template AM 1", "type": "CUSTOM", "status": "INACTIVE", "rateModelType": "TIERED_PRICING", "createdDate": "1594402467708", "modifiedDate": "1594819837077" } ], "totalRecords": "2" } |
Get Details of A Shipping Template
|
Use Case |
Get details of the specific template |
||||||||
|
Prerequisites |
|
||||||||
|
Conditions |
|
||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/templates/{templateId} |
||||||||
|
Request Parameters |
|
||||||||
|
Http Method |
GET |
||||||||
|
Request Payload |
NA |
||||||||
|
Response Body |
{
"id": "5235903149749704",
"name": "Transit Time Template",
"type": "CUSTOM",
"rateModelType": "TIERED_PRICING",
"status": "ACTIVE",
"shippingMethods": [
{
"shipMethod": "VALUE",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State"
}
],
"addressType": [
"STREET"
],
"transitTime": 6,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": -1,
"shipCharge": {
"amount": 0.0,
"currency": "USD"
}
}
]
}
]
},
{
"shipMethod": "STANDARD",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA4",
"stateSubregionName": "PA4"
},
{
"stateSubregionCode": "PA1",
"stateSubregionName": "PA1"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD1",
"stateSubregionName": "SD1"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 4,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA3",
"stateSubregionName": "PA3"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT1",
"stateSubregionName": "CT1"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD2",
"stateSubregionName": "SD2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 1.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 2.05,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State"
},
{
"regionCode": "P",
"regionName": "US Protectorates"
}
],
"addressType": [
"PO_BOX"
],
"transitTime": 5,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "P",
"regionName": "US Protectorates"
},
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
},
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA2",
"stateSubregionName": "PA2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 5.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 6.05,
"currency": "USD"
}
}
]
}
]
}
],
"createdBy": "am@gmail.com",
"modifiedBy": "gm@gmail.com",
"createdDate": "1595309580126",
"modifiedDate": "1595319509156"
}
|
Create Shipping Template
|
Use Case |
Create a new shipping template |
|||||||||||||||||||||||||||||||||||
|
Prerequisites |
|
|||||||||||||||||||||||||||||||||||
|
Conditions |
{
"tieredShippingCharges": [
{
"minLimit": 0,
"maxLimit": 5,
"shipCharge": {
"currencyAmount": 0.1,
"currencyUnit": "USD"
}
},
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"currencyAmount": 0.1,
"currencyUnit": "USD"
}
}
]
}
|
|||||||||||||||||||||||||||||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/templates |
|||||||||||||||||||||||||||||||||||
|
Request Parameters |
||||||||||||||||||||||||||||||||||||
|
Http Method |
POST |
|||||||||||||||||||||||||||||||||||
|
Request Payload |
{
"name": "Transit Time Template Custom 2",
"type": "CUSTOM",
"rateModelType": "TIERED_PRICING",
"status": "ACTIVE",
"shippingMethods": [
{
"shipMethod": "VALUE",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State"
}
],
"addressType": [
"STREET"
],
"transitTime": 6,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": -1,
"shipCharge": {
"amount": 0.0,
"currency": "USD"
}
}
]
}
]
},
{
"shipMethod": "STANDARD",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA4",
"stateSubregionName": "PA4"
},
{
"stateSubregionCode": "PA1",
"stateSubregionName": "PA1"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD1",
"stateSubregionName": "SD1"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 4,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA3",
"stateSubregionName": "PA3"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT1",
"stateSubregionName": "CT1"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD2",
"stateSubregionName": "SD2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 1.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 2.05,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State"
},
{
"regionCode": "P",
"regionName": "US Protectorates"
}
],
"addressType": [
"PO_BOX"
],
"transitTime": 5,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "P",
"regionName": "US Protectorates"
},
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
},
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA2",
"stateSubregionName": "PA2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 5.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 6.05,
"currency": "USD"
}
}
]
}
]
}
]
}
|
|||||||||||||||||||||||||||||||||||
|
Response Body |
{
"id": "73716811029721089",
"name": "Transit Time Template Custom 2",
"type": "CUSTOM",
"rateModelType": "TIERED_PRICING",
"status": "ACTIVE",
"shippingMethods": [
{
"shipMethod": "VALUE",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State"
}
],
"addressType": [
"STREET"
],
"transitTime": 6,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": -1,
"shipCharge": {
"amount": 0.0,
"currency": "USD"
}
}
]
}
]
},
{
"shipMethod": "STANDARD",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA4",
"stateSubregionName": "PA4"
},
{
"stateSubregionCode": "PA1",
"stateSubregionName": "PA1"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD1",
"stateSubregionName": "SD1"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 4,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA3",
"stateSubregionName": "PA3"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT1",
"stateSubregionName": "CT1"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD2",
"stateSubregionName": "SD2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 1.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 2.05,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State"
},
{
"regionCode": "P",
"regionName": "US Protectorates"
}
],
"addressType": [
"PO_BOX"
],
"transitTime": 5,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "P",
"regionName": "US Protectorates"
},
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
},
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA2",
"stateSubregionName": "PA2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 5.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 6.05,
"currency": "USD"
}
}
]
}
]
}
]
}
|
Update Shipping Template
|
Use Case |
Update Existing Shipping Template |
|||||||||||||||||||||||||||||||||||
|
Prerequisites |
|
|||||||||||||||||||||||||||||||||||
|
Conditions |
{
"tieredShippingCharges": [
{
"minLimit": 0,
"maxLimit": 5,
"shipCharge": {
"currencyAmount": 0.1,
"currencyUnit": "USD"
}
},
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"currencyAmount": 0.1,
"currencyUnit": "USD"
}
}
]
}
|
|||||||||||||||||||||||||||||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/templates/{templateId} |
|||||||||||||||||||||||||||||||||||
|
Request Parameters |
|
|||||||||||||||||||||||||||||||||||
|
Http Method |
PUT |
|||||||||||||||||||||||||||||||||||
|
Request Payload |
{
"name": "Transit Time Template Custom 2 updated",
"type": "CUSTOM",
"rateModelType": "TIERED_PRICING",
"status": "ACTIVE",
"shippingMethods": [
{
"shipMethod": "VALUE",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State"
}
],
"addressType": [
"STREET"
],
"transitTime": 6,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": -1,
"shipCharge": {
"amount": 0.0,
"currency": "USD"
}
}
]
}
]
},
{
"shipMethod": "STANDARD",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA4",
"stateSubregionName": "PA4"
},
{
"stateSubregionCode": "PA1",
"stateSubregionName": "PA1"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD1",
"stateSubregionName": "SD1"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 4,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA3",
"stateSubregionName": "PA3"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT1",
"stateSubregionName": "CT1"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD2",
"stateSubregionName": "SD2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 1.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 2.05,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State"
},
{
"regionCode": "P",
"regionName": "US Protectorates"
}
],
"addressType": [
"PO_BOX"
],
"transitTime": 5,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "P",
"regionName": "US Protectorates"
},
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
},
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA2",
"stateSubregionName": "PA2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 5.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 6.05,
"currency": "USD"
}
}
]
}
]
}
]
}
|
|||||||||||||||||||||||||||||||||||
|
Response Body |
{
"id": "73716811029721089",
"name": "Transit Time Template Custom 2 updated",
"type": "CUSTOM",
"rateModelType": "TIERED_PRICING",
"status": "ACTIVE",
"shippingMethods": [
{
"shipMethod": "VALUE",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State"
}
],
"addressType": [
"STREET"
],
"transitTime": 6,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": -1,
"shipCharge": {
"amount": 0.0,
"currency": "USD"
}
}
]
}
]
},
{
"shipMethod": "STANDARD",
"status": "ACTIVE",
"configurations": [
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA4",
"stateSubregionName": "PA4"
},
{
"stateSubregionCode": "PA1",
"stateSubregionName": "PA1"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD1",
"stateSubregionName": "SD1"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 4,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA3",
"stateSubregionName": "PA3"
}
]
},
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT1",
"stateSubregionName": "CT1"
}
]
}
]
},
{
"subRegionCode": "MW",
"subRegionName": "MW",
"states": [
{
"stateCode": "SD",
"stateName": "South Dakota",
"stateSubregions": [
{
"stateSubregionCode": "SD2",
"stateSubregionName": "SD2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 1.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 2.05,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State"
},
{
"regionCode": "P",
"regionName": "US Protectorates"
}
],
"addressType": [
"PO_BOX"
],
"transitTime": 5,
"tieredShippingCharges": [
{
"minLimit": 5.01,
"maxLimit": -1,
"shipCharge": {
"amount": 0.13,
"currency": "USD"
}
},
{
"minLimit": 0.0,
"maxLimit": 5,
"shipCharge": {
"amount": 0.11,
"currency": "USD"
}
}
]
},
{
"regions": [
{
"regionCode": "P",
"regionName": "US Protectorates"
},
{
"regionCode": "H",
"regionName": "AK and HI"
},
{
"regionCode": "C",
"regionName": "48 State",
"subRegions": [
{
"subRegionCode": "NE",
"subRegionName": "NE",
"states": [
{
"stateCode": "CT",
"stateName": "Connecticut",
"stateSubregions": [
{
"stateSubregionCode": "CT2",
"stateSubregionName": "CT2"
}
]
},
{
"stateCode": "PA",
"stateName": "Pennsylvania",
"stateSubregions": [
{
"stateSubregionCode": "PA2",
"stateSubregionName": "PA2"
}
]
}
]
}
]
}
],
"addressType": [
"STREET"
],
"transitTime": 3,
"tieredShippingCharges": [
{
"minLimit": 0.0,
"maxLimit": 10,
"shipCharge": {
"amount": 5.0,
"currency": "USD"
}
},
{
"minLimit": 10.01,
"maxLimit": -1,
"shipCharge": {
"amount": 6.05,
"currency": "USD"
}
}
]
}
]
}
]
}
|
Delete Shipping Template
|
Use Case |
Delete Existing Shipping Template |
||||||||
|
Prerequisites |
|
||||||||
|
Conditions |
|
||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/templates/{templateId} |
||||||||
|
Request Parameters |
|
||||||||
|
Http Method |
DELETE |
||||||||
|
Request Payload |
NA | ||||||||
|
Response Payload |
{
"id": "180778427676118"
}
|
Get All Fulfilment Centres
|
Use Case |
Download All fulfilment Centres of a Seller |
||||||||
|
Prerequisites |
|
||||||||
|
Conditions |
|
||||||||
|
Api Uri |
https://marketplace.walmartapis.com/v3/settings/shipping/shipnodes?mediaType={mediaType} |
||||||||
|
Request Parameters |
|
||||||||
|
Http Method |
GET |
||||||||
|
Request Payload
|
NA
|
||||||||
|
Response Payload |
[{
"shipNode": "79897837271126017",
"nodeType": "PHYSICAL",
"shipNodeName": "Testing Central TimeZone",
"status": "ACTIVE",
"timeZone": "MST",
"distributorSupportedServices": [
"TWO_DAY_DELIVERY"
],
"customNodeId": "1121222332",
"postalAddress": {
"addressLine1": "dffdf",
"city": "dfdfdfdf",
"state": "FL",
"country": "USA",
"postalCode": "32703"
},
"shippingDetails": [{
"twoDayShipping": [{
"carrierMethodName": "USPS",
"carrierMethodType": "GROUND"
}]
}]
},
{
"shipNode": "83262080191954945",
"nodeType": "PHYSICAL",
"shipNodeName": "werer",
"status": "ACTIVE",
"timeZone": "PST",
"distributorSupportedServices": [
"TWO_DAY_DELIVERY"
],
"customNodeId": "11212223",
"postalAddress": {
"addressLine1": "A-2104, Hill Cress",
"city": "Sunnyvelle",
"state": "IA",
"country": "USA",
"postalCode": "56006"
},
"shippingDetails": [{
"twoDayShipping": [{
"carrierMethodName": "USPS",
"carrierMethodType": "GROUND"
}]
}]
}
]
|
SKU to Template Association
|
Use Case |
Sample SKU-Node-Template Association request |
|
Api Uri |
https://marketplace.walmartapis.com/v3/feeds?feedType=SKU_TEMPLATE_MAP |
|
Http Method |
POST |
|
Query Parameters |
feedType=SKU_TEMPLATE_MAP |
|
Request Payload
|
{
"ItemFeedHeader": {
"sellingChannel": "precisedelivery",
"locale": "en",
"version": "1.0"
},
"Item": [
{
"PreciseDelivery": {
"sku": "sku1",
"actionType": "Add",
"shippingTemplateId": "8374652987346572",
"fulfillmentCenterId": "83746529874858434"
}
},
{
"PreciseDelivery": {
"sku": "sku2",
"shippingTemplateId": "8374652987346572",
"actionType": "Remove",
"fulfillmentCenterId": "83746529874858434"
}
}
]
}
|
|
Response Payload |
{
"feedId": "F129C19240844B97A3C6AD8F1A2C4997@AU8BAQA",
"additionalAttributes": null,
"errors": null
}
|
Sample Deliverr Request
|
Use Case |
Deliverr Feed Request API |
|
Api Uri |
https://marketplace.walmartapis.com/v3/feeds?feedType=SHIPPING_OVERRIDES |
|
Http Method |
POST |
|
Query Parameters |
feedType=SHIPPING_OVERRIDES |
|
Request Payload
|
{
"ItemFeedHeader": {
"version": "1.0",
"sellingChannel": "overrides",
"locale": "en"
},
"Item": [
{
"Override": {
"sku": "sku1",
"actionType": "UPDATE",
"fulfilmentCenterId": "83746529874858430",
"ShippingOverrides": [
{
"ShippingOverride": {
"shipMethod": "EXPEDITED",
"actionType": "CREATE",
"transit": 2,
"northeastRegionStates": "NY,NJ",
"midwestRegionStates": "IA",
"westRegionStates": "CA",
"southRegionStates": "FL,AL"
}
},
{
"ShippingOverride": {
"shipMethod": "STANDARD",
"actionType": "CREATE",
"transit": 3,
"shipPrice": 10.55,
"northeastRegionStates": "NY,NJ",
"midwestRegionStates": "IA",
"westRegionStates": "CA",
"southRegionStates": "FL,AL"
}
},
{
"ShippingOverride": {
"shipMethod": "STANDARD",
"actionType": "CREATE",
"transit": 4,
"shipPrice": 10.55,
"northeastRegionStates": "NY,NJ",
"midwestRegionStates": "IA",
"westRegionStates": "CA",
"southRegionStates": "FL,AL"
}
},
{
"ShippingOverride": {
"shipMethod": "VALUE",
"actionType": "CREATE",
"transit": 9,
"nationWide": "48_STATES_STREET"
}
}
]
}
}
]
}
|
|
Response Payload |
{
"feedId": "F129C19240844B97A3C6AD8F1A2C4997@AU8BAQA",
"additionalAttributes": null,
"errors": null
}
|
Error Responses
Error Responses will follow Standard Walmart Error Format as Mentioned in the Developer Portal here
| Scenario | HTTP Code | Error Response |
| General Error While Creating Shipping Template | 400 Bad Request |
{
"errors": [
{
"code": "INVALID_REQUEST.GMP_SHIPPING_TEMPLATE_API",
"field": "transitTime",
"description": "The transit time for the shipping method VALUE must be one of [6, 7].",
"info": "Invalid transit time.",
"severity": "ERROR",
"category": "DATA"
},
{
"code": "INVALID_REQUEST.GMP_SHIPPING_TEMPLATE_API",
"field": "shippingMethods",
"description": "The VALUE shipping method supports only 48 state street.",
"info": "The VALUE shipping method supports only 48 state street.",
"severity": "ERROR",
"category": "DATA"
},
{
"code": "INVALID_REQUEST.GMP_SHIPPING_TEMPLATE_API",
"field": "name",
"description": "The shipping template with the name 'Custom Template 223' already exists.",
"info": "Invalid shipping template name.",
"severity": "ERROR",
"category": "DATA"
},
{
"code": "INVALID_REQUEST.GMP_SHIPPING_TEMPLATE_API",
"field": "type",
"description": "No new shipping templates can be created. Max 20 templates are allowed.",
"info": "No new shipping templates can be created.",
"severity": "ERROR",
"category": "DATA"
}
]
}
|
Reports
Shipping Configuration Report
Sample CSV format -
Shipping Program Report
Sample CSV format - 