Create Simplified Shipping Settings
Overview
The Create Simplified Shipping Settings API enables sellers and solution providers to seamlessly onboard to Simplified Shipping Settings by creating a default shipping configuration. The default configuration covers the majority of your assortments in your fulfillment centers, applying automatically to eligible items, and eliminating any template-to-item mappings. You can add custom configurations for specific items or fulfillment centers with different shipping rules.
Function
Call this endpoint to create an account-level shipping rule for Simplified Shipping Settings. This rule applies to every fulfillment center in your network and specifies:
- Which carriers you want to use.
- The regions you want the carriers to cover.
- Your shipping priority: The fastest delivery or cost savings
Optionally, in the same call, you can direct Walmart to migrate any offers that qualify for Simplified Shipping Settings free shipping in the 48 contiguous US states, Alaska, Hawaii, Puerto Rico, Guam, American Samoa, US Virgin Islands, and the Northern Mariana Islands.
Endpoint
POST https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account
Sample request
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_EXPRESS" } ], "configurations": [ { "regions": [ { "regionName": "AK and HI", "regionCode": "H" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "USD" }, "chargePerWeight": { "amount": 5, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_3DAY_SELECT" } ], "configurations": [ { "regions": [ { "regionCode": "P", "regionName": "US Protectorates" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerWeight": { "amount": 0, "currency": "USD" } } } } ] } ] } }
}
'
Sample request 1 carrier configuration
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_GROUND" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] } ] } }
}
'
Sample request 2 carrier configuration
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "USPS", "carrierService": "USPS_PRIORITY_MAIL_EXPRESS" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerWeight": { "amount": 0, "currency": "USD" } } } } ] } ] } }
}
'
Sample request 3 invalid carrier name
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "test", "carrierService": "testService" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionName": "AK and HI", "regionCode": "H" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_GROUND_ECONOMY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerWeight": { "amount": 0, "currency": "USD" } } } } ] } ] } }
}
'
Sample request 4 shipping charge is empty
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionName": "AK and HI", "regionCode": "H" } ], "addressTypes": [ "STREET" ] } ] } ] } }
}
'
Sample request 5 valid subtype of shipping charge object not present
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionName": "AK and HI", "regionCode": "H" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING" } } ] } ] } }
}
'
Sample request 6 shipping charge amount cannot exceed 700
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionName": "AK and HI", "regionCode": "H" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 780, "currency": "USD" } } } } ] } ] } }
}
'
Sample request duplicate regions for same carrier is not allowed at account level
curl --request POST \ --url https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "carrierConfigs": [ { "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_GROUND" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } }, { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 10, "currency": "USD" }, "chargePerWeight": { "amount": 20, "currency": "USD" } } } } ] } ] } }
}
'
Modify your request
To successfully create settings, make the following modifications:
- Authentication: Include your token header (example header used elsewhere:
WM_SEC.ACCESS_TOKEN: <YourAccessToken>or use your agreed auth header). - Required headers: Include
WM_GLOBAL_VERSIONandWM_MARKETas shown. Always set Accept: application/json and Content-Type: application/json. - Payload validity: Copy-paste one of the sample JSON bodies above (exactly as supplied) into data or a file and reference it (--data @payload.json). Do not insert duplicate braces or syntax errors.
- Carrier/service validation. Ensure
carrierServicevalues are supported for the specifiedcarrierName. Unsupported combos can return an invalid carrier configuration error. - Coverage rules. If the selected carrier requires full state coverage, include all 48 states + DC or adjust carrier choices accordingly to avoid All 48 states + DC are not covered errors.
- No duplicate state codes. Make sure
stateCodevalues are unique. Duplicate state codes produce astateCodeserror. - Seller eligibility constraints: If your seller account has 3PL nodes, bundles, international nodes, or is enrolled in major applications, the request will be rejected. Remove unsupported configurations or contact support.
Example:
curl --request POST \ --url 'https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: us' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'WM_SEC.ACCESS_TOKEN: <YourAccessToken>' \ --data @create_simplified_shipping_payload.json 200 - Sample response
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_3DAY_SELECT" } ], "configurations": [ { "regions": [ { "regionCode": "P", "regionName": "US Protectorates" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_EXPRESS" } ], "configurations": [ { "regions": [ { "regionCode": "H", "regionName": "AK and HI" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "USD" }, "chargePerWeight": { "amount": 5, "currency": "USD" } } } } ] } ] } }
}
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_3DAY_SELECT" } ], "configurations": [ { "regions": [ { "regionCode": "P", "regionName": "US Protectorates" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerItem": { "amount": 0, "currency": "USD" } } } } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_EXPRESS" } ], "configurations": [ { "regions": [ { "regionCode": "H", "regionName": "AK and HI" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 2, "currency": "USD" }, "chargePerWeight": { "amount": 5, "currency": "USD" } } } } ] } ] } }
}
200 - Sample response duplicate state codes
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "stateCode", "description": "Duplicate stateCodes for: CT", "info": "Duplicate stateCodes for: CT", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response invalid carrier configs
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "carrierName", "description": "Provided carrier service is not valid.", "info": "Please provide a valid carrier service.", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response invalid coverage
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "carrierConfigs", "description": "The provided coverage for the given carrier service is not supported: USPS_PRIORITY_MAIL_EXPRESS", "info": "The provided coverage for the given carrier service is not supported: USPS_PRIORITY_MAIL_EXPRESS", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response invalid coverage 2
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "states/stateCode", "description": "All 48 states + DC are not covered at account level", "info": "All 48 states + DC are not covered at account level", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response invalid region combination
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "regionCode and regionName", "description": "Invalid region code: P and region name: US Protectorate 6s combination", "info": "Invalid region code: P and region name: US Protectorate 6s combination", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response settings already exist
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "simplifiedShippingSettings", "description": "Simplified Shipping Settings already exists at account level for seller: ", "info": "Simplified Shipping Settings already exists at account level for seller: ", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response 3PL node
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "sellerEligibility", "description": "We noticed you have 3PL fulfillment centers which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "info": "We noticed you have 3PL fulfillment centers which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response bundle items
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "sellerEligibility", "description": "Seller with Bundles: We noticed you have Bundle items which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later", "info": "Seller with Bundles: We noticed you have Bundle items which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response international nodes
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "sellerEligibility", "description": "We noticed you have international fulfillment centers which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "info": "We noticed you have international fulfillment centers which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response major appliances
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "sellerEligibility", "description": "We noticed you are enabled for Major Appliances program which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "info": "We noticed you are enabled for Major Appliances program which Simplified Shipping Settings currently do not support. We are working on bringing that support in. Please check back later.", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response invalid carrier name
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "carrierName", "description": "Invalid Carrier Name", "info": "Invalid Carrier Name", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response shipping charge object Is empty
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "shippingCharges", "description": "Shipping charge object cannot be empty", "info": "Shipping charge object cannot be empty", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response valid subtype of shipping charge object not present
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "shippingCharges", "description": "Provide the shipping charges in perShippingCharges", "info": "Provide the shipping charges in perShippingCharges", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response shipping charge amount cannot exceed 700
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "perShippingCharge", "description": "Shipping charge amount can't exceed the max allowed limit 700", "info": "Shipping charge amount can't exceed the max allowed limit 700", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
200 - Sample response duplicate regions not allowed at account level
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.INVALID_REQUEST", "field": "shippingCharges", "description": "Duplicate regions are not allowed at account Level for carrier and node", "info": "Duplicate regions are not allowed at account Level for carrier and node", "severity": "ERROR", "category": "DATA", "causes": [], "errorIdentifiers": {} } ]
}
Result
- Success: Returns a
simplifiedShippingSettingsobject reflecting account-level settings (carriers, configurations, regions, address types, shipping priority, migration flags). This setting become the global default for shipping unless overridden by fulfillment center level configurations. - Failure / Validation errors: The response includes any errors array describing the problem and the fields to fix.
Next steps
After you create your Simplified Shipping Settings configuration, use the Orders Management API to retrieve released orders and shipping recommendations:
- Get all orders:
GET https://marketplace.walmartapis.com/v3/orders - Get all released orders:
GET https://marketplace.walmartapis.com/v3/orders/released - Get a single order:
GET https://marketplace.walmartapis.com/v3/orders/{purchaseOrderId}
Updated 12 days ago
