Walmart\Apis\MP\US\SettingsApi

All URIs are relative to https://marketplace.walmartapis.com, except if the operation defines another base path.

Method	HTTP request	Description
associate3PFulfillmentCenter()	POST /v3/settings/shipping/3plshipnodes	Third party fulfillment center association
createFulfillmentCenter()	POST /v3/settings/shipping/shipnodes	Create fulfillment center
createShippingTemplates()	POST /v3/settings/shipping/templates	Create Shipping Templates
deleteShippingTemplateDetails()	DELETE /v3/settings/shipping/templates/{templateId}	Delete Shipping Template
get3PFulfillmentProviders()	GET /v3/settings/shipping/3plproviders	Get all third party fulfillment providers
getAllFulfillmentCenters()	GET /v3/settings/shipping/shipnodes	Get all fulfillment centers
getAllShippingTemplates()	GET /v3/settings/shipping/templates	Get All Shipping Templates
getCarrierMethods()	GET /v3/settings/shipping/carriers	Get carrier methods
getCoverageForFulfillmentCenters()	GET /v3/settings/shipping/shipnodes/coverage	Get coverage for fulfillment centers
getPartnerConfigurations()	GET /v3/settings/partnerprofile	Get Partner Configurations
getShippingConfigurations()	GET /v3/settings/shippingprofile	Get Shipping Configurations
getShippingTemplateActivationStatus()	GET /v3/settings/shipping/templates/activationStatus	Get Shipping Template Activation Status
getShippingTemplateDetails()	GET /v3/settings/shipping/templates/{templateId}	Get Shipping Template Details
updateFulfillmentCenter()	PUT /v3/settings/shipping/shipnodes	Update fulfillment center
updateShippingTemplates()	PUT /v3/settings/shipping/templates/{templateId}	Update Shipping Templates

`associate3PFulfillmentCenter()`

associate3PFulfillmentCenter($updateFulfillmentCenterRequest): \Walmart\Models\MP\US\Settings\ThirdPartyShipNode1[]

Third party fulfillment center association

This API associate a third party fulfillment center with Seller.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$updateFulfillmentCenterRequest = {"shipNodeHeader":{"version":"1.2"},"shipNode":[{"shipNode":"99351656957153281","status":"ACTIVE"}]}; // \Walmart\Models\MP\US\Settings\UpdateFulfillmentCenterRequest | Request fields

