Walmart\Apis\MP\US\ItemsApi

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

Method	HTTP request	Description
getAllItems()	GET /v3/items	All items
getAnItem()	GET /v3/items/{id}	An item
getCatalogSearch()	POST /v3/items/catalog/search	Catalog Search
getCountByStatus()	GET /v3/items/count	Get items count by status
getItemAssociations()	POST /v3/items/associations	Get Item Associations
getSearchResult()	GET /v3/items/walmart/search	Item Search
getTaxonomyResponse()	GET /v3/items/taxonomy	Taxonomy
getVariantCount()	GET /v3/items/groups/count	Get item count by groups
itemBulkUploads()	POST /v3/feeds	Bulk Item Setup (Multiple)
retireAnItem()	DELETE /v3/items/{SKU}	Retire an item

`getAllItems()`

getAllItems($nextCursor, $sku, $offset, $limit, $lifecycleStatus, $publishedStatus, $variantGroupId): \Walmart\Models\MP\US\Items\ItemResponses

All items

Displays a list of all items by using either nextCursor or offset and limit query parameters

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)->items();

$nextCursor = '*'; // string | Used for pagination when more than 200 items are retrieved.nextCursor value received in response will be same for all subsequent page requests.
$sku = 'sku_example'; // string | An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item.
$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 = '20'; // 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.
$lifecycleStatus = 'lifecycleStatus_example'; // string | The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
$publishedStatus = 'publishedStatus_example'; // string | The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED.
$variantGroupId = 'variantGroupId_example'; // string | Variant Id to retrieve all items with the same variant id

try {
    $result = $api->getAllItems($nextCursor, $sku, $offset, $limit, $lifecycleStatus, $publishedStatus, $variantGroupId);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling ItemsApi->getAllItems: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
nextCursor	string	Used for pagination when more than 200 items are retrieved.nextCursor value received in response will be same for all subsequent page requests.	[optional] [default to '*']
sku	string	An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item.	[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 '20']
lifecycleStatus	string	The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.	[optional]
publishedStatus	string	The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED.	[optional]
variantGroupId	string	Variant Id to retrieve all items with the same variant id	[optional]

Return type

\Walmart\Models\MP\US\Items\ItemResponses

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]

`getAnItem()`

getAnItem($id, $productIdType): \Walmart\Models\MP\US\Items\ItemResponses

An item

Retrieves an item and displays the item details.

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)->items();

$id = 'id_example'; // string | Represents the seller-specified unique ID for each item. Takes SKU code by default. If you require more specific item codes, such as GTIN, UPC, ISBN, EAN, or ITEM_ID, you need to use the productIdType query parameter and specify the desired code e.g. productIdType=GTIN.
$productIdType = 'productIdType_example'; // string | Item code type specifier allows to filter by specific code type, (e.g. GTIN).

try {
    $result = $api->getAnItem($id, $productIdType);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling ItemsApi->getAnItem: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
id	string	Represents the seller-specified unique ID for each item. Takes SKU code by default. If you require more specific item codes, such as GTIN, UPC, ISBN, EAN, or ITEM_ID, you need to use the productIdType query parameter and specify the desired code e.g. productIdType=GTIN.
productIdType	string	Item code type specifier allows to filter by specific code type, (e.g. GTIN).

Return type

\Walmart\Models\MP\US\Items\ItemResponses

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]

`getCatalogSearch()`

getCatalogSearch($itemCatalogSearchPayload, $page, $limit, $nextCursor): \Walmart\Models\MP\US\Items\ItemCatalogResponses

Catalog Search

Get Catalog Search Result

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)->items();

$itemCatalogSearchPayload = new \Walmart\Models\MP\US\Items\ItemCatalogSearchPayload(); // \Walmart\Models\MP\US\Items\ItemCatalogSearchPayload | Request fields
$page = 0; // int | number of page
$limit = 100; // int | number of items
$nextCursor = 'nextCursor_example'; // string | nextCursor

