All URIs are relative to https://marketplace.walmartapis.com, except if the operation defines another base path.
Method | HTTP request | Description |
---|---|---|
getAllFeedStatuses() | GET /v3/feeds | All feed statuses |
getFeedErrorReport() | GET /v3/feeds/{feedId}/errorReport | Get Feed Error Report |
getFeedItemStatus() | GET /v3/feeds/{feedId} | Feed item status |
getAllFeedStatuses($feedId, $offset, $limit): \Walmart\Models\MP\US\Feeds\FeedRecordResponse
All feed statuses
Returns the feed statuses for all the specified Feed IDs.
<?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)->feeds();
$feedId = 'feedId_example'; // string | A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: '...3456@789...' must be entered in the URL as '...3456%40789).
$offset = '0'; // string | The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
$limit = '50'; // string | The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
try {
$result = $api->getAllFeedStatuses($feedId, $offset, $limit);
print_r($result);
} catch (Exception $e) {
echo "Exception when calling FeedsApi->getAllFeedStatuses: {$e->getMessage()}\n";
}
Name | Type | Description | Notes |
---|---|---|---|
feedId | string | A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: '...3456@789...' must be entered in the URL as '...3456%40789). | [optional] |
offset | string | The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true. | [optional] [default to '0'] |
limit | string | The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true. | [optional] [default to '50'] |
\Walmart\Models\MP\US\Feeds\FeedRecordResponse
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]
getFeedErrorReport($feedId, $feedType): mixed
Get Feed Error Report
Get Feed Error Report API allows you to download a detailed error report for a submitted feed. Currently the API supports error report download for the following feeds: * FITMENT_ACES * FITMENT_PIES This API returns a zipped .csv file, which contains line item level detailed error messages. For details and a sample, please refer to the guide section link below.
<?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)->feeds();
$feedId = 'feedId_example'; // string | Feed Id of the feed
$feedType = 'feedType_example'; // string | Feed type for which Error Report needs to be downloaded
try {
$result = $api->getFeedErrorReport($feedId, $feedType);
print_r($result);
} catch (Exception $e) {
echo "Exception when calling FeedsApi->getFeedErrorReport: {$e->getMessage()}\n";
}
Name | Type | Description | Notes |
---|---|---|---|
feedId | string | Feed Id of the feed | |
feedType | string | Feed type for which Error Report needs to be downloaded |
mixed
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]
getFeedItemStatus($feedId, $includeDetails, $offset, $limit): \Walmart\Models\MP\US\Feeds\PartnerFeedResponse
Feed item status
Returns the feed and item status for a specified Feed ID.
<?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)->feeds();
$feedId = 'feedId_example'; // string | A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: '...3456@789...' must be entered in the URL as '...3456%40789)
$includeDetails = 'false'; // string | Includes details of each entity in the feed.
$offset = '0'; // string | The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true.
$limit = '50'; // string | The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
try {
$result = $api->getFeedItemStatus($feedId, $includeDetails, $offset, $limit);
print_r($result);
} catch (Exception $e) {
echo "Exception when calling FeedsApi->getFeedItemStatus: {$e->getMessage()}\n";
}
Name | Type | Description | Notes |
---|---|---|---|
feedId | string | A unique ID returned from the Bulk Upload API, used for tracking the Feed File. Special characters must be escaped. (e.g., feedId: '...3456@789...' must be entered in the URL as '...3456%40789) | |
includeDetails | string | Includes details of each entity in the feed. | [optional] [default to 'false'] |
offset | string | The object response to start with, where 0 is the first entity that can be requested. It can only be used when includeDetails is set to true. | [optional] [default to '0'] |
limit | string | The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true. | [optional] [default to '50'] |
\Walmart\Models\MP\US\Feeds\PartnerFeedResponse
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]