try {
    $result = $api->associate3PFulfillmentCenter($updateFulfillmentCenterRequest);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->associate3PFulfillmentCenter: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
updateFulfillmentCenterRequest	\Walmart\Models\MP\US\Settings\UpdateFulfillmentCenterRequest	Request fields

Return type

\Walmart\Models\MP\US\Settings\ThirdPartyShipNode1[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createFulfillmentCenter()`

createFulfillmentCenter($createFulfillmentCenterRequest): \Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate[]

Create fulfillment center

This API creates a fulfillment center.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$createFulfillmentCenterRequest = {"shipNodeHeader":{"version":"1.2"},"shipNode":[{"shipNodeName":"my distrubutor786","status":"ACTIVE","timeZone":"PST","distributorSupportedServices":["TWO_DAY_DELIVERY"],"customNodeId":"92hb1234","postalAddress":{"addressLine1":"36 CALIFORNIA SAA233","city":"SC GABRIEL22","state":"CA","country":"USA","postalCode":"90100"},"shippingDetails":[{"twoDayShipping":[{"carrierMethodName":"FEDEX","carrierMethodType":"GROUND"}]}]}]}; // \Walmart\Models\MP\US\Settings\CreateFulfillmentCenterRequest | Request fields

try {
    $result = $api->createFulfillmentCenter($createFulfillmentCenterRequest);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->createFulfillmentCenter: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
createFulfillmentCenterRequest	\Walmart\Models\MP\US\Settings\CreateFulfillmentCenterRequest	Request fields

Return type

\Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createShippingTemplates()`

createShippingTemplates($createShippingTemplateRequest): \Walmart\Models\MP\US\Settings\ShippingTemplate

Create Shipping Templates

Create a new shipping template

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$createShippingTemplateRequest = {"name":"Next Day servc","type":"CUSTOM","rateModelType":"TIERED_PRICING","status":"ACTIVE","shippingMethods":[{"shipMethod":"VALUE","status":"ACTIVE","configurations":[{"regions":[{"regionCode":"C","regionName":"48 State"}],"addressTypes":["STREET"],"transitTime":6,"tieredShippingCharges":[{"minLimit":0,"maxLimit":-1,"shipCharge":{"amount":0,"currency":"USD"}}]}]},{"shipMethod":"STANDARD","status":"ACTIVE","configurations":[{"regions":[{"regionCode":"C","regionName":"48 State","subRegions":[{"subRegionCode":"MW","subRegionName":"MW","states":[{"stateCode":"SD","stateName":"South Dakota","stateSubregions":[{"stateSubregionCode":"SD2","stateSubregionName":"SD_WEST"},{"stateSubregionCode":"SD1","stateSubregionName":"SD_EAST"}]}]}]}],"addressTypes":["STREET"],"transitTime":3,"tieredShippingCharges":[{"minLimit":10.06,"maxLimit":-1,"shipCharge":{"amount":2,"currency":"USD"}},{"minLimit":0,"maxLimit":10.05,"shipCharge":{"amount":1,"currency":"USD"}}]}]}]}; // \Walmart\Models\MP\US\Settings\CreateShippingTemplateRequest | Request fields

try {
    $result = $api->createShippingTemplates($createShippingTemplateRequest);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->createShippingTemplates: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
createShippingTemplateRequest	\Walmart\Models\MP\US\Settings\CreateShippingTemplateRequest	Request fields

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplate

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteShippingTemplateDetails()`

deleteShippingTemplateDetails($templateId): \Walmart\Models\MP\US\Settings\ShippingTemplateId

Delete Shipping Template

Delete Existing Shipping Template. DEFAULT templates cannot be deleted. 3PL partners cannot delete templates created by Sellers.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$templateId = 'templateId_example'; // string | Shipping Template ID of the template to be deleted

try {
    $result = $api->deleteShippingTemplateDetails($templateId);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->deleteShippingTemplateDetails: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
templateId	string	Shipping Template ID of the template to be deleted

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplateId

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`get3PFulfillmentProviders()`

get3PFulfillmentProviders(): \Walmart\Models\MP\US\Settings\ThirdPartyShipNode2[]

Get all third party fulfillment providers

Get a list of all third party fulfillment providers.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->get3PFulfillmentProviders();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->get3PFulfillmentProviders: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\ThirdPartyShipNode2[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getAllFulfillmentCenters()`

getAllFulfillmentCenters($includeCalendarDayConfiguration): \Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate[]

Get all fulfillment centers

This API provides a list of all the fulfillment centers

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$includeCalendarDayConfiguration = false; // bool | Flag to specify if calendarDayConfiguration block will be included in the response. Allowed values are true or false.

try {
    $result = $api->getAllFulfillmentCenters($includeCalendarDayConfiguration);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getAllFulfillmentCenters: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
includeCalendarDayConfiguration	bool	Flag to specify if calendarDayConfiguration block will be included in the response. Allowed values are true or false.	[optional] [default to false]

Return type

\Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getAllShippingTemplates()`

getAllShippingTemplates(): \Walmart\Models\MP\US\Settings\ShippingTemplatesSummary

Get All Shipping Templates

Get all the shipping templates for a Seller. All template types viz. CUSTOM, DEFAULT and 3PL-specific (eg. DELIVERR) can be retrieved through this API.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getAllShippingTemplates();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getAllShippingTemplates: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplatesSummary

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCarrierMethods()`

getCarrierMethods(): \Walmart\Models\MP\US\Settings\CarrierDetail2[]

Get carrier methods

Gets the available carrier methods

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getCarrierMethods();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getCarrierMethods: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\CarrierDetail2[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getCoverageForFulfillmentCenters()`

getCoverageForFulfillmentCenters(): \Walmart\Models\MP\US\Settings\FulfillmentCenterCoverageDetail[]

Get coverage for fulfillment centers

This API provides the list of all fullfillment centers for the seller and their coverage areas defined by Walmart based on the address

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getCoverageForFulfillmentCenters();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getCoverageForFulfillmentCenters: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\FulfillmentCenterCoverageDetail[]

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getPartnerConfigurations()`

getPartnerConfigurations(): \Walmart\Models\MP\US\Settings\PartnerConfigsResponseDTO

Get Partner Configurations

This API can be used to retrieve partner configurations like Seller Account & feed throttling values configured for seller.

The Feed Configuration block in the response shows the seller specific throttling configuration based on the tier of seller. If a new Seller is not assigned any tier, the block will be empty.

Please note that the default throttling configuration across Walmart and the API Throttling Response Headers can be found here

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getPartnerConfigurations();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getPartnerConfigurations: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\PartnerConfigsResponseDTO

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getShippingConfigurations()`

getShippingConfigurations(): \Walmart\Models\MP\US\Settings\ShippingConfigsResponseDTO

Get Shipping Configurations

This API can be used to retrieve shipping configurations like Lag Time configured for seller.It returns lag time for exception categories that were configured for the Seller through Request Lag Time Exceptions process.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getShippingConfigurations();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getShippingConfigurations: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\ShippingConfigsResponseDTO

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getShippingTemplateActivationStatus()`

getShippingTemplateActivationStatus(): \Walmart\Models\MP\US\Settings\ShippingTemplateActivationStatus

Get Shipping Template Activation Status

This api can be used to get the Activation Status of the Shipping Templates, which can be set through Walmart Seller Center. This activation status is not the same as the "status:ACTIVE/INACTIVE" of each shipping template.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();


try {
    $result = $api->getShippingTemplateActivationStatus();
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getShippingTemplateActivationStatus: {$e->getMessage()}\n";
}

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplateActivationStatus

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getShippingTemplateDetails()`

getShippingTemplateDetails($templateId): \Walmart\Models\MP\US\Settings\ShippingTemplate

Get Shipping Template Details

Get Shipping Template Details. Details of CUSTOM, DEFAULT and 3PL-specific (eg. DELIVERR) templates can be retrieved through this API. 3PL will be able to see details of only 3PL-specific templates.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$templateId = 'templateId_example'; // string | templateId

try {
    $result = $api->getShippingTemplateDetails($templateId);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->getShippingTemplateDetails: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
templateId	string	templateId

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplate

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateFulfillmentCenter()`

updateFulfillmentCenter($updateFulfillmentCenterRequest): \Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate

Update fulfillment center

This API enables or disables a fulfillment center.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$updateFulfillmentCenterRequest = {"shipNodeHeader":{"version":"1.2"},"shipNode":{"shipNode":"84955660770217985","shipNodeName":"Seller test-distributor","status":"ACTIVE","timeZone":"PST","distributorSupportedServices":["TWO_DAY_DELIVERY"],"customNodeId":"91ab1234","postalAddress":{"addressLine1":"111 CALIFORNIA SA","city":"SC GABRIEL","state":"CA","country":"USA","postalCode":"90706"},"shippingDetails":[{"twoDayShipping":[{"carrierMethodName":"FEDEX","carrierMethodType":"GROUND"}]}]}}; // \Walmart\Models\MP\US\Settings\UpdateFulfillmentCenterRequest | Request fields

try {
    $result = $api->updateFulfillmentCenter($updateFulfillmentCenterRequest);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->updateFulfillmentCenter: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
updateFulfillmentCenterRequest	\Walmart\Models\MP\US\Settings\UpdateFulfillmentCenterRequest	Request fields

Return type

\Walmart\Models\MP\US\Settings\ShipNodeResponseUpdate

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateShippingTemplates()`

updateShippingTemplates($templateId, $updateShippingTemplateRequest): \Walmart\Models\MP\US\Settings\ShippingTemplate

Update Shipping Templates

Update existing Shipping Template.

Example

<?php
use Walmart\Configuration;
use Walmart\Enums\Country;
use Walmart\Walmart;

require_once __DIR__ . '/vendor/autoload.php';

$config = new Walmart\Configuration([
    'clientId' => 'CLIENT_ID',          // May not be necessary for all endpoints, particularly outside the US
    'clientSecret' => 'CLIENT_SECRET',  // Ditto above
    'country' => Country::US,           // Default Country::US if not set
]);

$api = Walmart::marketplace($config)->settings();

$templateId = 'templateId_example'; // string | templateId
$updateShippingTemplateRequest = {"name":"Next Day servc test","type":"CUSTOM","rateModelType":"TIERED_PRICING","status":"ACTIVE","shippingMethods":[{"shipMethod":"VALUE","status":"ACTIVE","configurations":[{"regions":[{"regionCode":"C","regionName":"48 State"}],"addressTypes":["STREET"],"transitTime":6,"tieredShippingCharges":[{"minLimit":0,"maxLimit":-1,"shipCharge":{"amount":0,"currency":"USD"}}]}]},{"shipMethod":"STANDARD","status":"ACTIVE","configurations":[{"regions":[{"regionCode":"C","regionName":"48 State","subRegions":[{"subRegionCode":"MW","subRegionName":"MW","states":[{"stateCode":"SD","stateName":"South Dakota","stateSubregions":[{"stateSubregionCode":"SD2","stateSubregionName":"SD_WEST"},{"stateSubregionCode":"SD1","stateSubregionName":"SD_EAST"}]}]}]}],"addressTypes":["STREET"],"transitTime":3,"tieredShippingCharges":[{"minLimit":10.06,"maxLimit":-1,"shipCharge":{"amount":2,"currency":"USD"}},{"minLimit":0,"maxLimit":10.05,"shipCharge":{"amount":1,"currency":"USD"}}]}]}]}; // \Walmart\Models\MP\US\Settings\UpdateShippingTemplateRequest | Request fields

try {
    $result = $api->updateShippingTemplates($templateId, $updateShippingTemplateRequest);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling SettingsApi->updateShippingTemplates: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
templateId	string	templateId
updateShippingTemplateRequest	\Walmart\Models\MP\US\Settings\UpdateShippingTemplateRequest	Request fields

Return type

\Walmart\Models\MP\US\Settings\ShippingTemplate

Authorization

This endpoint requires the following authorization methods:

accessToken: Header authentication with a Walmart access token, which is automatically generated using your Client ID and Client Secret. The token is valid for 15 minutes, and will be passed in the WM_SEC.ACCESS_TOKEN header

See the Authorization section of the README for more information.

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

SettingsApi.md

Latest commit

History

SettingsApi.md

File metadata and controls

Walmart\Apis\MP\US\SettingsApi

associate3PFulfillmentCenter()

Example

Parameters

Return type

Authorization

createFulfillmentCenter()

Example

Parameters

Return type

Authorization

createShippingTemplates()

Example

Parameters

Return type

Authorization

deleteShippingTemplateDetails()

Example

Parameters

Return type

Authorization

get3PFulfillmentProviders()

Example

Parameters

Return type

Authorization

getAllFulfillmentCenters()

Example

Parameters

Return type

Authorization

getAllShippingTemplates()

Example

Parameters

Return type

Authorization

getCarrierMethods()

Example

Parameters

Return type

Authorization

getCoverageForFulfillmentCenters()

Example

Parameters

Return type

Authorization

getPartnerConfigurations()

Example

Parameters

Return type

Authorization

getShippingConfigurations()

Example

Parameters

Return type

Authorization

getShippingTemplateActivationStatus()

Example

Parameters

Return type

Authorization

getShippingTemplateDetails()

Example

Parameters

Return type

Authorization

updateFulfillmentCenter()

Example

Parameters

Return type

Authorization

updateShippingTemplates()

Example

Parameters

`associate3PFulfillmentCenter()`

`createFulfillmentCenter()`

`createShippingTemplates()`

`deleteShippingTemplateDetails()`

`get3PFulfillmentProviders()`

`getAllFulfillmentCenters()`

`getAllShippingTemplates()`

`getCarrierMethods()`

`getCoverageForFulfillmentCenters()`

`getPartnerConfigurations()`

`getShippingConfigurations()`

`getShippingTemplateActivationStatus()`

`getShippingTemplateDetails()`

`updateFulfillmentCenter()`

`updateShippingTemplates()`