try {
    $result = $api->getCatalogSearch($itemCatalogSearchPayload, $page, $limit, $nextCursor);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling ItemsApi->getCatalogSearch: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
itemCatalogSearchPayload	\Walmart\Models\MP\US\Items\ItemCatalogSearchPayload	Request fields
page	int	number of page	[optional] [default to 0]
limit	int	number of items	[optional] [default to 100]
nextCursor	string	nextCursor	[optional]

Return type

\Walmart\Models\MP\US\Items\ItemCatalogResponses

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]

`getCountByStatus()`

getCountByStatus($status): string

Get items count by status

Get total count of items based on status

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)->items();

$status = 'status_example'; // string | Status of Item

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

Parameters

Name	Type	Description	Notes
status	string	Status of Item	[optional]

Return type

string

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]

`getItemAssociations()`

getItemAssociations($itemsAssociationsResponseDTO): \Walmart\Models\MP\US\Items\ItemsAssociationsResponseDTO

Get Item Associations

Get Item Associations API allows you to retrieve shippingTemplate and shipNode associated with the provided items.

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)->items();

$itemsAssociationsResponseDTO = {"items":[{"sku":"RG-IRAE-79VD"},{"sku":"AC73891"}]}; // \Walmart\Models\MP\US\Items\ItemsAssociationsResponseDTO | Request fields

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

Parameters

Name	Type	Description	Notes
itemsAssociationsResponseDTO	\Walmart\Models\MP\US\Items\ItemsAssociationsResponseDTO	Request fields

Return type

\Walmart\Models\MP\US\Items\ItemsAssociationsResponseDTO

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]

`getSearchResult()`

getSearchResult($query, $upc, $gtin): \Walmart\Models\MP\US\Items\ItemSearch

Item Search

The Item Search API allows you to query the Walmart.com global product catalog by item keyword, UPC or GTIN. You can review all item information provided in the response, so you can decide whether or not you want to sell this item. You must specify at least one query parameter, either: 'query', 'gtin', or 'upc'. If there are more than one item in the catalog, the search returns the first 20 items in the response. Additionally, you can use the information provided in the 'relatedQueries' response parameter to run a new search for similar items.

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)->items();

$query = ''; // string | Specifies a keyword search as a String.
$upc = ''; // string | Specifies a Universal Product Code (UPC) search. UPC must be 12 digits.
$gtin = ''; // string | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits.

try {
    $result = $api->getSearchResult($query, $upc, $gtin);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling ItemsApi->getSearchResult: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
query	string	Specifies a keyword search as a String.	[optional] [default to '']
upc	string	Specifies a Universal Product Code (UPC) search. UPC must be 12 digits.	[optional] [default to '']
gtin	string	Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits.	[optional] [default to '']

Return type

\Walmart\Models\MP\US\Items\ItemSearch

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]

`getTaxonomyResponse()`

getTaxonomyResponse(): \Walmart\Models\MP\US\Items\TaxonomyResponseDTO

Taxonomy

The Taxonomy API exposes the category taxonomy that Walmart.com uses to categorize items. It describes the Departments, Categories, and Subcategories levels available on Walmart.com. You can specify the exact category as a parameter when using any of the following APIs: - Search- Data feeds- Special feeds, to includePre-order, Best Sellers, Rollbacks, Clearance, and Special Buys For example, you can restrict the Search API to search within a category by supplying the ID through the taxonomy. Similarly, you can use the Feed API to download category-specific feeds by specifying a category ID.

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)->items();


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

Parameters

This endpoint does not need any parameter.

Return type

\Walmart\Models\MP\US\Items\TaxonomyResponseDTO

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]

`getVariantCount()`

getVariantCount($variantGroupId): \Walmart\Models\MP\US\Items\VariantCountResponses

Get item count by groups

Get total count of items based on variant group information

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)->items();

$variantGroupId = 'variantGroupId_example'; // string | Variant Id to retrieve

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

Parameters

