openapi: 3.0.1
info:
title: Walmart Item Management
description: The Item Management APIs enable you to set up and manage items on Walmart.com. Once you have completed Registration and have access to your Consumer ID and Private Key, you can get started with the integration process
servers:
- url: https://marketplace.walmartapis.com
description: Production URL
- url: https://sandbox.walmartapis.com
description: Sandbox URL
security:
- basicScheme: []
paths:
"/v3/items/catalog/search":
post:
tags:
- Items
summary: Walmart Catalog Search
description: Get Catalog Search Result
externalDocs:
description: View Guide
url: "/doc/us/mp/us-mp-items/"
operationId: getCatalogSearch
parameters:
- name: page
in: query
description: number of page
required: false
schema:
type: integer
format: int32
default: 0
- name: limit
in: query
description: number of items
required: false
schema:
type: integer
format: int32
default: 100
- name: nextCursor
in: query
description: nextCursor
required: false
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: Request fields
content:
application/json:
schema:
type: object
properties:
query:
type: object
properties:
field:
type: string
description: "| Attribute | Description | Data Type\n| --- | ----------- | -------\n| productName | Product Name, can do white card search | string |\n| sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |\n| gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string |\n| wpid | The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com | string |\n| upc | Specifies a Universal Product Code (UPC) search. UPC must be 12 digits. | string |\n| isbn | International Standard Book Number | string |\n| ean | Product ID, EANs must be 13 digits in length. | string |\n| itemId | A unique Id which identifies the item | string | \n| variantGroupId | Variant Id to retrieve all items with the same variant id | string | \n| condition | Specifies the condition of the item. Can take values (New, New without box, New without tags, Restored Premium, Restored, Remanufactured, Open Box, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects) | string |"
enum:
- productName
- sku
- gtin
- wpid
- upc
- isbn
- ean
- itemId
- condition
value:
type: string
filters:
type: array
items:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The reviewed times for Items | string |
| customerRating | Customer rating | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
| price | Price of the Item | string |
| fulfillmentType | Fulfillment information | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
- price
- fulfillmentType
op:
type: string
enum:
- equals
- between
- greater_than
- less_than
values:
type: array
items:
type: string
sort:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The revied number for Items | string |
| customerRating | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
order:
type: string
enum:
- ASC
- DESC
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Response Status
payload:
type: array
description: Items included in the response list
items:
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the item.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
isbn:
type: string
description: International Standard Book Number
ean:
type: string
description: Product ID, EANs must be 13 digits in length.
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
itemId:
type: string
description: A unique Id which identifies the item.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
unit:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
brand:
type: string
description: Brand of Item.
num_reviews:
type: string
description: The reviewed times for Items.
customerRating:
type: string
description: Customer rating.
manufacturer:
type: string
description: manufacturer of Item.
fulfillmentType:
type: string
description: Fulfillment information.
publishedStatus:
type: object
properties:
status:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
reasons:
type: array
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
items:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
inventoryStatus:
type: string
description: It indicates whether the product is in stock or not.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
shop_ref:
type: string
shop_product_id:
type: string
shop_variant_id:
type: string
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
description: Items included in the response list
totalItems:
type: integer
description: Total items for the query
format: int64
limit:
type: integer
description: Number of items shown in this page
format: int32
nextCursor:
type: string
description: Used for pagination to fetch the next set of items
statuss:
type: string
writeOnly: true
examples:
Search Items:
value:
All: 682
With Variant Information:
value:
status: Success
payload:
- gtin: '05420529997042'
wpid: 5DTSM799JCUI
lifecycleStatus: RETIRED
mart: WALMART_US
publishedStatus:
reasons:
- END_DATE
status: UNPUBLISHED
productName: Electronic Cables
manufacturer: ECManu
shelf: '["UNNAV"]'
itemId: '562433848'
price:
amount: 70
unit: USD
variantGroupInfo:
groupingAttributes:
- name: actual_color
value: '1234567890'
isPrimary: 'true'
variantGroupId: Toysgroup0101
sku: 88nZ6RR82XghDkd
brand: ECB brand
productType: default
- itemId: '458505242'
gtin: '05828079255702'
wpid: 3SNE69WWZOWX
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
status: PUBLISHED
price:
amount: 325
unit: USD
sku: SDdk1BnxmLdKlqR
productName: 'Xbox 360 500GB Console with Fable Anniversary and Plants vs Zombies: Garden Warfare'
productType: Video Game Consoles
manufacturer: Xbox
shelf: '["Home Page","Video Games","Xbox 360 Consoles, Games, Accessories","Xbox 360 Games"]'
- itemId: '923248096'
gtin: '05919650669831'
wpid: 5X7QAK7X2X0S
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
reasons:
- SHIPPING_INFO_MISSING
- NO_MIN_MAX_PRICE
- NO_LOGISTICS_DATA
- NO_PRICE
- NO_ACTIVE_DISTR
status: UNPUBLISHED
sku: Wlju1ugimjnDyC7
variantGroupInfo:
groupingAttributes:
- name: actual_color
value: '1234567890'
isPrimary: 'true'
variantGroupId: Toysgroup0101
productName: 'Xbox 360 500GB Console with Fable Anniversary and Plants vs Zombies: Garden Warfare'
productType: Video Game Consoles
manufacturer: Xbox
shelf: '["Home Page","Video Games","Xbox 360 Consoles, Games, Accessories","Xbox 360 Games"]'
- gtin: '05935576685236'
wpid: 2IQ9J36SRZ3T
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
status: PUBLISHED
productName: Microfleece Blanket Sleeper Pajamas (Toddler Girls)
manufacturer: Komar Kids LLC
shelf: '["UNNAV"]'
itemId: '734690732'
price:
amount: 8
unit: USD
sku: sku-nrtVAYGPjdsgbviOD0mw766852
brand: Peas & Carrots
productType: Pajamas
- gtin: '05643842631879'
wpid: 31ZGLJXCMALD
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
reasons:
- PROHIBITED_TNS_RESPONSE
status: SYSTEM_PROBLEM
productName: Mainstays Multifunction Kitchen Cart, Multiple Colors
manufacturer: Dorel Asia
shelf: '["Home Page","Home","Furniture","Kitchen & Dining Furniture","Kitchen Islands & Carts"]'
itemId: '839833087'
price:
amount: 89
unit: USD
sku: sku-1Zyf4nJnNoFGX8p5In6M426318
brand: Mainstays
productType: Kitchen Storage Carts
- itemId: '862640320'
gtin: '05040277834668'
price:
amount: 7
unit: USD
sku: 7tdXa2Lnezu8yv1
brand: Levi Strauss
productName: Levi's - Big Men's Flat -Front Wrinkle-Resistant Pants
productType: Pants
manufacturer: Levi's company
shelf: '["Home Page","Clothing","Men","Men''s Bottoms","Men''s Pants"]'
- gtin: '00080529910042'
wpid: 5X0LZVVJU89V
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
status: PUBLISHED
upc: '080529910042'
productName: E-A-R Classic Earplugs, Neon Yellow, 1000 / Bottle (Quantity)
shelf: '["Home Page","Health","Ear Care","Ear Plugs"]'
itemId: '19674841'
price:
amount: 45.1
unit: USD
sku: SKUSafety&Emergency
brand: E-A-R
productType: Earplugs
- itemId: '769546740'
gtin: '05403344892488'
wpid: 5WCPNN3IUOHV
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
status: PUBLISHED
price:
amount: 325
unit: USD
sku: 2RSJ3i1pynYPBAf
productName: 'Xbox 360 500GB Console with Fable Anniversary and Plants vs Zombies: Garden Warfare'
productType: default
manufacturer: Xbox
shelf: '["Home Page","Video Games","Video Game Consoles"]'
- itemId: '988223634'
gtin: '05884984304980'
wpid: 6VBKXTHP3KMB
lifecycleStatus: ACTIVE
mart: WALMART_US
publishedStatus:
reasons:
- PARTNER_ITEM_DEFAULT_DISPLAY_STATUS
status: STAGE
price:
amount: 4.83
unit: USD
sku: sCOHsnCYqs1KWmd
brand: Crown
productName: Crown Camp Fuel, Quart
productType: Fuel Tank & Line Repairs
shelf: '["Home Page","Auto & Tires","Automotive Replacement Parts","Air Intake and Fuel Delivery","Fuel Pumps and Tanks"]'
- gtin: '05243875323040'
wpid: 2DMH907FBZBU
lifecycleStatus: RETIRED
mart: WALMART_US
publishedStatus:
reasons:
- END_DATE
status: UNPUBLISHED
productName: Electronic Cables
manufacturer: ECManu
shelf: '["UNNAV"]'
itemId: '162790217'
price:
amount: 70
unit: USD
sku: jiPOjG6m7NNn00f
brand: ECB brand
productType: default
limit: 10
totalItems: 126331
nextCursor: DnF1ZXJ5VGhlbkZldGNoFAAAAAAFY5rZFmJYLXU3cXBtUkptLUh5Rl9SelItZmcAAAAAAyAIRRZ4Mm41WTB1UlFIUzkyUVlOSjhFWXV3AAAAAAMgCEYWeDJuNVkwdVJRSFM5MlFZTko4RVl1dwAAAAAFhKggFmswVURRXzhzUlYtQVhyRmVXTy1UN0EAAAAABYSoHxZrMFVEUV84c1JWLUFYckZlV08tVDdBAAAAAAWt5AIWTl82dF9OR09Uc2VXbVhwRUFUSk44ZwAAAAAFTM_uFk11Q04ydmlOUk1pNW1iS0paUUt6Q1EAAAAABUzP7xZNdUNOMnZpTlJNaTVtYktKWlFLekNRAAAAAAWEqCIWazBVRFFfOHNSVi1BWHJGZVdPLVQ3QQAAAAAFhKghFmswVURRXzhzUlYtQVhyRmVXTy1UN0EAAAAABWOa2hZiWC11N3FwbVJKbS1IeUZfUnpSLWZnAAAAAAVMz_EWTXVDTjJ2aU5STWk1bWJLSlpRS3pDUQAAAAADIAhHFngybjVZMHVSUUhTOTJRWU5KOEVZdXcAAAAABWOa3BZiWC11N3FwbVJKbS1IeUZfUnpSLWZnAAAAAAWt5AMWTl82dF9OR09Uc2VXbVhwRUFUSk44ZwAAAAAFY5rbFmJYLXU3cXBtUkptLUh5Rl9SelItZmcAAAAABUzP8BZNdUNOMnZpTlJNaTVtYktKWlFLekNRAAAAAAMgCEgWeDJuNVkwdVJRSFM5MlFZTko4RVl1dwAAAAAFreQFFk5fNnRfTkdPVHNlV21YcEVBVEpOOGcAAAAABa3kBBZOXzZ0X05HT1RzZVdtWHBFQVRKTjhn
useCases:
- name: Catalog-search-body-not-found
value: catalog-search-body-not-found
sha: 1127cb56ce5c5a0b91a381a3dd42991aa3e3066c
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/failure/catalog-search-body-not-found?token=AAAUDV47T64MY7BWXJ6XWZ3GMMIEG
case: failure
- name: Catalog-search-filter-field-validation
value: catalog-search-filter-field-validation
sha: fe956c4d4076da5c63625bd6cda5a185db8fe2fd
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/failure/catalog-search-filter-field-validation?token=AAAUDVYN6PEKKYIX6YFAHZ3GMMIEG
case: failure
- name: Catalog-search-query-check
value: catalog-search-query-check
sha: a7ef3ff73f46c8070bb4cd6d83b1fb95c01400b8
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/failure/catalog-search-query-check?token=AAAUDV6Q2GPCJKBPCFJQ3W3GMMIEG
case: failure
- name: Catalog-search-query-field-validation
value: catalog-search-query-field-validation
sha: b1730da8cd6a5e6390a0ddaf99fb696547c8d83e
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/failure/catalog-search-query-field-validation?token=AAAUDVZ6P3YHGN5PMIGAAV3GMMIEG
case: failure
- name: Catalog-search-sort-field-validation
value: catalog-search-sort-field-validation
sha: 23c04caaea1073ddc5e3c55383378e84e6b7a7a6
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/failure/catalog-search-sort-field-validation?token=AAAUDV4LSN4MSVY5CUUFJUDGMMIEG
case: failure
- name: Catalog-search
value: catalog-search
sha: 5cfe78ccab76b501333f4a032f927f6d7e9ac709
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCatalogSearch/success/catalog-search?token=AAAUDV3JNSZGECCAGFB7IB3GMMIEG
case: success
"/v3/items/associations":
post:
tags:
- Items
summary: Walmart Get Item Associations
description: Get Item Associations API allows you to retrieve shippingTemplate and shipNode associated with the provided items.
operationId: getItemAssociations
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: Request fields
content:
application/json:
schema:
required:
- items
type: object
properties:
items:
type: array
description: List of items whose associations need to be fetched. It should not have more than 50 items.
items:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
description: List of items whose associations need to be fetched. It should not have more than 50 items.
example:
items:
- sku: RG-IRAE-79VD
- sku: AC73891
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
required:
- items
type: object
properties:
items:
type: array
items:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
associations:
type: array
description: Item Associations like shippingTemplate, shipNode.
items:
type: object
properties:
shippingTemplate:
type: object
properties:
name:
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type
enum:
- DEFAULT
- CUSTOM
- DELIVERR
id:
type: string
description: Shipping Template ID
description: Information about Shipping Template
shipNodeName:
type: string
description: Name of the fulfillment center.
shipNode:
type: string
description: The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
description: Item Associations like shippingTemplate, shipNode.
errors:
type: array
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
xml:
name: Error
example:
items:
- sku: RG-IRAE-79VD
associations:
- shippingTemplate:
name: Template 1
type: CUSTOM
id: '98723284584755201'
shipNodeName: MP_Deliverr
shipNode: '80991834993020929'
- sku: AC73891
associations:
- shippingTemplate:
name: Default Shipping Template
type: DEFAULT
id: '93685334451601409'
shipNodeName: MP Center
shipNode: '100009'
- shippingTemplate:
name: Template 1
type: CUSTOM
id: '98723284584755201'
shipNodeName: Stark International Inc-MP
shipNode: '10000000420'
- shippingTemplate:
name: Template 1
type: CUSTOM
id: '98723284584755201'
shipNodeName: MP_CUSTOM_1
shipNode: '79897837271126017'
useCases:
- name: Get-item-associations-partnerid-not-found
value: get-item-associations-partnerId-not-found
sha: 96ff01aa17ff0007f3f82a0a0d218cae1a29acae
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getItemAssociations/failure/get-item-associations-partnerId-not-found?token=AAAUDV6S3TON5I34FA4BH2LGMMIEI
case: failure
- name: Get-item-associations-sku-not-found
value: get-item-associations-sku-not-found
sha: 41c5e82474fa82f48195bfe1cd6cf062c351e752
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getItemAssociations/failure/get-item-associations-sku-not-found?token=AAAUDVZTEPE6C4IXS5KGZP3GMMIEI
case: failure
- name: Get-items-associations-body-not-found
value: get-items-associations-body-not-found
sha: 53676379da2f882f2d526b9dcb581267b9a65a2d
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getItemAssociations/failure/get-items-associations-body-not-found?token=AAAUDVZOFYEOQDZGP2JZPL3GMMIEI
case: failure
- name: Get-item-associations
value: get-item-associations
sha: cfb85630f878848ec0c4b8ad321bedf3834719b4
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getItemAssociations/success/get-item-associations?token=AAAUDVY5BHQILKEPSV4W4PTGMMIEI
case: success
"/v3/feeds":
post:
tags:
- Items
summary: Walmart Bulk Item Setup (multiple)
description: " Use this API for initial item setup and maintenance.\n\nThis 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.\n\nYou 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.\n\n* Item spec version 4.8 feed type: MP_ITEM\n* WFS Item spec version 4.3 feed type: MP_WFS_ITEM \n* WFS Maintenance spec version 4.8 feed type: MP_MAINTENANCE\n* Set up item by match 4.1 or 4.2 feed type: MP_ITEM_MATCH \n* Convert an existing item to WFS 4.5 feed type : OMNI_WFS \n* 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 \n"
externalDocs:
description: View Guide
url: "/doc/us/mp/us-mp-items/#1232"
operationId: itemBulkUploads
parameters:
- name: feedType
in: query
description: The feed Type
required: true
schema:
type: string
enum:
- item
- RETIRE_ITEM
- MP_ITEM
- MP_WFS_ITEM
- MP_ITEM_MATCH
- MP_MAINTENANCE
- SKU_TEMPLATE_MAP
- SHIPPING_OVERRIDES
- OMNI_WFS
- FITMENT_ACES
- FITMENT_PIES
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
requestBody:
description: 'The request body consists of a Feed file attached to the request based on the feedType selected '
content:
multipart/form-data:
schema:
required:
- file
type: object
properties:
file:
type: string
format: binary
examples:
V4.8 MP_ITEM:
value:
MPItemFeedHeader:
sellingChannel: marketplace
processMode: REPLACE
subset: EXTERNAL
locale: en
version: '4.8'
subCategory: home_other
MPItem:
- Orderable:
sku: testCardSku
productIdentifiers:
productIdType: GTIN
productId: '06146190200012'
productName: Ying Yang Apron, Abstract Graphic Design Yin Yang Circle Black and White Dots Pattern Cosmos and Energy, Unisex Kitchen Bib with Adjustable Neck for Cooking Gardening, Adult Size, Red, by Ambesonne
brand: davidson
price: 1
ShippingWeight: 1
MustShipAlone: 'No'
Visible:
Home Decor, Kitchen, & Other:
shortDescription: shelf
mainImageUrl: https://i5-qa.walmartimages.com/asr/9e9d04d1-6520-448e-b336-f40b7fb98707.c4c99539377709c2a9e332558177be8b.jpeg
keyFeatures:
- "@generated"
V4.5 OMNI_WFS:
value:
SupplierItemFeedHeader:
locale: en
mart: WALMART_US
processMode: REPLACE
requestBatchId: '1677739858'
requestId: '1677739858'
sellingChannel: fbw
subCategory: clothing_other
subset: EXTERNAL
version: '4.5'
SupplierItem:
- Orderable:
batteryTechnologyType: Does Not Contain a Battery
brand: Jane + Vogue
chemicalAerosolPesticide: 'No'
electronicsIndicator: 'No'
endDate: '2033-03-02T00:00:00.694Z'
price: 51.66
productIdentifiers:
productId: testProductId
productIdType: GTIN
productName: PLEATED SKORT
sku: testSku
stateRestrictions:
- stateRestrictionsText: None
TradeItem:
countryOfOriginAssembly:
- US - United States
each:
eachDepth: 5
eachGTIN: ''
eachHeight: 5
eachWeight: 1
eachWidth: 5
orderableGTIN: testGtin
sku: testSku
Visible:
Clothing:
ageGroup:
- Teen
- Adult
clothingSize: S
color:
- WASHED BLACK
colorCategory:
- Black
countryOfOriginTextiles: USA
gender: Female
mainImageUrl: http://cdn.shopify.com/s/files/1/0625/1770/6943/products/15442152_61f353b2-b8ec-45f8-9129-b6ced177a851.jpg?v=1661089729
manufacturer: Jane Vogue
productSecondaryImageURL:
- http://cdn.shopify.com/s/files/1/0625/1770/6943/products/15442152_7be883c4-fb3c-45a6-8123-f0968ca51bde.jpg?v=1661089724
- http://cdn.shopify.com/s/files/1/0625/1770/6943/products/15442152_15a9416a-14c1-499d-b299-d85eb9e8b804.jpg?v=1661089725
- http://cdn.shopify.com/s/files/1/0625/1770/6943/products/15442152_be74fd10-94ab-4597-8d4f-10b5f07d207b.jpg?v=1661089728
- http://cdn.shopify.com/s/files/1/0625/1770/6943/products/15442152_095a37fa-a2e9-4495-8f67-17c231bdd4e0.jpg?v=1661089733
prop65WarningText: None
smallPartsWarnings:
- 0 - No warning applicable
V4.3 MP_WFS_ITEM:
value:
MPItemFeedHeader:
subCategory: computers
sellingChannel: marketplacewfs
processMode: REPLACE
locale: en
version: '1.3'
subset: EXTERNAL
MPItem:
- Visible:
Computers:
warrantyText: This warranty covers any defects in materials or workmanship, including installation, with the exceptions of fading or discoloration caused by exposure to sunlight or chemicals. This warranty runs for five years from the date your carpet is installed. Counterpoint will either replace your carpet with new carpet of similar composition and price, or refund the full purchase price of your carpet, whichever you prefer. Contact Counterpoint at 800-867-5309... [continued].
productSecondaryImageURL:
- https://i5.walmartimages.com/asr/d67dfccc-3ffc-4752-ae10-b25cd587c7a9.e6d8c62517a21d945bd8e6dd38f3a0af.jpeg
color:
- Green
count: MFP00112BBQNMFP00112BBQNMFP00112BBQNMFP00112BBQNM
shortDescription: 'Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:'
keyFeatures:
- "
- Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:
- Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:
- Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:
"
manufacturer: MFP00112BBQNMFP00112BBQNMFP00112BBQNMFP00112BBQNMFP00112BBQ
manufacturerPartNumber: DeagoDeagoDeagoDeagoDeagoDeagoDeagoDeagoDeagoDeagoDeagoDeag
features:
- 'Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:'
countPerPack: 1234567890
globalBrandLicense:
- 'Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:'
msrp: 12345.98
modelNumber: TSR1002TSR1002TSR1002TSR1002TSR1002TSR1002TSR1002TSR1002345
mainImageUrl: https://i5-qa.walmartimages.com/asr/af93a111-934e-450c-bd94-9a747a72e415.e6d8c62517a21d945bd8e6dd38f3a0af.jpeg
colorCategory:
- Green
prop65WarningText: 'Frame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: AceFrame Material: Acetate Lens Material: Demo Lens Width: 52mmFrame Material: Acetate Lens Material:'
Orderable:
hasBatteries: 'Yes'
batteryTechnologyType: Lithium Ion
lithiumIonBatteries:
ionNumberOfBatteries: 10
ionNumberOfBatteryCells: 100
ionBatteryFormFactor: Button Cell
ionBatteryModel: abc
ionIncludedBatteryPackaging: Contained In
ionBatteryWeight: 9
batteryWattHour: 12
endDate: '2055-07-07T00:00:00.000Z'
externalProductIdentifier:
- externalProductIdType: ASIN
externalProductId: B002Z36VJE124
stateRestrictions:
- stateRestrictionsText: Commercial
zipCodes: '110009'
states: '123'
MustShipAlone: 'No'
productName: Tom Ford Optical FT5427-055-52 EyeglassesTom Ford Optical FT5427-055-52 EyeglassesTom Ford Optical FT5427-055-52 EyeglassesTom Ford Optical FT5427-055-52 EyeglassesTom Ford Optical FT5427-055-52 Eyeg
productIdentifiers:
productId: '06299501050766'
productIdType: GTIN
electronicsIndicator: 'Yes'
safetyDataSheet:
- http://xyz.com
numberOfHazardousComponents: 4
shipsInOriginalPackaging: 'No'
price: 100.9
batterySize: '12'
netContent:
productNetContentMeasure: 1.9
productNetContentUnit: Centimeter
chemicalAerosolPesticide: 'Yes'
sku: OpticalOpticalOpticalOpticalOpticalOpticalOptica01
brand: Tom FordTom FordTom FordTom FordTom FordTom FordTom FordToa
startDate: '2021-07-07T00:00:00.000Z'
TradeItem:
countryOfOriginAssembly:
- IN - India
pallet:
palletWeight: 14
palletWidth: 14
palletDepth: 14
palletHeight: 14
qtySellableItemsPallet: 14
palletGTIN: '06517410693158'
innerPack:
innerPackWidth: 14
innerPackHeight: 14
qtySellableItemsInnerPack: 14
innerPackGTIN: '06517393919160'
innerPackWeight: 14
innerPackDepth: 14
sku: OpticalOpticalOpticalOpticalOpticalOpticalOptica01
each:
eachDepth: 14
eachWeight: 14
eachWidth: 14
eachHeight: 14
eachGTIN: '06299501050766'
case:
qtySellableItemsCase: 14
caseHeight: 14
caseGTIN: '06517410543149'
caseWidth: 14
caseDepth: 14
caseWeight: 14
orderableGTIN: '06299501050766'
V4.8 MP_MAINTENANCE:
value:
MPItemFeedHeader:
sellingChannel: mpmaintenance
processMode: REPLACE
subset: EXTERNAL
locale: en
version: '4.8'
subCategory: computers
MPItem:
- Orderable:
sku: skum1_may23_fail01_test
productIdentifiers:
productIdType: GTIN
productId: '06848390988881'
productName: iPhone 14 pro max
brand: Apple
price: 299.99
startDate: '2023-05-23T07:00:00Z'
endDate: '2049-12-31T08:00:00Z'
shipsInOriginalPackaging: 'No'
MustShipAlone: 'No'
ShippingWeight: 4
Visible:
Computers:
shortDescription: test Desc fold
mainImageUrl: https://i5-qa.walmartimages.com/asr/7bec61bc-ec33-4334-8131-ecb8305e1e19.62d73c2f61f929ef580fe375e3597c13.jpeg
keyFeatures:
- "@generated"
V4.1 MP_ITEM_MATCH:
value:
MPItemFeedHeader:
processMode: REPLACE
subset: EXTERNAL
locale: en
sellingChannel: mpsetupbymatch
version: '4.1'
MPItem:
- Item:
sku: '00649081xxxxxx'
productIdentifiers:
productIdType: GTIN
productId: '00469710xxxxxx'
ShippingWeight: 1
price: 1
V4.2 MP_ITEM_MATCH:
value:
MPItemFeedHeader:
processMode: REPLACE
subset: EXTERNAL
locale: en
sellingChannel: mpsetupbymatch
version: '4.1'
MPItem:
- Item:
sku: '00649081xxxxxx'
condition: 'Pre-Owned: Fair'
mainImageUrl: https://i5-qa.walmartimages.com/asr/549ecbe9-c874-475b-87d8-5e4cb19934ec.8f5d70e62bd0bb8abc6772c9ef1694e0.jpeg
productIdentifiers:
productIdType: GTIN
productId: '00469710xxxxxx'
ShippingWeight: 1
price: 1
SHIPPING_OVERRIDES - Sample 1:
value:
ItemFeedHeader:
version: '1.0'
sellingChannel: overrides
locale: en
Item:
- Override:
sku: sku1
actionType: UPDATE
fulfilmentCenterId: '83746529874858430'
ShippingOverrides:
- ShippingOverride:
shipMethod: EXPEDITED
actionType: REPLACE
transit: 2
northeastRegionStates: CT,NJ,NY
midwestRegionStates: IA,MN
westRegionStates: CA,OR
southRegionStates: FL,AL
- ShippingOverride:
shipMethod: STANDARD
actionType: REPLACE
transit: 3
northeastRegionStates: CT,NJ,NY
midwestRegionStates: IA,MN
westRegionStates: CA,OR
southRegionStates: FL,AL
- ShippingOverride:
shipMethod: STANDARD
actionType: REPLACE
transit: 4
shipPrice: 6.55
northeastRegionStates: MA,NH
midwestRegionStates: WI,MI,IL
westRegionStates: WA,NV
southRegionStates: MS,GA
- ShippingOverride:
shipMethod: VALUE
actionType: REPLACE
transit: 9
nationWide: STREET_48_STATES
SHIPPING_OVERRIDES - Sample 2:
value:
ItemFeedHeader:
version: '1.0'
sellingChannel: overrides
locale: en
Item:
- Override:
sku: sku1
actionType: UPDATE
fulfilmentCenterId: '83746529874858430'
ShippingOverrides:
- ShippingOverride:
shipMethod: EXPEDITED
actionType: REPLACE
transit: 2
northeastRegionStates: NY
- ShippingOverride:
shipMethod: STANDARD
actionType: DELETE
SHIPPING_OVERRIDES - Sample 3:
value:
ItemFeedHeader:
version: '1.0'
sellingChannel: overrides
locale: en
Item:
- Override:
sku: sku1
actionType: DELETE
SKU_TEMPLATE_MAP - Sample 1:
value:
ItemFeedHeader:
sellingChannel: precisedelivery
locale: en
version: '1.0'
Item:
- PreciseDelivery:
sku: sku1
actionType: Add
shippingTemplateId: '8374652987346572'
fulfillmentCenterId: '83746529874858434'
- PreciseDelivery:
sku: sku2
shippingTemplateId: '8374652987346572'
actionType: Remove
fulfillmentCenterId: '83746529874858434'
RETIRE_ITEM:
value:
RetireItemHeader:
feedDate: '2020-01-22T00:59:14.000Z'
version: '1.0'
RetireItem:
- sku: '0960B3B82687490FA5E51CB0801478A4@AU8BAgA'
- sku: '0950B3B82687490FA5E51CB0801478A4@AU8BAgA'
required: true
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
feedId:
type: string
description: A unique ID, returned from the Bulk Upload API, used for tracking the feed file
additionalAttributes:
type: object
nullable: true
errors:
type: object
nullable: true
example:
feedId: F129C19240844B97A3C6AD8F1A2C4997@AU8BAQA
application/xml:
schema:
type: object
properties:
feedId:
type: string
description: A unique ID, returned from the Bulk Upload API, used for tracking the feed file
additionalAttributes:
type: object
nullable: true
errors:
type: object
nullable: true
example: |-
FF39857B290A46AFB28297E63AB64FAD@AU8BAgA
"/v3/items":
get:
tags:
- Items
summary: Walmart All Items
description: Displays a list of all items by using either nextCursor or offset and limit query parameters
externalDocs:
description: View Guide
url: "/doc/us/mp/us-mp-items/#2535"
operationId: getAllItems
parameters:
- name: nextCursor
in: query
description: Used for pagination when more than 200 items are retrieved.nextCursor value received in response will be same for all subsequent page requests.
required: false
schema:
type: string
default: "*"
- name: sku
in: query
description: 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.
required: false
schema:
type: string
- name: offset
in: query
description: 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.
required: false
schema:
type: string
default: '0'
- name: limit
in: query
description: The number of entities to be returned. It cannot be more than 50 entities. Use it only when the includeDetails is set to true.
required: false
schema:
type: string
default: '20'
- name: lifecycleStatus
in: query
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
required: false
schema:
type: string
- name: publishedStatus
in: query
description: The published status of an item describes where the item is in the submission process. Examples of allowed values are PUBLISHED, UNPUBLISHED.
required: false
schema:
type: string
- name: variantGroupId
in: query
description: Variant Id to retrieve all items with the same variant id
required: false
schema:
type: string
- name: condition
in: query
description: The value of product condition, (e.g. Restored).
required: false
schema:
type: string
description: Allowed Values
enum:
- New
- New without box
- New without tags
- Restored Premium
- Restored
- Remanufactured
- Open Box
- 'Pre-Owned: Like New'
- 'Pre-Owned: Good'
- 'Pre-Owned: Fair'
- New with defects
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
required:
- ItemResponse
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
ItemResponse:
type: array
description: Items included in the response list
items:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
xml:
name: ItemResponse
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
totalItems:
type: integer
description: Total items for the query
format: int64
nextCursor:
type: string
description: Used for pagination to fetch the next set of items
xml:
name: ItemResponses
examples:
Get All Items:
value:
ItemResponse:
- mart: WALMART_US
sku: '2792005'
condition: New
wpid: 0RE1TWYTKBKH
upc: '886859944807'
gtin: '00886859944807'
productName: Carhartt Men's Rugged Vest
shelf: '["Home Page","Clothing","Mens Clothing","Mens Jackets & Outerwear","Mens Jackets & Outerwear"]'
productType: Outerwear Coats, Jackets & Vests
price:
currency: USD
amount: 59.99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4534200'
condition: New
wpid: 0RFL011ILHS3
upc: '889192592087'
gtin: '00889192592087'
productName: Carhartt Women's Slim-Fit Layton Skinny Leg Jean
shelf: '["UNNAV"]'
productType: Jeans
price:
currency: USD
amount: 49.99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4419464'
condition: New
wpid: 0RFUYQBZLPP5
upc: '889169324734'
gtin: '00889169324734'
productName: Marmot Women's Minimalist Jacket
shelf: '["Home Page","Clothing","Women","Womens Coats & Jackets Shop All"]'
productType: Outerwear Coats, Jackets & Vests
price:
currency: USD
amount: 189
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '2928108'
condition: New
wpid: 0RH410PGF6E5
upc: '883956217001'
gtin: '00883956217001'
productName: Olukai Women's Upena Sandal
shelf: '["Home Page","Clothing","Shoes","Womens Shoes","Womens Sandals & Flip-flops","Womens Sandals"]'
productType: Sandals
price:
currency: USD
amount: 89.95
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5261089'
condition: New
wpid: 0RH97MRCNV5N
upc: '192660552293'
gtin: '00192660552293'
productName: Sorel Men's Madson 6' Waterproof Boot
shelf: '["Home Page","Clothing","Fashion Brands","SOREL"]'
productType: Boots
price:
currency: USD
amount: 190
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: NIJDJuuyUKhQQei
condition: New
wpid: 0RJMCVFI97KQ
upc: ''
gtin: '05828799302366'
productName: Electronic Cables
shelf: '["Home Page","Electronics","Computers","Computer Accessories","Computer Cables & Connectors"]'
productType: Computer Cables
price:
currency: USD
amount: 70
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- Your item is unpublished because the end date has passed. To republish your item, re-ingest the item with a new start and end date.
lifecycleStatus: RETIRED
- mart: WALMART_US
sku: '4533814'
condition: New
wpid: 0RLL9EUVVD10
upc: '889192891555'
gtin: '00889192891555'
productName: Carhartt Women's Force Delmont Graphic Zip-Front Hooded Sweatshirt
shelf: '["Home Page","Clothing","Women","Womens Sweaters"]'
productType: Sweatshirts & Hoodies
price:
currency: USD
amount: 59.99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5310435'
condition: New
wpid: 0RLSXHJMCII7
upc: '192660208312'
gtin: '00192660208312'
productName: Columbia Men's Chuterunner II Jacket
shelf: '["Home Page","Clothing","Mens Clothing","Mens Jackets & Outerwear","Mens Jackets & Outerwear"]'
productType: Outerwear Coats, Jackets & Vests
price:
currency: USD
amount: 149.95
publishedStatus: SYSTEM_PROBLEM
unpublishedReasons:
reason:
- I'm sorry, This unpublished reason code is currently unavailable!
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '3427438'
condition: New
wpid: 0RMEAISSF4V9
upc: '889169893346'
gtin: '00889169893346'
productName: Marmot Women's Trestles 30 Sleeping Bag
shelf: '["Home Page","Sports & Outdoors","Outdoor Sports","Camping Gear","Sleeping Bags","All Sleeping Bags"]'
productType: Sleeping Bags
price:
currency: USD
amount: 99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4911960'
condition: New
wpid: 0RNG6F9OM2TE
upc: '840054386015'
gtin: '00840054386015'
productName: Lowa Women's Renegade GTX Mid Boot
shelf: '["Home Page","Clothing","Shoes","Womens Shoes","Womens Boots","Womens Boots"]'
productType: Athletic Boots
price:
currency: USD
amount: 239.95
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: 4RL3E7TaH9XMNU7
condition: New
wpid: 0ROA3CD37TAG
upc: ''
gtin: '05674399098693'
productName: Electronic Cables
shelf: '["Home Page","Electronics","Computers","Computer Accessories","Computer Cables & Connectors"]'
productType: default
price:
currency: USD
amount: 10
publishedStatus: PUBLISHED
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5630947'
condition: New
wpid: 0RQKGXE7IEAS
upc: '686487434462'
gtin: '00686487434462'
productName: Arcteryx Women's Solano Coat
shelf: '["Home Page","Clothing","Women","Womens Coats & Jackets Shop All"]'
productType: default
price:
currency: USD
amount: 278.95
publishedStatus: SYSTEM_PROBLEM
unpublishedReasons:
reason:
- I'm sorry, This unpublished reason code is currently unavailable!
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4420606'
condition: New
wpid: 0RQWE8ZXEIAF
upc: '889169336805'
gtin: '00889169336805'
productName: Marmot Men's Fordham Jacket
shelf: '["Home Page","Sports & Outdoors","Outdoor Sports","Hunting","Hunting Clothing","All Hunting Clothing"]'
productType: Hunting Camouflage Accessories
price:
currency: USD
amount: 325
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- There is no primary image for your item. After you re-ingest this item with a valid primary image, your item will be republished.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '3545919'
condition: New
wpid: 0RUD5HUYY0NX
upc: '849948011187'
gtin: '00849948011187'
productName: Evolv Men's Cruzer Classic Shoe
shelf: '["Home Page","Seasonal","Back to School","Shoes","TestNike"]'
productType: Athletic Shoes
price:
currency: USD
amount: 74.95
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5210754'
condition: New
wpid: 0RUECSVSBNCV
upc: '888555358681'
gtin: '00888555358681'
productName: Obermeyer Teen Girl's Haana Jacket
shelf: '["UNNAV"]'
productType: T-Shirts
price:
currency: USD
amount: 159.5
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- There is no primary image for your item. After you re-ingest this item with a valid primary image, your item will be republished.
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- An internal error occurred while publishing this item. Please re-ingest the item.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '04496546160869'
condition: New
wpid: 0RVR1D7PSH41
upc: ''
gtin: '04496546160869'
productName: HP_CLOTHING_CATEGORY_PRODUCT_NAME
shelf: '["Home Page","Feature","levis signature redirect","Levi Strauss, Jeans, Jackets & Clothing"]'
productType: Button-Up Shirts
price:
currency: USD
amount: 90
publishedStatus: IN_PROGRESS
unpublishedReasons:
reason:
- I'm sorry, This unpublished reason code is currently unavailable!
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5169869'
condition: New
wpid: 0RW326S9PV3B
upc: '888663254257'
gtin: '00888663254257'
productName: Mountain Hardwear Women's Monkey/2 Pullover
shelf: '["Home Page","Clothing","Women","Womens Tops & T-Shirts","Womens Tops & T-Shirts"]'
productType: Pajamas
price:
currency: USD
amount: 149.95
publishedStatus: SYSTEM_PROBLEM
unpublishedReasons:
reason:
- I'm sorry, This unpublished reason code is currently unavailable!
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '3829582'
condition: New
wpid: 0RWVCEBGBI9O
upc: '888664177418'
gtin: '00888664177418'
productName: Columbia Men's Bugaboo Omni-Heat Suspender Pant
shelf: '["Home Page","Clothing","Mens Clothing","Mens Pants","Mens Pants"]'
productType: Pants
price:
currency: USD
amount: 119.95
publishedStatus: SYSTEM_PROBLEM
unpublishedReasons:
reason:
- I'm sorry, This unpublished reason code is currently unavailable!
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '5848656'
condition: New
wpid: 0RXA6XP9LO34
upc: '840054406836'
gtin: '00840054406836'
productName: Lowa Men's Renegade GTX Mid Boot
shelf: '["UNNAV"]'
productType: Athletic Boots
price:
currency: USD
amount: 239.95
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4364805'
condition: New
wpid: 0RXZMHYOF3YN
upc: '686487307056'
gtin: '00686487307056'
productName: Arcteryx Women's RHO LT Zip Neck Hooded
shelf: '["UNNAV"]'
productType: Sweatshirts & Hoodies
price:
currency: USD
amount: 139
publishedStatus: SYSTEM_PROBLEM
unpublishedReasons:
reason:
- This item is prohibited because it violates one of our legal or compliance policies. For more details, create a case for Partner Support and include the code COMP.
lifecycleStatus: ACTIVE
totalItems: 11440
nextCursor: AoE/GjBSWFpNSFlPRjNZTjBTRUxMRVJfT0ZGRVI1QUFDOTZFNzcyRjc0NkE1OTU5QjUxQTdGMUJFQTY5OQ==
With Variant Information:
value:
ItemResponse:
- mart: WALMART_US
sku: '2792005'
wpid: 0RE1TWYTKBKH
upc: '886859944807'
gtin: '00886859944807'
productName: Carhartt Men's Rugged Vest
shelf: '["Home Page","Clothing","Mens Clothing","Mens Jackets & Outerwear","Mens Jackets & Outerwear"]'
productType: Outerwear Coats, Jackets & Vests
price:
currency: USD
amount: 59.99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
variantGroupInfo:
groupingAttributes:
- name: actual_color
value: '1234567890'
isPrimary: 'true'
variantGroupId: Toysgroup0101
- mart: WALMART_US
sku: '4534200'
wpid: 0RFL011ILHS3
upc: '889192592087'
gtin: '00889192592087'
productName: Carhartt Women's Slim-Fit Layton Skinny Leg Jean
shelf: '["UNNAV"]'
productType: Jeans
price:
currency: USD
amount: 49.99
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
- mart: WALMART_US
sku: '4419464'
wpid: 0RFUYQBZLPP5
upc: '889169324734'
gtin: '00889169324734'
productName: Marmot Women's Minimalist Jacket
shelf: '["Home Page","Clothing","Women","Womens Coats & Jackets Shop All"]'
productType: Outerwear Coats, Jackets & Vests
price:
currency: USD
amount: 189
publishedStatus: UNPUBLISHED
unpublishedReasons:
reason:
- No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
- You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
lifecycleStatus: ACTIVE
totalItems: 11440
nextCursor: AoE/GjBSWFpNSFlPRjNZTjBTRUxMRVJfT0ZGRVI1QUFDOTZFNzcyRjc0NkE1OTU5QjUxQTdGMUJFQTY5OQ==
application/xml:
schema:
required:
- ItemResponse
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
ItemResponse:
type: array
description: Items included in the response list
items:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
xml:
name: ItemResponse
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
totalItems:
type: integer
description: Total items for the query
format: int64
nextCursor:
type: string
description: Used for pagination to fetch the next set of items
xml:
name: ItemResponses
example: |-
WALMART_US
2792005
New
0RE1TWYTKBKH
886859944807
00886859944807
Carhartt Men's Rugged Vest
["Home Page","Clothing","Mens Clothing","Mens Jackets & Outerwear","Mens Jackets & Outerwear"]
Outerwear Coats, Jackets & Vests
USD
59.99
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
4534200
New
0RFL011ILHS3
889192592087
00889192592087
Carhartt Women's Slim-Fit Layton Skinny Leg Jean
["UNNAV"]
Jeans
USD
49.99
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
4419464
New
0RFUYQBZLPP5
889169324734
00889169324734
Marmot Women's Minimalist Jacket
["Home Page","Clothing","Women","Womens Coats & Jackets Shop All"]
Outerwear Coats, Jackets & Vests
USD
189.0
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
2928108
New
0RH410PGF6E5
883956217001
00883956217001
Olukai Women's Upena Sandal
["Home Page","Clothing","Shoes","Womens Shoes","Womens Sandals & Flip-flops","Womens Sandals"]
Sandals
USD
89.95
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
5261089
New
0RH97MRCNV5N
192660552293
00192660552293
Sorel Men's Madson 6' Waterproof Boot
["Home Page","Clothing","Fashion Brands","SOREL"]
Boots
USD
190.0
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
NIJDJuuyUKhQQei
New
0RJMCVFI97KQ
05828799302366
Electronic Cables
["Home Page","Electronics","Computers","Computer Accessories","Computer Cables & Connectors"]
Computer Cables
USD
70.0
UNPUBLISHED
Your item is unpublished because the end date has passed. To republish your item, re-ingest the item with a new start and end date.
RETIRED
WALMART_US
4533814
New
0RLL9EUVVD10
889192891555
00889192891555
Carhartt Women's Force Delmont Graphic Zip-Front Hooded Sweatshirt
["Home Page","Clothing","Women","Womens Sweaters"]
Sweatshirts & Hoodies
USD
59.99
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
5310435
New
0RLSXHJMCII7
192660208312
00192660208312
Columbia Men's Chuterunner II Jacket
["Home Page","Clothing","Mens Clothing","Mens Jackets & Outerwear","Mens Jackets & Outerwear"]
Outerwear Coats, Jackets & Vests
USD
149.95
SYSTEM_PROBLEM
I'm sorry, This unpublished reason code is currently unavailable!
ACTIVE
WALMART_US
3427438
New
0RMEAISSF4V9
889169893346
00889169893346
Marmot Women's Trestles 30 Sleeping Bag
["Home Page","Sports & Outdoors","Outdoor Sports","Camping Gear","Sleeping Bags","All Sleeping Bags"]
Sleeping Bags
USD
99.0
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
4911960
New
0RNG6F9OM2TE
840054386015
00840054386015
Lowa Women's Renegade GTX Mid Boot
["Home Page","Clothing","Shoes","Womens Shoes","Womens Boots","Womens Boots"]
Athletic Boots
USD
239.95
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
4RL3E7TaH9XMNU7
New
0ROA3CD37TAG
05674399098693
Electronic Cables
["Home Page","Electronics","Computers","Computer Accessories","Computer Cables & Connectors"]
default
USD
10.0
PUBLISHED
ACTIVE
WALMART_US
5630947
New
0RQKGXE7IEAS
686487434462
00686487434462
Arcteryx Women's Solano Coat
["Home Page","Clothing","Women","Womens Coats & Jackets Shop All"]
default
USD
278.95
SYSTEM_PROBLEM
I'm sorry, This unpublished reason code is currently unavailable!
ACTIVE
WALMART_US
4420606
New
0RQWE8ZXEIAF
889169336805
00889169336805
Marmot Men's Fordham Jacket
["Home Page","Sports & Outdoors","Outdoor Sports","Hunting","Hunting Clothing","All Hunting Clothing"]
Hunting Camouflage Accessories
USD
325.0
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
There is no primary image for your item. After you re-ingest this item with a valid primary image, your item will be republished.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
3545919
New
0RUD5HUYY0NX
849948011187
00849948011187
Evolv Men's Cruzer Classic Shoe
["Home Page","Seasonal","Back to School","Shoes","TestNike"]
Athletic Shoes
USD
74.95
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
5210754
New
0RUECSVSBNCV
888555358681
00888555358681
Obermeyer Teen Girl's Haana Jacket
["UNNAV"]
T-Shirts
USD
159.5
UNPUBLISHED
There is no primary image for your item. After you re-ingest this item with a valid primary image, your item will be republished.
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
An internal error occurred while publishing this item. Please re-ingest the item.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
04496546160869
New
0RVR1D7PSH41
04496546160869
HP_CLOTHING_CATEGORY_PRODUCT_NAME
["Home Page","Feature","levis signature redirect","Levi Strauss, Jeans, Jackets & Clothing"]
Button-Up Shirts
USD
90.0
IN_PROGRESS
I'm sorry, This unpublished reason code is currently unavailable!
ACTIVE
WALMART_US
5169869
New
0RW326S9PV3B
888663254257
00888663254257
Mountain Hardwear Women's Monkey/2 Pullover
["Home Page","Clothing","Women","Womens Tops & T-Shirts","Womens Tops & T-Shirts"]
Pajamas
USD
149.95
SYSTEM_PROBLEM
I'm sorry, This unpublished reason code is currently unavailable!
ACTIVE
WALMART_US
3829582
New
0RWVCEBGBI9O
888664177418
00888664177418
Columbia Men's Bugaboo Omni-Heat Suspender Pant
["Home Page","Clothing","Mens Clothing","Mens Pants","Mens Pants"]
Pants
USD
119.95
SYSTEM_PROBLEM
I'm sorry, This unpublished reason code is currently unavailable!
ACTIVE
WALMART_US
5848656
New
0RXA6XP9LO34
840054406836
00840054406836
Lowa Men's Renegade GTX Mid Boot
["UNNAV"]
Athletic Boots
USD
239.95
UNPUBLISHED
No shipping information was set up. Please re - ingest this item with a shipping price if you are submitting an over - ride.
You did not assign a tax code to your listing during item setup. Please re-ingest your item with a valid tax code.
ACTIVE
WALMART_US
4364805
New
0RXZMHYOF3YN
686487307056
00686487307056
Arcteryx Women's RHO LT Zip Neck Hooded
["UNNAV"]
Sweatshirts & Hoodies
USD
139.0
SYSTEM_PROBLEM
This item is prohibited because it violates one of our legal or compliance policies. For more details, create a case for Partner Support and include the code COMP.
ACTIVE
11440
AoE/GjBSWFpNSFlPRjNZTjBTRUxMRVJfT0ZGRVI1QUFDOTZFNzcyRjc0NkE1OTU5QjUxQTdGMUJFQTY5OQ==
useCases:
- name: Get All Item Lc And Publishedstatus Invalid
value: get_all_item_LC_and_PublishedStatus_invalid
sha: d3d00f57f3f5db6ed5d25ca0178e547841ea96d9
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/failure/get_all_item_LC_and_PublishedStatus_invalid?token=AAAUDV5LGUQSF7CO3CP7V6LGMMIEI
case: failure
- name: Get All Item Lc Invalid
value: get_all_item_LC_invalid
sha: e595b3ddbd51be45fa0c5932de712cc83e2c4d60
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/failure/get_all_item_LC_invalid?token=AAAUDVY4OHJUWGSB2XLBPKTGMMIEI
case: failure
- name: Get All Item Publishedstatus Invalid
value: get_all_item_publishedStatus_invalid
sha: a27767fc969ccfa8482ebd634becf80956f55112
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/failure/get_all_item_publishedStatus_invalid?token=AAAUDV76GOLJSGW7NHW6HZDGMMIEI
case: failure
- name: Get All Item
value: get_all_item
sha: 25a4cf25e3655abedcaf74602a6bbb67c5904330
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item?token=AAAUDV6MGKFLBLT6YZ6OM2LGMMIEI
case: success
- name: Get All Item Lc And Publishedstatus
value: get_all_item_LC_and_publishedStatus
sha: 82b6782805578d9ef6a140573f47dcfc735fbc44
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_LC_and_publishedStatus?token=AAAUDVZ642W45JPW6FEHPPLGMMIEI
case: success
- name: Get All Item Lc Publish Offset Limit
value: get_all_item_LC_publish_offset_limit
sha: 33778f747ad6c1c88a971a68200def333b1d1f6d
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_LC_publish_offset_limit?token=AAAUDV2GHTRYGLLMB4DF26LGMMIEI
case: success
- name: Get All Item With Offset Limit
value: get_all_item_with_offset_limit
sha: c04e46ddde36fb0409f6c79a308e0035d198eaf2
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_with_offset_limit?token=AAAUDV3QP2E4WKBG6YAYFG3GMMIEI
case: success
- name: Get All Item With Publishedstatus
value: get_all_item_with_publishedStatus
sha: 228769943a00cf0a38a18427042dd38aa9bed131
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_with_publishedStatus?token=AAAUDVYFZOTXFYYPWUKQGG3GMMIEI
case: success
- name: Get All Item With Sku
value: get_all_item_with_sku
sha: be9219dbbd756af98c74fe3090a7b98a43c5121a
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_with_sku?token=AAAUDV2YXF7AWJIHPEOPBO3GMMIEI
case: success
- name: Get All Item With Sku And Publishedstatus
value: get_all_item_with_sku_and_publishedStatus
sha: f580683d9227367cfde3bc0999c922b121c17e75
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_with_sku_and_publishedStatus?token=AAAUDV3LVH2JPJVOCYRDJGLGMMIEI
case: success
- name: Get All Item With Variantgroupid
value: get_all_item_with_variantGroupId
sha: 87dce485e9997b1100420e6884e05ba7ae18f487
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_item_with_variantGroupId?token=AAAUDV7SIB5NM2QTZG3JZH3GMMIEI
case: success
- name: Get All Items Lcstatus
value: get_all_items_LCstatus
sha: f9d432b94835e611f3d7c57f46812df54760e7b9
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAllItems/success/get_all_items_LCstatus?token=AAAUDVYNMX2OAX34XHLJD5TGMMIEI
case: success
"/v3/items/{id}":
get:
tags:
- Items
summary: Walmart an Item
description: Retrieves an item and displays the item details.
externalDocs:
description: View Guide
url: "/doc/us/mp/us-mp-items/#2535"
operationId: getAnItem
parameters:
- name: id
in: path
description: 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.
required: true
schema:
type: string
- name: productIdType
in: query
description: Item code type specifier allows to filter by specific code type, (e.g. GTIN).
required: true
schema:
type: string
description: Allowed Values
enum:
- GTIN
- UPC
- ISBN
- EAN
- SKU
- ITEM_ID
- name: condition
in: query
description: The value of product condition, (e.g. Restored).
required: false
schema:
type: string
description: Allowed Values
enum:
- New
- New without box
- New without tags
- Restored Premium
- Restored
- Remanufactured
- Open Box
- 'Pre-Owned: Like New'
- 'Pre-Owned: Good'
- 'Pre-Owned: Fair'
- New with defects
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
responseRecord:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
xml:
name: ItemResponse
example:
ItemResponse:
- mart: WALMART_US
sku: 30348_KFTest
condition: New
wpid: 0RCPILAXM0C1
upc: ''
gtin: '06932096330348'
productName: Kidsform Adjustable Infant Baby Carrier Sling Wrap Rider Carrier Backpack Front/Back Pack Khaki, Blue, Pink 4 Carrying Position Modes With Storage Bag
shelf: '["Home Page","Baby","Baby Activities & Gear","Baby Carriers"]'
productType: Baby Carriers
price:
currency: USD
amount: 3
publishedStatus: PUBLISHED
lifecycleStatus: ACTIVE
totalItems: 1
application/xml:
schema:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
xml:
name: ItemResponse
example: |
WALMART_US
setup_by_ref
New
2VYRD2YCHYX1
05518319011365
WL_Sim_verizon
Music
USD
12.00
UNPUBLISHED
Your item is unpublished because the end date has passed. To republish your item, re-ingest the item with a new start and end date.
RETIRED
useCases:
- name: Get Item Productidtype Invalid
value: get_item_productIdType_invalid
sha: 4a57fdee7720915c6a262821448f73cb68f77ad6
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/failure/get_item_productIdType_invalid?token=AAAUDVYC4J36J3LHNQ4VJGDGMMIEK
case: failure
- name: Get Item By Ean
value: get_item_by_ean
sha: b1d47b7cfe41af8d1b19fb1a43d06a17631f6aa3
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_ean?token=AAAUDV63RSABWCN2IKAYWF3GMMIEK
case: success
- name: Get Item By Gtin
value: get_item_by_gtin
sha: 5c553e16cb72db54171db56dbebcd36049ac5b4f
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_gtin?token=AAAUDV4X4G2L3WWCSTFM5UDGMMIEK
case: success
- name: Get Item By Isbn
value: get_item_by_isbn
sha: a9c6a40dd9e24579b3196a55a9910d210c3e3ff7
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_isbn?token=AAAUDV4EZK5TKTIQUZS6P33GMMIEK
case: success
- name: Get Item By Item Id
value: get_item_by_item_id
sha: 46e20e46eaf283d311315526897638e89b41d3d9
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_item_id?token=AAAUDV73444AO4FR54JRS23GMMIEK
case: success
- name: Get Item By Sku
value: get_item_by_sku
sha: 56c0d8b700e361752c97bdf2c6b2d0f39eb32b59
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_sku?token=AAAUDVY44MPKWA56FNCTPY3GMMIEK
case: success
- name: Get Item By Upc
value: get_item_by_upc
sha: fb6cb1d7a42f46cc2ed6f76d323c4fce4fcb955d
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getAnItem/success/get_item_by_upc?token=AAAUDVZC57ZPUGRGHRA5VBDGMMIEK
case: success
"/v3/items/walmart/search":
get:
tags:
- Items
summary: Walmart Item Search
description: |-
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.
externalDocs:
description: View Guide
url: "/doc/us/mp/us-mp-items/#2518"
operationId: getSearchResult
parameters:
- name: query
in: query
description: Specifies a keyword search as a String.
required: false
schema:
type: string
default: ''
- name: upc
in: query
description: Specifies a Universal Product Code (UPC) search. UPC must be 12 digits.
required: false
schema:
type: string
default: ''
- name: gtin
in: query
description: Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits.
required: false
schema:
type: string
default: ''
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
itemId:
type: string
description: Specifies the item identifier generated by Walmart.
condition:
type: string
description: Specifies the condition of the item.
isMarketPlaceItem:
type: boolean
description: Specifies whether or not this item is available by other sellers in the Marketplace.
images:
type: array
description: Provides images associated with the item product listing.
items:
type: object
properties:
url:
type: string
description: Provides images associated with the item product listing.
customerRating:
type: string
price:
type: object
properties:
amount:
type: string
currency:
type: string
description: Specifies item purchase price information, including currency and amount.
description:
type: string
description: Specifies the catalog item description.
title:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain''.'
brand:
type: string
description: Specifies the item brand.
productType:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the Product Type. Example: ''Diamond''.'
properties:
type: object
properties:
variant_items_num:
type: string
num_reviews:
type: string
categories:
type: array
items:
type: string
variants:
type: object
properties:
variantMeta:
type: array
items:
type: object
properties:
name:
type: string
variantData:
type: array
items:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
next_day_eligible:
type: boolean
example:
items:
- itemId: '393016031'
condition: New
isMarketPlaceItem: true
images:
- url: http://i5.walmartimages.com/asr/556cc5a5-e729-4e48-b801-0146bbc97cdb_1.97507cfd7df5ca0fb6570e6a36495016.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
- url: http://i5.walmartimages.com/asr/556cc5a5-e729-4e48-b801-0146bbc97cdb_1.97507cfd7df5ca0fb6570e6a36495016.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
customerRating: '3.799999952316284'
price:
amount: '12.989999771118164'
currency: USD
description: "Designed for Apple iPad mini 1/2/3Hybrid Silicone/PC Protective Shell with KickstandShock-Absorption Cases Protection Case for boys girls"
title: "iPad mini 3/ 2 /1 Case, ULAK Three Layer Hybrid Heavy Duty Shockproof Protective Case with Kickstand for Apple iPad Mini,iPad Mini 2,iPad Mini 3"
brand: ULAK
productType: VARIANT
properties:
variant_items_num: '5'
num_reviews: '16'
categories:
- Electronics
- iPad & Tablets
- Apple iPad Accessories
- iPad Cases, Sleeves & Bags
variants:
variantMeta:
- name: actual_color
variantData:
- productImageUrl: https://i5.walmartimages.com/asr/82b8c484-651b-4e50-979c-42164649b8c5_1.bcf0b3a35d5767ee402c06b26a25f191.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
itemId: '936491618'
isAvailable: Y
title: iPad mini 3/ 2 /1 Case, ULAK Three Layer Hybrid Heavy Duty Shockproof Protective Case with Kickstand for Apple iPad Mini,iPad Mini 2,iPad Mini 3
variantValues:
- name: actual_color
value: Black/Black
- productImageUrl: https://i5.walmartimages.com/asr/e3d7c2bd-55d2-41ab-97b8-59c441918307_1.5f96dab5b8eddf4eb4857103a8c54913.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
itemId: '865777580'
isAvailable: N
title: iPad mini 3 Case, iPad mini 2 Case, iPad mini Case, ULAK Three Layer Hybrid Heavy Duty Shockproof Protective Case with Kickstand for Apple iPad Mini,iPad Mini 2,iPad Mini 3
variantValues:
- name: actual_color
value: Black/Blue
- productImageUrl: https://i5.walmartimages.com/asr/556cc5a5-e729-4e48-b801-0146bbc97cdb_1.97507cfd7df5ca0fb6570e6a36495016.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
itemId: '393016031'
isAvailable: N
title: iPad mini 3/ 2 /1 Case, ULAK Three Layer Hybrid Heavy Duty Shockproof Protective Case with Kickstand for Apple iPad Mini,iPad Mini 2,iPad Mini 3
variantValues:
- name: actual_color
value: Blue+Lime Green
- productImageUrl: https://i5.walmartimages.com/asr/5920a66b-a944-47c5-8ada-d1621d379ca9_1.4a20b40c528c6f8553f66043f38841e7.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
itemId: '451755050'
isAvailable: Y
title: iPad mini 3/ 2 /1 Case, ULAK Three Layer Hybrid Heavy Duty Shockproof Protective Case with Kickstand for Apple iPad Mini,iPad Mini 2,iPad Mini 3
variantValues:
- name: actual_color
value: Mint Green/Grey
- productImageUrl: https://i5.walmartimages.com/asr/ba395bef-48bf-46ac-8322-962e381c4e81_1.ea83239b1d41dc6e49521c2d1026f9f5.jpeg?odnHeight=180&odnWidth=180&odnBg=ffffff
itemId: '800154739'
isAvailable: Y
title: iPad Mini Case,iPad Mini 2 Case,iPad Mini 3 Case,iPad mini Retina Case,ULAK Three Layer Heavy Duty Shockproof Protective Case Cover Kickstand, Pink
variantValues:
- name: actual_color
value: Rose Gold/Rose Gold
next_day_eligible: false
useCases:
- name: Item Search Not Found
value: item_search_not_found
sha: 87fe3ae5fa8db11dc3db96e92e69b13a51043c09
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getSearchResult/failure/item_search_not_found?token=AAAUDV2LVJHLTASSIJQFDJLGMMIEK
case: failure
- name: Item Search By Gtin
value: item_search_by_gtin
sha: d1f0cdf57a154ec24006acbdd17fa29d77a62b9b
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getSearchResult/success/item_search_by_gtin?token=AAAUDV5V3TKRNPNLWTLL2ODGMMIEK
case: success
- name: Item Search By Query
value: item_search_by_query
sha: 98452849cb4ba674d1695498b3771ecb9535f28d
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getSearchResult/success/item_search_by_query?token=AAAUDV2MNT5DIOETDEXXVULGMMIEK
case: success
- name: Item Search By Upc
value: item_search_by_upc
sha: f9db5dc30d7293ceab8a0534ea5097bcd91ee9fb
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getSearchResult/success/item_search_by_upc?token=AAAUDVYNECUBLVSVTK3YVTTGMMIEK
case: success
"/v3/items/taxonomy":
get:
tags:
- Items
summary: Walmart Taxonomy
description: |-
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.
operationId: getTaxonomyResponse
parameters:
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
status:
type: string
payload:
type: array
items:
type: object
properties:
category:
type: string
description: Type of item
subcategory:
type: array
description: Specific kind of category
items:
type: object
properties:
subCategoryName:
type: string
description: Name of specific kind of category
subCategoryId:
type: string
description: ID of specific kind of category
description: Specific kind of category
example:
status: SUCCESS
payload:
- category: Animal
subcategory:
- subCategoryName: Animal Accessories
subCategoryId: 559c5d924fff3d64de18bf45
- subCategoryName: Animal Food
subCategoryId: 559c5d8f4fff3d64de18bf3d
- subCategoryName: Animal Health & Grooming
subCategoryId: 559c5d90ed25b136f13a05df
- subCategoryName: Animal Other
subCategoryId: 56f2eb66208f9a06158f1748
- category: Art & Craft
subcategory:
- subCategoryName: Art & Craft
subCategoryId: 571fdff7208f9a0cdb760a7f
useCases:
- name: Taxonomy
value: taxonomy
sha: 6b0a38e19f92fb9b809a7f2e010b1ef82d0cff37
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getTaxonomyResponse/success/taxonomy?token=AAAUDV4YDRMHPJS3QXPRCZTGMMIEM
case: success
- name: Taxonomy By Category
value: taxonomy_by_category
sha: d35154a36fd3aa6384a0004b8a144678cea7e8ce
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getTaxonomyResponse/success/taxonomy_by_category?token=AAAUDV26DYHP46MP4VG6PZ3GMMIEM
case: success
"/v3/items/groups/count":
get:
tags:
- Items
summary: Walmart Get Item Count by Groups
description: Get total count of items based on variant group information
operationId: getVariantCount
parameters:
- name: variantGroupId
in: query
description: Variant Id to retrieve
required: false
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Response Status
payload:
type: array
description: Items included in the response list
items:
type: object
properties:
variantGroupId:
type: string
description: variant group id used to create the groups
count:
type: string
description: count of items having the same variant group id
description: Items included in the response list
example:
status: 200
payload:
- variantGroupId: VGWATER130
count: 1
- variantGroupId: WFSGRP22
count: 5
- variantGroupId: VGS-3B-CASE
count: 2
- variantGroupId: VAXGRP2020_3
count: 1
- variantGroupId: '00640854493919'
count: 1
useCases:
- name: Get Item Count By Group
value: get_item_count_by_group
sha: 1d0d6240a884830a34a63f2e84fa34ce75adc4c5
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getVariantCount/success/get_item_count_by_group?token=AAAUDVYOAYC6LK5AXZMZKZ3GMMIEM
case: success
- name: Get Item Count By Varient
value: get_item_count_by_varient
sha: ad43e1b161ed7d6fef226b4b9fb42a52a0386538
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getVariantCount/success/get_item_count_by_varient?token=AAAUDV6LTKHOI3J3NHOQ2PLGMMIEM
case: success
"/v3/items/count":
get:
tags:
- Items
summary: Walmart Get Items Count by Status
description: Get total count of items based on status
operationId: getCountByStatus
parameters:
- name: status
in: query
description: Status of Item
required: false
schema:
type: string
description: Allowed Status
enum:
- PUBLISHED
- UNPUBLISHED
- SYSTEM_PROBLEM
- IN_PROGRESS
- ALL
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
type: string
examples:
ALL:
value:
All: 682
PUBLISHED:
value:
PUBLISHED: 99
UNPUBLISHED:
value:
UNPUBLISHED: 383
useCases:
- name: Get Item Count By Invalid Status
value: get_item_count_by_invalid_status
sha: 4ad41334be506c75bc18c5ee6357f4fa255a2dab
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCountByStatus/failure/get_item_count_by_invalid_status?token=AAAUDVYFCKAZ34SCKIW2YKLGMMIEO
case: failure
- name: Get Item Count Error
value: get_item_count_error
sha: 51a5bbac450bb9fb60e7150753eec369b1c3c602
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCountByStatus/failure/get_item_count_error?token=AAAUDV3LPPPSG7IME4SL7GLGMMIEO
case: failure
- name: Get Item Count By Status
value: get_item_count_by_status
sha: cfbe476071751914d2a52388a03fb50d03834656
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/getCountByStatus/success/get_item_count_by_status?token=AAAUDV3QSJMEQJG2RBUKI7LGMMIEO
case: success
"/v3/items/{SKU}":
delete:
tags:
- Items
summary: Walmart Retire an Item
description: Completely deactivates and un-publishes an item from the site.
operationId: retireAnItem
parameters:
- name: SKU
in: path
description: '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.'
required: true
schema:
type: string
- in: header
name: WM_SEC.ACCESS_TOKEN
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
- in: header
name: WM_CONSUMER.CHANNEL.TYPE
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
- in: header
name: WM_QOS.CORRELATION_ID
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
- in: header
name: WM_SVC.NAME
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
responses:
'200':
description: Successful Operation
content:
application/json:
schema:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
message:
type: string
description: Message confirming the deletion or retirement of an item from the Walmart Catalog
xml:
name: ItemRetireResponse
example:
sku: 97964_KFTest
message: Thank you. Your item has been submitted for retirement from Walmart Catalog. Please note that it can take up to 48 hours for items to be retired from our catalog.
additionalAttributes:
errors:
application/xml:
schema:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
message:
type: string
description: Message confirming the deletion or retirement of an item from the Walmart Catalog
xml:
name: ItemRetireResponse
example: |-
97964_KFTest
Thank you. Your item has been submitted for retirement from Walmart Catalog. Please note that it can take up to 48 hours for items to be retired from our catalog.
useCases:
- name: Retire-an-item
value: retire-an-item
sha: ec451ac03b28637437e9ab914f9798f83d00b227
download_url: https://gecgithub01.walmart.com/raw/RET-Marketplace/sandbox-mocker-service/main/src/main/java/mocker/recordMode/dev/customData/mappings/mp/items/MetaData/retireAnItem/success/retire-an-item?token=AAAUDV3M6WD3GVILLB22ZNDGMMIEO
case: success
components:
schemas:
GroupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
ItemCatalogResponse:
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the item.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
isbn:
type: string
description: International Standard Book Number
ean:
type: string
description: Product ID, EANs must be 13 digits in length.
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
itemId:
type: string
description: A unique Id which identifies the item.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
unit:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
brand:
type: string
description: Brand of Item.
num_reviews:
type: string
description: The reviewed times for Items.
customerRating:
type: string
description: Customer rating.
manufacturer:
type: string
description: manufacturer of Item.
fulfillmentType:
type: string
description: Fulfillment information.
publishedStatus:
type: object
properties:
status:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
reasons:
type: array
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
items:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
inventoryStatus:
type: string
description: It indicates whether the product is in stock or not.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
shop_ref:
type: string
shop_product_id:
type: string
shop_variant_id:
type: string
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
description: Items included in the response list
ItemCatalogResponses:
type: object
properties:
status:
type: string
description: Response Status
payload:
type: array
description: Items included in the response list
items:
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the item.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
isbn:
type: string
description: International Standard Book Number
ean:
type: string
description: Product ID, EANs must be 13 digits in length.
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
itemId:
type: string
description: A unique Id which identifies the item.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
unit:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
brand:
type: string
description: Brand of Item.
num_reviews:
type: string
description: The reviewed times for Items.
customerRating:
type: string
description: Customer rating.
manufacturer:
type: string
description: manufacturer of Item.
fulfillmentType:
type: string
description: Fulfillment information.
publishedStatus:
type: object
properties:
status:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
reasons:
type: array
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
items:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
inventoryStatus:
type: string
description: It indicates whether the product is in stock or not.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
shop_ref:
type: string
shop_product_id:
type: string
shop_variant_id:
type: string
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
description: Items included in the response list
totalItems:
type: integer
description: Total items for the query
format: int64
limit:
type: integer
description: Number of items shown in this page
format: int32
nextCursor:
type: string
description: Used for pagination to fetch the next set of items
statuss:
type: string
writeOnly: true
Price:
type: object
properties:
unit:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
PublishedStatus:
type: object
properties:
status:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
reasons:
type: array
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
items:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
VariantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
Filter:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The reviewed times for Items | string |
| customerRating | Customer rating | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
| price | Price of the Item | string |
| fulfillmentType | Fulfillment information | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
- price
- fulfillmentType
op:
type: string
enum:
- equals
- between
- greater_than
- less_than
values:
type: array
items:
type: string
ItemCatalogSearchPayload:
type: object
properties:
query:
type: object
properties:
field:
type: string
description: "| Attribute | Description | Data Type\n| --- | ----------- | -------\n| productName | Product Name, can do white card search | string |\n| sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |\n| gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string |\n| wpid | The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com | string |\n| upc | Specifies a Universal Product Code (UPC) search. UPC must be 12 digits. | string |\n| isbn | International Standard Book Number | string |\n| ean | Product ID, EANs must be 13 digits in length. | string |\n| itemId | A unique Id which identifies the item | string | \n| variantGroupId | Variant Id to retrieve all items with the same variant id | string | \n| condition | Specifies the condition of the item. Can take values (New, New without box, New without tags, Restored Premium, Restored, Remanufactured, Open Box, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects) | string |"
enum:
- productName
- sku
- gtin
- wpid
- upc
- isbn
- ean
- itemId
- condition
value:
type: string
filters:
type: array
items:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The reviewed times for Items | string |
| customerRating | Customer rating | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
| price | Price of the Item | string |
| fulfillmentType | Fulfillment information | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
- price
- fulfillmentType
op:
type: string
enum:
- equals
- between
- greater_than
- less_than
values:
type: array
items:
type: string
sort:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The revied number for Items | string |
| customerRating | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
order:
type: string
enum:
- ASC
- DESC
Query:
type: object
properties:
field:
type: string
description: "| Attribute | Description | Data Type\n| --- | ----------- | -------\n| productName | Product Name, can do white card search | string |\n| sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |\n| gtin | Specifies a Global Trade Item Number (GTIN) search. GTIN must be 14 digits. | string |\n| wpid | The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com | string |\n| upc | Specifies a Universal Product Code (UPC) search. UPC must be 12 digits. | string |\n| isbn | International Standard Book Number | string |\n| ean | Product ID, EANs must be 13 digits in length. | string |\n| itemId | A unique Id which identifies the item | string | \n| variantGroupId | Variant Id to retrieve all items with the same variant id | string | \n| condition | Specifies the condition of the item. Can take values (New, New without box, New without tags, Restored Premium, Restored, Remanufactured, Open Box, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects) | string |"
enum:
- productName
- sku
- gtin
- wpid
- upc
- isbn
- ean
- itemId
- condition
value:
type: string
Sort:
type: object
properties:
field:
type: string
description: |-
| Attribute | Description | Data Type
| --- | ----------- | -------
| num_reviews | The revied number for Items | string |
| customerRating | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |
| lifecycleStatus | The lifecycle status of an item describes where the item listing is in the overall lifecycle | string |
| publishedStatus | The published status of an item describes where the item is in the submission process | string |
| unpublishedReasons | It outlines the reason for an item when unpublished | string |
| inventoryStatus | It indicates whether the product is in stock or not | string |
enum:
- num_reviews
- customerRating
- lifecycleStatus
- publishedStatus
- unpublishedReasons
- inventoryStatus
order:
type: string
enum:
- ASC
- DESC
Association:
type: object
properties:
shippingTemplate:
type: object
properties:
name:
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type
enum:
- DEFAULT
- CUSTOM
- DELIVERR
id:
type: string
description: Shipping Template ID
description: Information about Shipping Template
shipNodeName:
type: string
description: Name of the fulfillment center.
shipNode:
type: string
description: The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
description: Item Associations like shippingTemplate, shipNode.
Cause:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
Error:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
xml:
name: Error
ItemsAssociationsResponseDTO:
required:
- items
type: object
properties:
items:
type: array
items:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
associations:
type: array
description: Item Associations like shippingTemplate, shipNode.
items:
type: object
properties:
shippingTemplate:
type: object
properties:
name:
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type
enum:
- DEFAULT
- CUSTOM
- DELIVERR
id:
type: string
description: Shipping Template ID
description: Information about Shipping Template
shipNodeName:
type: string
description: Name of the fulfillment center.
shipNode:
type: string
description: The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
description: Item Associations like shippingTemplate, shipNode.
errors:
type: array
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
xml:
name: Error
ResponseItem:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
associations:
type: array
description: Item Associations like shippingTemplate, shipNode.
items:
type: object
properties:
shippingTemplate:
type: object
properties:
name:
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type
enum:
- DEFAULT
- CUSTOM
- DELIVERR
id:
type: string
description: Shipping Template ID
description: Information about Shipping Template
shipNodeName:
type: string
description: Name of the fulfillment center.
shipNode:
type: string
description: The fulfillment center or ship node Id which uniquely identifies each facility and is autogenerated during the creation of fulfillment center. Every time a facility is added, a new ship node id is generated.
description: Item Associations like shippingTemplate, shipNode.
errors:
type: array
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
xml:
name: Error
ShippingTemplate:
type: object
properties:
name:
type: string
description: Shipping Template Name
type:
type: string
description: Shipping Template Type
enum:
- DEFAULT
- CUSTOM
- DELIVERR
id:
type: string
description: Shipping Template ID
description: Information about Shipping Template
ItemsAssociationsRequestDTO:
required:
- items
type: object
properties:
items:
type: array
description: List of items whose associations need to be fetched. It should not have more than 50 items.
items:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
description: List of items whose associations need to be fetched. It should not have more than 50 items.
RequestItem:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
description: List of items whose associations need to be fetched. It should not have more than 50 items.
FeedId:
type: object
properties:
feedId:
type: string
description: A unique ID, returned from the Bulk Upload API, used for tracking the feed file
additionalAttributes:
type: object
nullable: true
errors:
type: object
nullable: true
GatewayError:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
GenericAttributeValue:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
ItemResponse:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
xml:
name: ItemResponse
ItemResponses:
required:
- ItemResponse
type: object
properties:
errors:
type: array
xml:
name: error
items:
required:
- code
type: object
properties:
code:
type: string
field:
type: string
description:
type: string
info:
type: string
severity:
type: string
enum:
- INFO
- WARN
- ERROR
category:
type: string
enum:
- APPLICATION
- SYSTEM
- REQUEST
- DATA
causes:
type: array
xml:
wrapped: true
items:
type: object
properties:
code:
type: string
field:
type: string
type:
type: string
description:
type: string
xml:
name: Cause
errorIdentifiers:
type: object
additionalProperties:
type: object
component:
type: string
type:
type: string
serviceName:
type: string
gatewayErrorCategory:
type: string
enum:
- INTERNAL_DATA_ERROR
- EXTERNAL_DATA_ERROR
- SYSTEM_ERROR
xml:
name: GatewayError
ItemResponse:
type: array
description: Items included in the response list
items:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
variantGroupId:
type: string
description: Variant Id if the item is of type Variant
variantGroupInfo:
type: object
properties:
isPrimary:
type: boolean
description: Returns true if the item is a primary variant
groupingAttributes:
type: object
properties:
name:
type: string
description: Returns true if the item is a primary variant
value:
type: string
description: The list of variant attributes used to create the variant item
description: The list of variant attributes used to create the variant item
primary:
type: boolean
description: Additional variant group information if the item is of type Variant
xml:
name: ItemResponse
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
totalItems:
type: integer
description: Total items for the query
format: int64
nextCursor:
type: string
description: Used for pagination to fetch the next set of items
xml:
name: ItemResponses
Money:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
NameValueAttribute:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
NameValueAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
UnpublishedReasonList:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
ItemResponseRecord:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
xml:
name: ItemResponse
ItemResponse_json:
type: object
properties:
responseRecord:
required:
- sku
type: object
properties:
mart:
type: string
description: 'The marketplace name. Example: Walmart_US'
enum:
- WALMART_US
- WALMART_CA
- ASDA_GM
- WALMART_MEXICO
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
condition:
type: string
description: The condition of the product.
wpid:
type: string
description: The Walmart Product ID assigned by Walmart to the item when listed on Walmart.com
upc:
type: string
description: The 12-digit bar code used extensively for retail packaging in the United States
gtin:
type: string
description: The GTIN-compatible Product ID (i.e. UPC or EAN). UPCs must be 12 or 14 digitis in length. EANs must be 13 digits in length.
productName:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain'''
shelf:
type: string
description: Walmart assigned an item shelf name
productType:
type: string
description: 'A seller-specified, alphanumeric string uniquely identifying the Product Type. Example: ''Diamond'''
price:
type: object
properties:
currency:
type: string
description: 'The currency type. Example: USD for US Dollars'
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYR
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- INR
- IQD
- IRR
- ISK
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LTL
- LVL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RUR
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SRD
- STD
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XAG
- XAU
- XBA
- XBB
- XBC
- XBD
- XCD
- XDR
- XFU
- XOF
- XPD
- XPF
- XPT
- XTS
- XXX
- YER
- ZAR
- ZMK
- ZWL
amount:
type: number
description: 'The numerical amount of the price. Example: 9.99'
description: Specifies item purchase price information, including currency and amount.
publishedStatus:
type: string
description: 'The status of an item when the item is in the submission process. The status can be one of the following: PUBLISHED, READY_TO_PUBLISH, IN_PROGRESS, UNPUBLISHED, STAGE, or SYSTEM_PROBLEM.'
additionalAttributes:
type: object
properties:
nameValueAttribute:
type: array
xml:
name: NameValueAttribute
items:
required:
- name
- type
- value
type: object
properties:
name:
type: string
type:
type: string
enum:
- LOCALIZABLE_TEXT
- STRING
- BOOLEAN
- INTEGER
- DECIMAL
- DATE
- TIMESTAMP
isVariant:
type: boolean
variantResourceType:
type: string
value:
type: array
items:
required:
- value
type: object
properties:
value:
type: string
group:
type: string
source:
type: string
rank:
type: integer
format: int32
isVariant:
type: boolean
description: Bag of additional attributes
unpublishedReasons:
type: object
properties:
reason:
type: array
xml:
namespace: http://walmart.com/
items:
type: string
description: It outlines the reason for an item when unpublished ,that is, when 'publishedStatus' is set to 'UNPUBLISHED'.
lifecycleStatus:
type: string
description: The lifecycle status of an item describes where the item listing is in the overall lifecycle. Examples of allowed values are ACTIVE , ARCHIVED, RETIRED.
xml:
name: ItemResponse
Image:
type: object
properties:
url:
type: string
description: Provides images associated with the item product listing.
Item:
type: object
properties:
itemId:
type: string
description: Specifies the item identifier generated by Walmart.
condition:
type: string
description: Specifies the condition of the item.
isMarketPlaceItem:
type: boolean
description: Specifies whether or not this item is available by other sellers in the Marketplace.
images:
type: array
description: Provides images associated with the item product listing.
items:
type: object
properties:
url:
type: string
description: Provides images associated with the item product listing.
customerRating:
type: string
price:
type: object
properties:
amount:
type: string
currency:
type: string
description: Specifies item purchase price information, including currency and amount.
description:
type: string
description: Specifies the catalog item description.
title:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain''.'
brand:
type: string
description: Specifies the item brand.
productType:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the Product Type. Example: ''Diamond''.'
properties:
type: object
properties:
variant_items_num:
type: string
num_reviews:
type: string
categories:
type: array
items:
type: string
variants:
type: object
properties:
variantMeta:
type: array
items:
type: object
properties:
name:
type: string
variantData:
type: array
items:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
next_day_eligible:
type: boolean
ItemSearch:
type: object
properties:
items:
type: array
items:
type: object
properties:
itemId:
type: string
description: Specifies the item identifier generated by Walmart.
condition:
type: string
description: Specifies the condition of the item.
isMarketPlaceItem:
type: boolean
description: Specifies whether or not this item is available by other sellers in the Marketplace.
images:
type: array
description: Provides images associated with the item product listing.
items:
type: object
properties:
url:
type: string
description: Provides images associated with the item product listing.
customerRating:
type: string
price:
type: object
properties:
amount:
type: string
currency:
type: string
description: Specifies item purchase price information, including currency and amount.
description:
type: string
description: Specifies the catalog item description.
title:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the product name. Example: ''Sterling Silver Blue Diamond Heart Pendant with 18in Chain''.'
brand:
type: string
description: Specifies the item brand.
productType:
type: string
description: 'Provides the seller-specified alphanumeric string that uniquely identifies the Product Type. Example: ''Diamond''.'
properties:
type: object
properties:
variant_items_num:
type: string
num_reviews:
type: string
categories:
type: array
items:
type: string
variants:
type: object
properties:
variantMeta:
type: array
items:
type: object
properties:
name:
type: string
variantData:
type: array
items:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
next_day_eligible:
type: boolean
ItemSearchPrice:
type: object
properties:
amount:
type: string
currency:
type: string
description: Specifies item purchase price information, including currency and amount.
Properties:
type: object
properties:
variant_items_num:
type: string
num_reviews:
type: string
categories:
type: array
items:
type: string
variants:
type: object
properties:
variantMeta:
type: array
items:
type: object
properties:
name:
type: string
variantData:
type: array
items:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
next_day_eligible:
type: boolean
VariantDatum:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
VariantMetum:
type: object
properties:
name:
type: string
VariantValue:
type: object
properties:
name:
type: string
value:
type: string
Variants:
type: object
properties:
variantMeta:
type: array
items:
type: object
properties:
name:
type: string
variantData:
type: array
items:
type: object
properties:
productImageUrl:
type: string
itemId:
type: string
isAvailable:
type: string
title:
type: string
variantValues:
type: array
items:
type: object
properties:
name:
type: string
value:
type: string
CategoryPayload:
type: object
properties:
category:
type: string
description: Type of item
subcategory:
type: array
description: Specific kind of category
items:
type: object
properties:
subCategoryName:
type: string
description: Name of specific kind of category
subCategoryId:
type: string
description: ID of specific kind of category
description: Specific kind of category
SubCategory:
type: object
properties:
subCategoryName:
type: string
description: Name of specific kind of category
subCategoryId:
type: string
description: ID of specific kind of category
description: Specific kind of category
TaxonomyResponseDTO:
type: object
properties:
status:
type: string
payload:
type: array
items:
type: object
properties:
category:
type: string
description: Type of item
subcategory:
type: array
description: Specific kind of category
items:
type: object
properties:
subCategoryName:
type: string
description: Name of specific kind of category
subCategoryId:
type: string
description: ID of specific kind of category
description: Specific kind of category
Payload:
type: object
properties:
variantGroupId:
type: string
description: variant group id used to create the groups
count:
type: string
description: count of items having the same variant group id
description: Items included in the response list
VariantCountResponses:
type: object
properties:
status:
type: string
description: Response Status
payload:
type: array
description: Items included in the response list
items:
type: object
properties:
variantGroupId:
type: string
description: variant group id used to create the groups
count:
type: string
description: count of items having the same variant group id
description: Items included in the response list
ItemRetireResponse:
required:
- sku
type: object
properties:
sku:
type: string
description: An arbitrary alphanumeric unique ID, specified by the seller, which identifies each item.
message:
type: string
description: Message confirming the deletion or retirement of an item from the Walmart Catalog
xml:
name: ItemRetireResponse
parameters:
authorization:
name: Authorization
in: header
description: Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
required: true
schema:
type: string
example: Basic YzcyOTFjNmItNzI5MC00....
accessToken:
name: WM_SEC.ACCESS_TOKEN
in: header
description: The access token retrieved in the Token API call
required: true
schema:
type: string
example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
channelType:
name: WM_CONSUMER.CHANNEL.TYPE
in: header
description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
required: false
schema:
type: string
correlationId:
name: WM_QOS.CORRELATION_ID
in: header
description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
required: true
schema:
type: string
example: b3261d2d-028a-4ef7-8602-633c23200af6
svcName:
name: WM_SVC.NAME
in: header
description: Walmart Service Name
required: true
schema:
type: string
example: Walmart Service Name
accept:
name: Accept
in: header
description: 'Only supported Media Type : application/json'
required: true
schema:
type: string
example: application/json
content-type:
name: Content-Type
in: header
description: 'Only supported Media Type : application/json'
required: true
schema:
type: string
example: application/json
tags:
- name: Items