Update Simplified Shipping Settings configurations
Sellers and approved Solution Providers can use this API endpoint to update account level Simplified Shipping Settings configurations for all fulfillment centers. You can update settings within the accountConfigs
object to modify configurations, such as:
- The
carriers
to change the carriers that are available for your items. - The
regions
to change the regions that the item is available in.
The endpoint returns the updated version of the simplifiedShippingSettings
map of the Simplified Shipping Settings configurations.
Throttling
Request limits: 25 calls per minute per seller. You may receive an HTTP 429 error if you exceed this limit. You can refer to the Throttling guide to learn more about the throttling guidelines.
Request example
The request requires authentication with an API token (WM_SEC.ACCESS_TOKEN), consumer ID, and channel type. These credentials ensure that only authorized sellers and approved Solution Providers can update account level carrier configurations.
The endpoint https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account
specifies that you are making a request to update existing account level carrier settings applicable to all fulfillment centers.
accountConfigs
: The carrier and region configurations for the account. Review the example response to understand what settings are in the accountConfigs
object.
Encoding for spaces: This request requires encoding if spaces are present in the query. The endpoint uses %20 for spaces.
Before you use the example code, replace the example access token and correlation ID (a randomly generated GUID used to track and debug issues) with your own values.
curl -X 'PUT' \ 'https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account' \ -H 'accept: application/json' \ -H ‘WM_SEC.ACCESS_TOKEN: eyABCDEFGHI123456789…’ \ -H ‘WM_QOS.CORRELATION_ID: AAAAAAAA-1111-BBBB-2222-CCCC3333DDDD’ \ -H 'WM_SVC.NAME: Walmart Service Name' \ -H 'Content-Type: application/json' \ -d '{ "simplifiedShippingSettings": { "accountConfigs": { "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_HOME_DELIVERY" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State", "subRegions": [ { "subRegionCode": "WE", "states": [ { "stateCode": "NV", "stateName": "Nevada" }, { "stateCode": "CA", "stateName": "California" } ] } ] } ], "addressTypes": [ "STREET" ] }, { "regions": [ { "regionCode": "H", "regionName": "AK and HI" } ], "addressTypes": [ "STREET" ] } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_OVERNIGHT" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionCode": "P", "regionName": "US Protectorate 6s" } ], "addressTypes": [ "PO_BOX", "STREET" ] } ] } ] } }
}'
Response example
This API endpoint responds with a body response that contains an accountConfigs
object, shippingPriority
string, migrateEligibleOffers
boolean, and a carrierConfig
array of objects.
shippingPriority
: The preferred shipping speeds and costs for the specific configuration. For example, FASTEST.
migrateEligibleOffers
: Boolean flag that controls if the API will migrate all eligible offers for the seller. For example, false.
carrierConfig
: Array of objects with carrier settings for each region. Review the example request to understand what settings are in the carrierConfig
array of objects.
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateEligibleOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_EXPRESS" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State", "subRegions": [ { "subRegionCode": "WE", "states": [ { "stateCode": "NV", "stateName": "Nevada" }, { "stateCode": "CA", "stateName": "California" } ] } ] } ], "addressTypes": [ "STREET" ] }, { "regions": [ { "regionCode": "H", "regionName": "AK and HI" } ], "addressTypes": [ "STREET" ] } ] }, { "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_OVERNIGHT" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" }, { "regionCode": "P", "regionName": "US Protectorate 6s" } ], "addressTypes": [ "PO_BOX", "STREET" ] } ] } ] } }
}
Next steps
This API overview guide shows you how to update existing account-level carrier settings applicable to all fulfillment centers with only the required parameters. You can refer to the full Reference guide to learn how to use the optional parameters.
Updated 1 day ago