You can set up your items for sale on Walmart.com with the Item Management API. Walmart classifies a product with its corresponding listing price information as an “item.” To make your items available for customers to purchase on Walmart.com the items must have their prices adjusted (optional), have inventory assigned, submitted and published.
Note: You need to complete seller registration, and get your API Key (Client Secret and Client ID) to start item integration.
To access your API Key, go to My Account. Select Login Type, choose Marketplace to get to API Keys.
Submit and publish processes
As a seller, you trigger the submit and publish processes in a single action. To add or change inventory requires a separate action.
Item submit process will parse and classify an item. This process typically takes a few hours. Item publish process requires Walmart systems to process items that have all necessary attributes confirmed. This typically takes a few hours.
Setup Item Variants with APIs
The Get item count by groups API allows you quickly view the item variant group IDs and counts of variant groups. With the data from this API, you can use it to filter Get All Items API, Get and item API, and Catalog Search API.
– Catalog Search: Add the additional query below to search for the variant Group ID with the Catalog Search API.
To learn about how to group items, see Variant Setup.
About item spec versions
The Marketplace APIs provides one item spec version: item spec v4.X. The legacy version v3.2 does not provide the enhanced setup workflow, and will be deprecated on October 1, 2022 . We recommend that you use the new optimized Item spec v4.X and new feed types when you do your initial setup with the Bulk item setup API. To learn more about item setup strategies and concepts, see SellerHelp Walmart. To learn how to set up items in bulk, see Add Items in Bulk.
Optimized Item setup and maintenance with Item Spec v4.X
Item spec v4.x optimizes the Walmart Global Data Model with new and improved existing attributes, and a faster, more efficient item setup and maintenance process. Improvements include:
– Better data definitions, modern attribute names, and precise attribute organization.
– Increased buyer search discoverability for your items.
– Increased variant grouping options that organize products in site navigation for better buyer visibility.
– New product and compliance attributes.
– Single setup process with one spec for combined Marketplace and WFS items.
– Automated product tax code assignment.
– Ability to set Sales restrictions for WFS-eligible items by state or zip code due to reasons: Commercial, or Illegal for sale.
About item spec versions #
The Marketplace APIs provides one item spec version: item spec v4.X. The legacy version v3.2 does not provide the enhanced setup workflow, and will be deprecated on March 31, 2024 . We recommend that you use the new optimized Item spec v4.X and new feed types when you do your initial setup with the Bulk item setup API. To learn more about item setup strategies and concepts, see SellerHelp Walmart. To learn how to set up items in bulk, see Add Items in Bulk.
Optimized Item setup and maintenance with Item Spec v4.X
Item spec v4.x optimizes the Walmart Global Data Model with new and improved existing attributes, and a faster, more efficient item setup and maintenance process. Improvements include:
Better data definitions, modern attribute names, and precise attribute organization.
Increased buyer search discoverability for your items.
Increased variant grouping options that organize products in site navigation for better buyer visibility.
New product and compliance attributes.
Single setup process with one spec for combined Marketplace and WFS items.
Automated product tax code assignment.
Ability to set Sales restrictions for WFS-eligible items by state or zip code due to reasons: Commercial, or Illegal for sale.
Item Spec 5.0
Walmart has launched new and updated requests in the Item Management API! Item Spec 5 now has Product Type Groups and Product Types aimed to improve content quality during item setup and maintenance through granular Product Type data models. This will create consistency between specs, style guides and content quality scoring.
The Key Benefits of this new release for Item Spec:
Focused attributes that drive item discoverability (Search, Shelving, Facets)
New and Enhanced API Experiences (Taxonomy API)
These new and updated requests include:
Walmart Product Taxonomy: Lets sellers understand Walmart’s product taxonomy. The multiple levels for organization, this functionality provides sellers the ability to find and select the product type that they will use to set up or maintain their items.
Item Setup and Maintenance by Product Type: Enables sellers to set up and maintain items by using the items’ product types. This intends to improve the content quality score.
High Level Overview – Item Setup Steps
Item Management Requests Available
Outlined below are details of the new APIs that are part of Item Spec 5.
Product Taxonomy Overview
Walmart’s product taxonomy is the system Walmart uses to
organize, classify, and group like items.
The taxonomy now extends to the product type level. Based
on the product type, each item will have distinct required attributes and
values. It is critical that sellers understand and use the established
taxonomy, as sellers must define the product type of the item they are managing
(setting up or maintaining).
What is Walmart’s Product Taxonomy Structure?
Walmart’s product taxonomy is a method of product classification arranged to aid retrieval (search and filter) and help Walmart customers find items on Walmart.com.
Walmart’s product taxonomy is segmented into three distinct classifications, listed in order from broadest to most refined:
Category
Product
Type Group
Product Type
One category contains multiple product type groups, and one product type group contains multiple product types. Drilling down to the product type name allows sellers to understand which product types are available, their definitions, and what to include in item setup and maintenance by product type specs. You will be able to Filter by Type (Product Type Group; Product Type)
How is Product Taxonomy Used in Item Setup and Maintenance?
Sellers must always indicate the item’s product type when setting up an item or maintaining item content. As such, the list retrieved from the GET Product Taxonomy call allows sellers to understand the product types available for use and their meaning. The different relationship levels allow for sellers to group and organize the product types to navigate the taxonomy.
string Example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM….. The access token retrieved in the Token API call
WM_CONSUMER.CHANNEL.TYPE
string A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
WM_QOS.CORRELATION_ID (required)
string Example: b3261d2d-028a-4ef7-8602-633c23200af6 A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
WM_SVC.NAME (required)
string Example: Walmart Service Name Walmart Service Name
QUERY PARAMETERS
version
string Example – “5.0” Version 5.0 returns back the Product Type Taxonomy in the response.
Note: Some product types are prohibited by WFS. They may be listed in the taxonomy call, but you won’t be able to use them for WFS.
SAMPLE RESPONSE:
{
"itemTaxonomy": [
{
"category": "Media",
"description": "Media",
"productTypeGroup": [
{
"productTypeGroupName": "Music",
"description": "Music",
"productType": [
{
"productTypeName": "Music",
"description": "Music"
}
],
"department": [
{
"departmentName": "MEDIA AND GAMING",
"departmentNumber": "5"
},
{
"departmentName": "LOCAL SHOPS AND SOUVENIRS",
"departmentNumber": "60"
},
{
"departmentName": "IMPULSE MERCHANDISE",
"departmentNumber": "82"
}
]
},
{
"productTypeGroupName": "Video Game Software",
"description": "Video Game Software",
"productType": [
{
"productTypeName": "Video Games",
"description": "Interactive software that is used for entertainment, role playing and simulation.tt"
}
],
"department": [
{
"departmentName": "MEDIA AND GAMING",
"departmentNumber": "5"
},
{
"departmentName": "IMPULSE MERCHANDISE",
"departmentNumber": "82"
},
{
"departmentName": "SUB-DEPT: DEPT #05",
"departmentNumber": "55"
}
]
},
{
"productTypeGroupName": "Movies & TV Shows",
"description": "Movies & TV Shows",
"productType": [
{
"productTypeName": "Movies",
"description": "A story or event recorded by a camera as a set of moving images and shown in a theater or on television; a motion picture."
},
{
"productTypeName": "TV Shows",
"description": "A program broadcast by television."
}
],
"department": [
{
"departmentName": "MEDIA AND GAMING",
"departmentNumber": "5"
},
{
"departmentName": "LOCAL SHOPS AND SOUVENIRS",
"departmentNumber": "60"
},
{
"departmentName": "IMPULSE MERCHANDISE",
"departmentNumber": "82"
}
]
}
]
}
],
"status": "SUCCESS"
}
POST Item Setup and Maintenance by Product Type: Overview & Capabilities
The POST Item Setup and Maintenance by Product Type calls are all performed through Walmart’s standard bulk async feed files. For more on bulk async feed files, see the Feeds guide. [link to here: https://developer.walmart.com/doc/us/us-mp/us-mp-feeds/ ]
There is no change in the feedType that is going to be sent when compared to the 4.8 spec version. (MP_ITEM, MP_MAINTENANCE, MP_WFS_ITEM, OMNI_WFS). The new Spec 5 version to use however would be the ones you download from the links in the table below.
Select the needed JSON schema, dependent on if the seller is creating new items for Walmart (item setup by product type) or maintaining currently set up items (item maintenance by product type). Feed files or specs will also vary depending on the fulfillment type of MP (Seller fulfilled) or WFS (Walmart fulfilled). Each feed file contains all relevant attributes aligned to the standards displayed in the Walmart item style guides. [link to here: https://sellerhelp.walmart.com/s/guide?language=en_US&article=000009380 ]
string Example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM….. The access token retrieved in the Token API call
WM_CONSUMER.CHANNEL.TYPE
string A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
WM_QOS.CORRELATION_ID (required)
string Example: b3261d2d-028a-4ef7-8602-633c23200af6 A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
WM_SVC.NAME (required)
string Example: Walmart Service Name Walmart Service Name
The new Item spec v4.X provides three sets of JSON schemas that you can use with the new feed types to represent an item object for either Marketplace item, Marketplace, WFS item, or Item maintenance. Select the JSON schema depending on whether you are creating new items for Walmart alone, Walmart, and WFS, or you are maintaining items that are currently set up. Spec v4.X is available in JSON schema format only for better ease of use.
Changes in Spec v4.8
-Adding “Restored Premium” to closed list for the Condition attribute (available for program eligible sellers)
-Changing “Fit Type” to a required attribute in ‘Vehicle Parts & Accessories’ and ‘Vehicle Others’ categories
-Update “Tire Width” to a Decimal data type in Tires category
-Changing “Fulfillment Lag Time” to a closed list to only allow values “0” or “1” to be used. This is an optional attribute, the default value is 0 if no entry is provided. If you are approved for a Lag Time Exception for 2 days or more, you will need to use the Lag Time Spec to update your items.
-Changing closed list for Variant Attribute Name to include “tireSize” in ‘Tires’ category
-Adding Local Delivery Dimensions as optional attributes for the Local Delivery program.
Starting October 1, 2022 our systems will no longer support item setup or maintenance using legacyItem Spec v3.2. Marketplace sellers should start migrating to the latest 4.X versions now in order to avoid delays to your item setup and maintenance requests.
In order to streamline your migration effort the document below is a comprehensive breakdown of attribute value changes form 3.2 to 4.X. Please utilize this template to simplify your migration efforts. Review the comparison for migrating from Item Spec v3.2 to Item Spec v4.X.
Item setup workflow
To initially set up and ingest your items to Walmart, you need to use several different APIs.
To select the Item spec for your purposes, see Item Spec v4.X.
Item setup steps
Send an item feed to Walmart with payload in JSON format. Go to Items > Bulk item setup to make the initial API request that starts the ingestion and publish process for each item you send in the API call. The response returns a Feed ID that you can use to monitor all items you want to ingest. Note: In an Item feed, if you send HTML content as a value to shortDescription you have to do character encoding to the HTML tags. If you send direct HTML tags, they will appear as is in the Description of an Item on Walmart.com.
Monitor the feed and the item submission status. Go to Feeds > Get feed and item status to retrieve all details about the Feed status. Once the Feed has a status of PROCESSED (i.e. the Feed is complete), all of the items have either been submitted or have submission errors.Note: The first items may be successfully submitted days before the last items get submitted.
Monitor the published status of the submitted items. Go to Item > Get an item to check the status. Once the status of an item is PUBLISHED, it can be edited further.Note: Status calls might return errors on individual items. Examine the errors that are returned, correct them and then mark them for re-ingestion.
(Recommended): To change the price of your items, go to Price > Update a price. You can update prices in bulk, go to Price > Update a price. Although this is not required, it’s a good practice to verify prices, because desired item prices can change after you initiate the ingestion process.
To initially ingest and publish new items to the Walmart catalog, use the Bulk Item Setup API to update items in bulk.
Typically, sellers can update 10,000 items at once. However, the 10K item limit does vary depending on individual seller agreements, it might be only 5K for some sellers.
Provide Sales Restriction Type
There is a requirement for setting up WFS items and Walmart items in Furniture and Large Appliance categories to indicate item Sales Restrictions by geographic location: State or Zip Code. If there are no restrictions, you can set the Restriction Type to “None.” Sellers must select an option for a restriction (Commercial,Illegal for Sale, or None), you must complete the following attributes if you choose the first two options:
States: List all States where your product should not be sold for legal or commercial reasons separated by a comma. (E.g., CA, IL, IA, MN, NY, UT, TX)
Zip Code: List all Zip Codes where your product should not be sold for legal or commercial reasons separated by a comma. (E.g., 86401, 50432, 99543, 23451, 88231)
Set up item: Add your items from Walmart’s catalog
To set up items that match existing items in Walmart.com, call POST /v3/feeds with feedType set to MP_ITEM_MATCH.
Use the Item Setup by Match schema and update the information as per the Setup by Match v4.2 schema for each item. The items you submit will be processed and checked to see if they already exist in the Walmart Catalog. If a match is found, your item will be automatically set up and you won’t need to provide your own content.
Once the feed has been processed, the Feed Item Status API will return whether a match is found or not. If a match is not found or you want to provide your own content, use the Bulk Item Setup API.
Changes in Spec v4.2
– Adding “Condition” as required attribute. Specify whether your items condition is New or one of the non-new closed list conditions. (Non-new conditions are available for program eligible sellers).
– Adding “Main Image URL” as conditionally required attribute for the following conditions: Remanufactured, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, or New with defects.
– Adding “Additional Image URL” as optional attribute.
– Updated max character count to 100,000 for “Zip Codes” in State Restrictions attribute group.
The string of letters and/or numbers a partner uses to identify the item. Walmart includes this value in all communications regarding item information such as orders.
TRVAL28726
Required
productIdentifiers
productIdType
UPC: GTIN-12, the 12-digit number including check-digit. If less than 12-digits, such as UPC-E which is 8-digits, add leading zeros up to 12-digits.; GTIN: GTIN-14, the 14-digit number including check-digit. If less than 14-digits add leading zeros up to 14-digits. ISBN: International Standard Book Number, the 10 or 13-digit number including check-digit.; EAN: GTIN-13, the 13-digit number including check-digit. If less than 13-digits add leading zeros up to 13-digits.
UPC; GTIN; ISBN; EAN
Required
productIdentifiers
productId
Alphanumeric ID that uniquely identifies the product. Used in conjunction with “Product ID Type”. NOTE: For GTIN-14 or UPC, include the check digit.
00123456781011
Required
price
The price the customer pays for the product. Please do not use commas or currency symbols. Only 2 digits allowed after decimal point.
100.33
Required
ShippingWeight
The weight (in pounds) including all of its packaging materials. Only 3 digits maximum allowed after decimal point.
5.255
Required
condition
This refers to the state of an item, indicating its level of wear, prior use (if any), appearance, and overall quality. Availability of condition types may vary by product/category as well as by Seller eligibility per program. For more details, review this Help article: https://sellerhelp.walmart.com/seller/s/guide?language=en_US&article=000011205.
New;New without box;New without tags;Remanufactured;Open Box;Pre-Owned: Like New;Pre-Owned: Good;Pre-Owned: Fair;New with defects
Required
mainImageUrl
Image of the item is required for the following conditions: Remanufactured, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, or New with defects. Main image of the item. File Format: JPEG (.jpg). Recommended Pixel Dimensions: 2200px x 2200px. Minimum Pixel Dimensions for Zoom 1500px x 1500px. Swatch Pixel Dimensions: 50px x 50px. Resolution: 300 ppi. Maximum file size: 5MB. Aspect Ratio: 1:1 (Square). Recommended File Naming: GTIN-14 digit Image URLs should end in an image file type (.jpg) to follow best practices. They must link to a public image file that loads as an image.
Conditionally Required
Conditionally Required when condition = Remanufactured, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects
productSecondaryImageURL
Secondary images of the item. File Format: JPEG (.jpg). Recommended Pixel Dimensions: 2200px x 2200px. Minimum Pixel Dimensions for Zoom 1500px x 1500px. Swatch Pixel Dimensions: 50px x 50px. Resolution: 300 ppi. Maximum file size: 5MB. Aspect Ratio: 1:1 (Square). Recommended File Naming: GTIN-14 digit Image URLs should end in an image file type (.jpg) to follow best practices. They must link to a public image file that loads as an image
Optional
productCategory
Please select your Product Category from the drop down list. Product Category is used to organize and define products. Adding Product Category will have some improvements to the match rate of items.
ASIN is the Amazon Standard Identification Number. It is the unique 10-digit sequence of letters and/or numbers
ASIN
Optional
externalProductIdentifier
externalProductId
Provide the ID for your “External Product ID Type”.
B002Z36VJE
Optional
stateRestrictions
stateRestrictionsText
Please select the level of restriction you are applying to your item, Illegal for Sale or Commercial. Illegal for Sale restrictions apply to items for sale in the United States of America which have a federal, state, and or local law/regulation. Commercial Restrictions apply to items for any reason out side of local or state laws. If your item does not have any Restriction please select None. If your item has a Commercial or Illegal for Sale Restrictions you must provide the States or Zip Codes which the item is Restricted in.
Commercial;Illegal for Sale;None
Optional
stateRestrictions
states
Please list all States in which your product must and/or should be prohibited from being sold. You MUST provide us a list of all States and Zip Codes where your product is prohibited or restricted from being sold due to a law, regulation, ordinance, etc. You MAY, at your discretion, provide Walmart a list of all States and Zip Codes where you prefer to prohibit your product from being sold. Please remember that it is your obligation to understand and inform Walmart of any laws, regulations, ordinances etc. that would prohibit or restrict your product from being sold in a specific State or Zip Code.
CA
Optional
stateRestrictions
zipCodes
Please list all Zip Codes where your product should not be sold for legal or commercial reasons. You have an obligation to notify Walmart of any Zip Codes where laws, regulations, ordinances etc. prohibit or restrict your product from being sold. At your discretion, you may also specify any Zip Codes where you prefer not to have your product sold for commercial reasons. Please be aware that placing a Zip Code restriction on a product will only restrict that product from being sold within that Zip Code. To restrict an entire State, please specify the State instead of using Zip Codes. While Maintaining a Zip Code Restriction please be aware that you are required to re-submit all restrictions which apply to your item. Adding a Single Value will remove any previous restriction which was originally placed on the item and only restrict the single value which was added.
94085, 94086, 94087, 72712, 72716
Optional
additionalProductAttributes
productAttributeName
Add an additional attribute not present in this template. Use camelCase for the name.
additionalAttributeName
Optional
additionalProductAttributes
productAttributeValue
Write your “Additional Product Attribute Value” to give a description or answer for your “Additional Product Attribute Name.” Together, these allow you to create your own descriptor that is not already in the taxonomy.
15″; 19mm; Yes; No
Optional
additionalOfferAttributes
additionalOfferAttributeName
Add an additional offer attribute not present in this template. Use camelCase for the name.
planetNames
Optional
additionalOfferAttributes
additionalOfferAttributeValue
Write your “Additional Offer Attribute Value” to give a description or answer for your “Additional Offer Attribute Name.” Together, these allow you to create your own descriptor that is not already in the taxonomy.
36418238480545
Optional
Item object usage and status
The MPitem object may contain either item or listing/offer information, or both. Based on the type of information it can be used for the following operations:
To Set Up Full Item: If the MPitem object contains item information (i.e., item attributes) as well as the listing /offer information (i.e., price and shipping information); it will be used to set up the full item.
To Update Product Only: If the MPitem object contains only item information (i.e., item attributes); it will be used for only product information updates.
To Update Listing/Offer Only: If the MPitem object contains only listing /offer information; it will be used for only listing/offer information updates.
Which object to use for initial set up, publish and edit operations
Select either the Item, Offer Only, or Product Only object for the stage in setup or maintenance that you are doing:
For initial insertion, use the MPItem object with item details and item listing or offer.
Once the item has been set up and the status is PUBLISHED, use the Offer Only object item for non-item edits, such as price changes.
Use the Product only item object for item edits. You should not use an MPItem object because any price change included in the MPItem object is effective only when the entire object is processed.
Published Status
The published status of an item describes where the item is in the submission process.
PUBLISHED: The item is visible on Walmart.com and available for sale.
READY_TO_PUBLISH: The item is in the final staging process and is ready to be published.
IN_PROGRESS: The item is processing. An error could still occur at this point.
UNPUBLISHED: The item has been made unavailable on Walmart.com because of backend rules, such as not having inventory for too long or problems with images.
STAGE: The item is in the final staging process but has not been published because the Seller has not gone live.
SYSTEM_PROBLEM: The item cannot be published. Contact Partner Support.
Lifecycle Status
The lifecycle status of an item describes where the item listing is in the overall lifecycle.
ACTIVE: The item’s offer is current.
RETIRED: The offer has moved past its expiration date (as set in the EndDate field). The item is not visible on Walmart.com. It can be made ACTIVE again by extending the expiration date into the future.
ARCHIVED: The offer has been in RETIRED status for over a year. To return the listing to the ACTIVE status, contact Partner Support.
Maintain an item
To maintain an item, keep track of process modes, product ID & SKU, and shipping override.
Process Mode & Subset
For MP v4.X, you should always pass REPLACE for process mode and EXTERNAL for subset.
Product ID & SKU
Product ID and SKU are important identifiers for Walmart’s systems. Walmart merges items with the same Product ID and shows them as one item sold by multiple Sellers. If you provide the wrong Product ID, your item will be merged incorrectly, which can increase your order cancellation rate, create bad customer experience, produce customer fraud complaints and result in a lower rating on your Seller Scorecard.
**Note: You can not update both a SKU and a product ID in the same spec. If you want to update the product ID, it must be done separately. For more details, please refer to Update an Item’s Product ID.
Secondary Image Deletion
To delete old SECONDARY/SWATCH images, please send the value for processMode as REPLACE_ALL.
Search for items in Walmart catalog by keyword or product code
The Walmart 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.
Search by keyword, UPC or GTIN
To search for a product in the Walmart global catalog, call GET /v3/items/walmart/search, and specify query parameters: query for a keyword search, upc for Universal Product Code search, or gtin to get the Global Trade Item Number.
Example: Search by keyword
For example, to search for a keyword, enter text (e.g. ipad or fitbit) with the query parameter:
GET https://marketplace.walmartapis.com/v3/items/walmart/search?query=ipad
Example: Search by UPC
To search by UPC code, specify the number with the upc parameter:
GET https://marketplace.walmartapis.com/v3/items/walmart/search?upc=911138034047
Upon success, the response returns all values for the item in JSON format.
Search for items in seller's catalog
The seller item search API allows you to search a seller’s catalog by seller’s Item_ID, GTIN, UPC, EAN, ISBN, or SKU.
To search for a seller’s item by specific product code, call GET v3/items resource, and specify the productIdType query parameter set to ITEM_ID, GTIN, UPC, ISBN, EAN, or SKU.
You must specify at least one value for the productIdType query parameter (e.g. productIdType=GTIN), or else the API returns SKU by default.
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.
Get an item by SKU
You can pass the SKU code directly as the URL parameter, ID:
https://marketplace.walmartapis.com/v3/items/{ID}
For example, to get the SKU code, “30348_KFTest,” specify it directly to the items resource as a URL parameter:
To get other item codes, specify the query parameter productIdType set to either GTIN, UPC, EAN, ISBN, SKU or ITEM_ID and provide the numeric code after the /items resource in the URL.
Upon success, the response returns all values for the item in JSON format.
Search for items in Seller's Catalog by Price, Listing Status, Rating and Other Listing Attributes using payload
The Catalog Search Api allows you to make a more accurate request to search Seller Catalog by creating your own payload and not in the url.
To make the search, call /v3/items/catalog/search resource, and specify the correct payload with Query, Filter and Sort. Please see allowed fields for those parts below.
You must provide either Query or Filter to execute search API call. Sort along is not sufficient as a standalone parameter for API call and will lead to an error response.
Only one query is allowed but multiple filters are acceptable.
White card search is supported for Query, use “%” to present the unknown letters. For example, “%item” means any string ended with “item”, “item%” means any string started with “item” and “%item%” means any string contains “item”.
for example if i select limit as 10 and applied nextCursor, it will be like this:
/v3/items/catalog/search?limit=10&nextCursor=DnF1ZXJ5VGhlbkZldGNoeAAAAAAC4JCoFjQ(omit the rest)
Please do not apply nextCursor when you do the search for the first time.
Examples: Only search with Query
White card search is supported for query. Like below example, % is used to indicate “Unknown”. So in this case, it will search any sku contains letter “n”.
{
"query": {
"field": "sku",
"value": "%n%"
}
}
Examples: Only search with Filters
Multi-field is supported in filters, you can combine any filters you like to search. So in this case, we are doing search for all the items which match two judgement, price is larger than 10 and unpublishedStatus is either PUBLISHED or RETIRED.
To map an item SKU to a shipping template, use the Bulk Item Setup (Multiple) API. Specify SKU_TEMPLATE_MAP for the feed type. For example, call POST /v3/feeds?feedType=SKU_TEMPLATE_MAP
Provide your sample file with values for required parameters in your request payload:
sku – Item SKU code
actionType – Specify “Add” to associate SKU to the template
shippingTemplateId – provide the Shipping Template ID that you want to associate the SKU to
fulfillmentCenterId – provide the Fulfillment Center ID
To view an example, see Bulk Item Setup (Multiple) API Reference. Go to the Request Samples pane, and select “SKU_TEMPLATE_MAP – Sample 1” from the Example drop-down menu.
Note: Make sure to send the feed file as an attachment set the Content type to “multipart/form-data” in the header.
If you prefer to opt-out of the precise delivery available with Shipping Templates, you can simply set up a TwoDay shipping rule with Create a new Rule API. To learn more about the Rules API, see Rules Management.
If you have already onboarded to the TwoDay program, before you activated the Shipping Templates, you can switch back to TwoDay shipping. For a mapping of activation status and program onboarding status, see Rules Management.
Validation Error Troubleshooting
When you send a SKU_TEMPLATE_MAP feed to Walmart, it validates according to Attribute type and acceptable format.
If you provide an incorrect Shipping Template ID, Fulfillment Center ID, or invalid SKU, you will get data or system errors. Here are some tips to fix the errors.
Error Type
Cause
How to fix or avoid error
DATA_ERROR
Shipping Template ID is invalid
Verify the Shipping Template ID and resend request.
DATA_ERROR
Fulfillment center ID is invalid.
Provide correct FC ID and resend request.
DATA_ERROR
SKU is missing from the request. Or, SKU is invalid.
Provide SKU and resend the request. Verify SKU format is correct, and retry request.
SYSTEM_ERROR
SKU provided in request is not found in the system.
Make sure that the correct item SKU was ingested in the system. To ingest the item again, call Bulk Item Setup API. Please provide a valid SKU in the payload line items and reattempt. If the issue persists, contact the support team at https://sellerhelp.walmart.com/s/.
Get Feed Status Errors
If you call Get Feed Status API it might fail if you do not include all required parameters in the request.
Make sure that you include the selling channel in the request.
As part of Precise Delivery Program, Sellers and Channel Partners can associate SKUs to Shipping Template(s). The initial configuration is set with the Bulk Item Setup (Multiple) API.
Previously, sellers could only check which Shipping Templates are associated with item SKUs by downloading an item report.
Now you can get all Shipping Templates and Fulfillment Centers that are currently associated with each item SKU. Call the POST Get Item Associations API to view current item SKU Shipping Template associations that you’ve set up with the Bulk Item Setup API. For information about how to set this up, see Add an item SKU to a Shipping Template.
Note: The Item map to Shipping Template process takes between 30 minutes to 4 hours. After this, you can call POST Get Item Associations API to retrieve all items associated with the Shipping Templates.
Step 1: Send request body with all SKUs
To get the shipping template and fulfillment center associated with each item SKU, provide a list of all item SKUs in the body of the request. For example, call POST /v3/items/associations
For an example request body, see Request Samples in the Get Item Associations API Reference.
Note: The maximum number of item SKUs you can pass in one request is 50.
Step 2: View Shipping Templates for each item SKU
The response returns all Shipping Templates associated with that item SKU, including the Shipping Template, and the Fulfillment center (i.e. Ship Node).
For each Shipping Template assigned to a SKU, the response provides:
shippingTemplate
name – Specified by seller (e.g. “2Day – MidWest region”)
type – One of the type values: CUSTOM, DEFAULT or DELIVERR.
id – Shipping Template identifier specified by seller.
shipNodeName – Seller-specified Fulfillment Center name (e.g. “MP_Deliverr.”)
shipNode – Walmart-specified Fulfillment Center (aka “Ship Node”) identifier.
For an example response, see Response Samples in the Item Associations API Reference.
Use the above Vehicle List to create your year, make, model, submodels and enginebase data records. If your YMMS inputs include vehicles not in the linked vehicle list OR the YMMS inputs do not match the YMMS in the vehicle list EXACTLY the row will error out, and fitment will fail. Please ensure your YMMS inputs match the acceptable values in the linked vehicle list.
Fitment Upload files
Existing Direct Fit Items can be updated for Fitment Data via the Bulk Item Update APIfor Feed Types FITMENT_ACES and FITMENT_PIES
Both ACES and PIES file types should be uploaded in .zip format, ACES .zip can have the file in .xml or .xlsx format while PIES .zip can only contain .xml file. The .zip files can only contain one file type and one brand at a time and should be no larger than 25 MB. See below for more specific rules per file type.
ACES XML Files
– The BrandAAIAID must be present in the header row of the file.
– The BrandAAIAID must be present in the BrandAAIAID tag for the first 1,000 characters of the file (ex. <BrandAAIAID>(Brand ID)</BrandAAIAID>).
– Values must be present for the BaseVehicleID, PartNumber, and PartTerminologyID.
– To add a new vehicle, the action value should be equal to ‘Add’ (A).
– To delete an existing vehicle, the action value should be equal to ‘Delete’ (D).
– If an action value is missing for an XML app node, the value will default to ‘Add’ (A).
– If the SubModel/EngineBase value is empty, the value will default to ‘All’ meaning the products fits all types.
ACES XLSX Files
Rules related to header format:
Excel file should have following header format
MPN/SKU
Action(A or D)
GTIN
Part Terminology Id
Part Terminology Name
BrandAAIAD
Year(YYYY)/Year Range (YYYY-YYYY)
Make
Model
SubModel
BlockType
Cylinders
Liter
CC
Note
– Header format should have same order of columns as above with same name as well.
– Addition/Deletion of column in any excel of the zip is not allowed.
Rules related to BrandAAIAD
– We expect per excel file to contain only one unique BrandAAIAD. (We pick first occurrence of non empty BrandAAIAD in excel) i.e multiple BrandAAIAD within single excel file is not allowed
– In a zip file, 2 or more excel files should not contain same BrandAAIAD
Note: If there are multiple excel files with same BrandAAIAD , either
– Merge them in a single excel file not crossing 25 MB .zip file size limit.
– Zip each file and upload to Seller Center or Partner API – this makes sure that multiple excel files with same BrandAAIAD are not in a single zip file -> recommended
– Merge them in a single excel file not crossing 25 MB .zip file size limit.
– Zip each file and upload to Seller Center or Partner API – this makes sure that multiple excel files with same BrandAAIAD are not in a single zip file -> recommended
Note: If any of the above rules (1, 2 or 3) fail, we would be rejecting/ status would be failed for the whole zip file.
– Rows with empty MPN/SKU or Part Terminology Id , will not be ingested.
– For a row, if Action column value is missing, by default we consider it as A.
– We expect Year(YYYY)/Year Range (YYYY-YYYY) column value to be either single year value or single year range. Ex: 2007 or 2007-2019. Anything other than this, row wont be ingested.
– If SubModel is empty, we ingest its value as ALL (meaningfits all) by default
– If BlockType, Cylinders, Liter, CC -> if all of these are sent empty, we ingest its value as ALL (meaningfits all) by default
– We wont be ingesting data for these part-types via ACES format → Tires(7636) , EngineOil(12138), Differential_Oil(12137), Automatic_Transmission_Fluid(11387), Manual_Transmission_Fluid(13630), Brake_Fluid(11389), Power_Steering_Fluid(11395), Gear_Oil(11394), Coolants(11393), Refrigerants(6984)
– We expect per excel file to contain only one sheet.
– Excel cell/column value should contain plain text and not any mathematical expressions/formula
e.g some cells have text value but on clicking, we will get to see expressions like below.
– Excel cell expects single string line value within it, if there are multiple lines (seperated by newline character) that will be failed with “newline character in a cell” errorMessage
e.g A & B should be on same line. And not like shown in following screen shot
PIES files
– Values must be present for the ItemLevelGTIN, BrandAAIAID,PartNumber, and Part TerminologyID.
– Items will be updated only if there is a change in attribute values corresponding to a particular GTIN and the MaintenanceType value is ‘Add’ (A) or ‘Change’ (C).
**NOTE: If any of the rules above are not followed, the file will not be processed and will return an error. In some situations, after uploading your files, an attribute may not reflect the update based on the content ranking source.
Once the feed has been processed, the Feed Item Status APIwill return the status of the feed. Incase of errors use Error Download API to download the error report.