Name	Type	Description	Notes
variantGroupId	string	Variant Id to retrieve	[optional]

Return type

\Walmart\Models\MP\US\Items\VariantCountResponses

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]

`itemBulkUploads()`

itemBulkUploads($feedType, $file): \Walmart\Models\MP\US\Items\FeedId

Bulk Item Setup (Multiple)

Use this API for initial item setup and maintenance. This API updates items in bulk. You can update 10,000 items at once; updates with more than 10,000 items are not supported. Keep feed sizes below 10 MB, except for FITMENT_ACES and FITMENT_PIES, to ensure optimal feed processing time. For FITMENT_PIES and FITMENT_ACES feeds, files upto 25 MB are supported. You can use the Bulk Item Setup API for any of the following item spec versions, just specify the corresponding feed type as a query parameter. * Item spec version 4.8 feed type: MP_ITEM * WFS Item spec version 4.3 feed type: MP_WFS_ITEM * WFS Maintenance spec version 4.8 feed type: MP_MAINTENANCE * Set up item by match 4.1 feed type: MP_ITEM_MATCH * Convert an existing item to WFS 4.5 feed type : OMNI_WFS * For Fitment feed type FITMENT_ACES and FITMENT_PIES, zip file needs to be added in the request body. While uploading the fitment feeds, it is mandatory to add boundary parameter in Content-Type header. For example, Content-Type: multipart/form-data;boundary="----custom boundary". Without a boundary parameter, fitment feeds will fail to process. For details refer to the guide link below

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)->items();

$feedType = 'feedType_example'; // string | The feed Type
$file = "/path/to/file.txt"; // \SplFileObject

try {
    $result = $api->itemBulkUploads($feedType, $file);
    print_r($result);
} catch (Exception $e) {
    echo "Exception when calling ItemsApi->itemBulkUploads: {$e->getMessage()}\n";
}

Parameters

Name	Type	Description	Notes
feedType	string	The feed Type
file	\SplFileObject\SplFileObject

Return type

\Walmart\Models\MP\US\Items\FeedId

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]

`retireAnItem()`

retireAnItem($sKU): \Walmart\Models\MP\US\Items\ItemRetireResponse

Retire an item

Completely deactivates and un-publishes an item from the site.

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)->items();

$sKU = 'sKU_example'; // string | An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: ':', '/', '?', '#', '[', ']', '@', '!', '$', '&', \"'\", '(', ')', '*', '+', ',', ';', '=', as well as '%' itself. Other characters don't need to be encoded.

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

Parameters

Name	Type	Description	Notes
sKU	string	An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item. This will be used by the seller in the XSD file to refer to each item. Special characters in the sku needing encoding are: ':', '/', '?', '#', '[', ']', '@', '!', '$', '&', "'", '(', ')', '*', '+', ',', ';', '=', as well as '%' itself. Other characters don't need to be encoded.

Return type

\Walmart\Models\MP\US\Items\ItemRetireResponse

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

ItemsApi.md

Latest commit

History

ItemsApi.md

File metadata and controls

Walmart\Apis\MP\US\ItemsApi

getAllItems()

Example

Parameters

Return type

Authorization

getAnItem()

Example

Parameters

Return type

Authorization

getCatalogSearch()

Example

Parameters

Return type

Authorization

getCountByStatus()

Example

Parameters

Return type

Authorization

getItemAssociations()

Example

Parameters

Return type

Authorization

getSearchResult()

Example

Parameters

Return type

Authorization

getTaxonomyResponse()

Example

Parameters

Return type

Authorization

getVariantCount()

Example

Parameters

Return type

Authorization

itemBulkUploads()

Example

Parameters

Return type

Authorization

retireAnItem()

Example

Parameters

Return type

Authorization

`getAllItems()`

`getAnItem()`

`getCatalogSearch()`

`getCountByStatus()`

`getItemAssociations()`

`getSearchResult()`

`getTaxonomyResponse()`

`getVariantCount()`

`itemBulkUploads()`

`retireAnItem()`