Retrieve account configurations
Sellers and approved Solution Providers can use this API endpoint to retrieve account and fulfillment-center level configurations. The endpoint request utilizes the WM_SEC.ACCESS_TOKEN
to identify the account for which it retrieves configurations.
Throttling
Request limits: 50 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 retrieve account and fulfillment-center configurations.
The endpoint https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings
specifies that you are making a request to retrieve account and fulfillment center configurations for a specific seller account.
Encoding for spaces: This request requires encoding if spaces are present in the query. The endpoint uses %20 for spaces.
curl -X 'GET' \ 'https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings' \ -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' \
Response example
This API endpoint responds with a body response that contains an accountConfigs
object and a shipNodeConfigs
array of objects.
accountConfigs
: The carrier and region configurations for the account. Review the example response to understand what settings are in the accountConfigs
object.
shipNodeConfigs
: The list of all fulfillment-center IDs and configurations. Review the example response to understand what settings are in the shipNodeConfigs
array of objects.
{ "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "carrierConfigs": [ { "configurations": [ { "regions": [ { "regionCode": "P", "regionName": "US Protectorates" }, { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET", "PO_BOX" ] } ], "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_OVERNIGHT" } ] }, { "configurations": [ { "regions": [ { "regionCode": "H", "regionName": "AK and HI" } ], "addressTypes": [ "STREET" ] }, { "regions": [ { "regionCode": "C", "regionName": "48 State", "subRegions": [ { "subRegionCode": "WE", "states": [ { "stateCode": "NV", "stateName": "Nevada" }, { "stateCode": "CA", "stateName": "California" } ] } ] } ], "addressTypes": [ "STREET" ] } ], "carriers": [ { "carrierName": "Fedex", "carrierService": "FEDEX_EXPRESS" } ] } ] }, "shipNodeConfigs": [ { "shipNodes": [ "10900042937", "674599638306885633", "678136195315892225", "719075639194456065", "527428727372726273", "677756819709591553", "677756464221356033", "678134571868585985", "1234567616356" ], "isOverridden": false }, { "shipNodes": [ "1234567616357" ], "isOverridden": true, "carrierConfigs": [ { "configurations": [ { "regions": [ { "regionCode": "H", "regionName": "AK and HI" }, { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET", "PO_BOX" ] } ], "carriers": [ { "carrierName": "UPS", "carrierService": "UPS_GROUND" } ] } ] } ] }
}
Next steps
This API overview guide shows you how to retrieve account and fulfillment-center configurations for a specific seller account 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