POST Item Setup by Product Type: Feed File Structure Overview
The POST Bulk Item Setup and Maintenance by Product Type request uses feed files to submit data. A feed consists of an API request with an attached file, called the feed file or load file. The feed file contains a list of records (for example, items) that suppliers submit for processing.
POST Bulk Item Setup by Product Type: Feed File Structure Overview
POST Bulk Item Setup by Product Type feed files have the following basic JSON schema structure:
{ "title": "SupplierItemFeed", "properties": { "SupplierItemFeedHeader": { "type": "object", "description": "Contains attributes applicable to the entire submission. Only required one time for the item(s) being setup in the submission." }, "SupplierItem": { "minItems": 1, "description": "This object is used to define each item being setup as part of the submission. This object must be completed for each unique item configuration being setup.", "type": "array", "items": { "properties": { "Orderable": { "type": "object", "description": "The attributes required to setup an item for the channel it is being sold in. Contains the Primary Identifier.", "Visible": { "type": "object", "description": "Contains all Product Types that can be selected for Item Setup, and all of the relevant attributes that are required to setup the item.", "properties": { "Product Type 1": "Animal Feed", "Product Type 2": "Tires" } }, "TradeItemApparel": { "type": "object", "description": "The attributes required to setup an item configuration that Walmart will place an order for (e.g. an Each, Case pack, pallet). This object is only required for items that enter a Walmart facility, not used for DSV Items. Depending on the Product Type being setup the Supplier must complete either TradeItemApparel, TradeItemFresh, or TradeItem." }, "TradeItemFresh": { "type": "object", "description": "The attributes required to setup an item configuration that Walmart will place an order for (e.g. an Each, Case pack, pallet). This object is only required for items that enter a Walmart facility, not used for DSV Items. Depending on the Product Type being setup the Supplier must complete either TradeItemApparel, TradeItemFresh, or TradeItem." }, "TradeItem": { "type": "object", "description": "The attributes required to setup an item configuration that Walmart will place an order for (e.g. an Each, Case pack, pallet). This object is only required for items that enter a Walmart facility, not used for DSV Items. Depending on the Product Type being setup the Supplier must complete either TradeItemApparel, TradeItemFresh, or TradeItem." } } } } } }
}
The specific objects and attributes included in the feed file will vary by the channel and item type being set up. The feed file schema provided will define all attributes and include all definitions and examples.
SupplierItemFeedHeader
contains attributes that apply to all items in the submission. These headers are only completed once for the entire submission.
The SupplierItem
object is completed for each item submitted. It is an array, meaning the supplier can include multiple items per submission. The SupplierItem
object contains the Orderable
, Visible
, and TradeItem/TradeItemApparel
objects or attributes.
The Orderable
object includes all the relevant attributes Walmart requires to sell an item for the associated channel. The attributes included and required vary by channel; for example, shipping dimensions are required for drop ship vendor (DSV) items only. The Orderable
object also includes the item's primary identifier, such as its global trade item number (GTIN).
In the Visible
object, the supplier must define the product type being set up. Based on the selected product type, the supplier will complete the relevant attributes identified in the feed file schema provided.
Attributes for the trade item objects (TradeItem
, TradeItemFresh
, or TradeItemApparel
) are used to define the different configurations in which Walmart might order the item from the supplier. These objects are only required and used if Walmart handles the item; for example, if the item enters a Walmart facility, store, distribution center (DC), or fulfillment center (FC). As such, the trade item objects are not used in the item setup feed file for drop ship vendor (DSV) items.
Suppliers may wish to define multiple item configurations to sell to Walmart, such as selling the item in a case to Walmart and also selling the item in a pallet to Walmart. If so, then those suppliers must complete multiple supplier items where the Orderable
and Visible
objects will contain the same item data, but each sellable configuration will be independent of the trade item objects.
The relevant trade item object depends on the product type of the item being set up. The supplier must use the relevant trade item object to ensure Walmart collects the proper attributes. There are three distinct trade item objects:
TradeItem
: Trade item object used for general merchandise.TradeItemApparel
: Trade item object required for apparel product types only.TradeItemFresh
: Trade Item object required for fresh, perishable, or other food/grocery product types.
Suppliers can identify the relationship between the product type (identified in the Visible
object) and the trade item object in the schema conditional requirements in each feed file schema. Based on the product type selected, suppliers have to either use the TradeItem
, TradeItemFresh
, or TradeItemApparel
object. If general merchandise, use TradeItem
. If clothing, use TradeItemApparel
. If it is a product type is associated with food, grocery, or other fresh items, use TradeItemFresh
.
This scenario is defined in the following schema: The product types Jumpsuits and Shirts require the object TradeItemApparel
; whereas the product types Bagels and Cakes require the object TradeItemFresh
. The product types Cell Phone and Smart Watches require the object TradeItem
.
{ "definitions": { "TradeItem_TradeItemApparel_Requirement": { "oneOf": [ { "allOf": [ { "$ref": "#/properties/SupplierItem/items/definitions/ptListForTradeItem" }, { "$ref": "#/properties/SupplierItem/items/definitions/requiredTradeItem" } ] }, { "allOf": [ { "$ref": "#/properties/SupplierItem/items/definitions/ptListForTradeItemFresh" }, { "$ref": "#/properties/SupplierItem/items/definitions/requiredTradeItemFresh" } ] }, { "allOf": [ { "$ref": "#/properties/SupplierItem/items/definitions/ptListForTradeItemApparel" }, { "$ref": "#/properties/SupplierItem/items/definitions/requiredTradeItemApparel" } ] } ] }, "ptListForTradeItemApparel": { "properties": { "Visible": { "oneOf": [ { "required": [ "Jumpsuits" ] }, { "required": [ "Shirts" ] } ] }, "required": [ "Visible" ] }, "requiredTradeItemApparel": { "required": [ "TradeItemApparel" ] }, "ptListForTradeFresh": { "properties": { "Visible": { "oneOf": [ { "required": [ "Bagels" ] }, { "required": [ "Cakes" ] } ] }, "required": [ "Visible" ] }, "requiredTradeItemFresh": { "required": [ "TradeItemFresh" ] }, "ptListForTradeItem": { "properties": { "Visible": { "oneOf": [ { "required": [ "Cell Phone" ] }, { "required": [ "Smart Watches" ] } ] }, "required": [ "Visible" ] }, "requiredTradeItem": { "required": [ "TradeItem" ] } } } } }
}
Updated about 17 hours ago