--- updatedAt: 2026-06-04T12:53:29.000Z --- # Unpublished Items Get Unpublished Items [block:html] { "html": "\n \n" } [/block] # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Insights Management", "version": "1.0", "description": "The Insights Management API provides sellers with actionable information to optimize their listings:\n* Sellers can locate best-selling items with Trending Items API so they can add those to their catalog of item offerings. \n* Sellers can find out reasons why items go unpublished, fix the issue and republish those items.\n* Sellers can use Listing Quality APIs to gather listing quality metrics about their items and identify any issues that they can fix.\n* Sellers can obtain their overall Listing Quality score, and locate any categories that show items with listing quality issues." }, "x-readme": { "samples-languages": [ "shell" ], "proxy-enabled": false }, "servers": [ { "url": "https://marketplace.walmartapis.com", "description": "Production URL" }, { "url": "https://sandbox.walmartapis.com", "description": "Sandbox URL" } ], "security": [ { "accessToken": [] } ], "paths": { "/v3/insights/items/unpublished/items": { "get": { "tags": [ "Insight" ], "summary": "Unpublished Items", "description": "Get Unpublished Items", "externalDocs": { "description": "View Guide", "url": "/doc/us/mp/us-mp-insights/#3880" }, "operationId": "getUnpublishedItems", "parameters": [ { "name": "unpublishedReasonCode", "in": "query", "description": "Unpublished reason code", "required": false, "schema": { "type": "string", "default": "all" } }, { "name": "fromDate", "in": "query", "description": "Returns all unpublished items since the given date", "required": true, "schema": { "type": "string" }, "example": "2020-09-23" }, { "name": "limit", "in": "query", "description": "The number of items to be returned.", "required": false, "schema": { "type": "string", "default": "20" } }, { "name": "offerLifecycleStatus", "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", "default": "all" } }, { "name": "marketTrending", "in": "query", "description": "Filter the item list to return only items that are trending on Walmart.com", "required": false, "schema": { "type": "string", "default": "true" } }, { "name": "itemsWithInventory", "in": "query", "description": "Filter the item list to return only items that have inventory", "required": false, "schema": { "type": "string", "default": "true" } }, { "name": "isCustomerFavorite", "in": "query", "description": "Filters items by customer favorite status. When set to `true`, only customer favorites are returned. When set to `false`, only non-favorites are returned. If omitted, all items are returned.
Market availability: US only", "required": false, "schema": { "type": "boolean" } }, { "name": "condition", "in": "query", "description": "Filter the item list to display items based on the product condition.", "required": false, "schema": { "type": "string", "default": "all", "description": "Allowed Values", "enum": [ "New", "New without box", "New without tags", "New with defects", "Open Box", "Restored: Premium", "Restored: Like New", "Restored: Good", "Restored: Fair", "Remanufactured", "Pre-Owned: Like New", "Pre-Owned: Good", "Pre-Owned: Fair" ] }, "example": "New" }, { "in": "header", "name": "Authorization", "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...." }, { "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs.", "required": true, "schema": { "type": "string" }, "example": "eyJraWQiOiIxNWNhNGIyYi0yODVjLTQ0ZDUtYmExNC05ZDk1NTlkZmUwNjgiLCJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0...." }, { "in": "header", "name": "WM_CONSUMER.CHANNEL.TYPE", "description": "A unique ID to identify 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 that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID.", "required": true, "schema": { "type": "string" }, "example": "b3261d2d-028a-4ef7-8602-633c23200af6" }, { "in": "header", "name": "WM_SVC.NAME", "description": "Specifies the name of the Walmart service being called.", "required": true, "schema": { "type": "string" }, "example": "Walmart Marketplace" } ], "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "payload": { "type": "array", "items": { "type": "object", "properties": { "gtin": { "type": "string", "description": "The GTIN-compatible Product ID (i.e. UPC or EAN)" }, "marketPrice": { "type": "object", "properties": { "amount": { "type": "string", "description": "The numerical value of the price" }, "currency": { "type": "string", "description": "The currency type" } } }, "offerStartDate": { "type": "string", "description": "The Date when item becomes available to sell in Walmart" }, "marketTrending": { "type": "string", "description": "If item is trending in walmart" }, "lifecycleStatus": { "type": "string", "description": "The lifecycle status of an item describes where the item listing is in the overall lifecycle" }, "unpublishReasons": { "type": "string", "description": "It outlines the reason for an item when unpublished" }, "conversionRate": { "type": "integer", "description": "Percentage of number of items that are converted into sales", "format": "int32" }, "productName": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the product name" }, "gmvAmount": { "type": "object", "properties": { "amount": { "type": "integer", "description": "The numerical value of the price", "format": "int32" }, "currency": { "type": "string", "description": "The currency type" } } }, "itemId": { "type": "string", "description": "Specifies the item identifier generated by Walmart" }, "customerRating": { "type": "string", "description": "An average rating number for the item from customers" }, "pageViews": { "type": "integer", "description": "number of times this item is viewed by customers", "format": "int32" }, "price": { "type": "object", "properties": { "amount": { "type": "string", "description": "The numerical value of the price" }, "currency": { "type": "string", "description": "The currency type" } } }, "unpublishedDate": { "type": "string", "description": "The Date item becomes to Unpublished" }, "brand": { "type": "string", "description": "Specifies the item brand" }, "sku": { "type": "string", "description": "String of letters and/or numbers a partner uses to identify the item" }, "condition": { "type": "string", "description": "Information about the condition of the product" }, "productType": { "type": "string", "description": "A seller-specified, alphanumeric string uniquely identifying the Product Type" }, "offerEndDate": { "type": "string", "description": "The Date when item becomes unavailable to sell in Walmart" }, "publishStatus": { "type": "string", "description": "The status of an item when the item is in the submission process" }, "isCustomerFavorite": { "type": "boolean", "description": "Indicates whether the item is identified as a customer favorite based on customer demand." } } } }, "totalCount": { "type": "integer", "description": "total number of unpublished items", "format": "int32" }, "totalGmvAmount": { "type": "object", "properties": { "amount": { "type": "string", "description": "The numerical value of the price" }, "currency": { "type": "string", "description": "The currency type" } }, "description": "Gross Merchandise Value of the total result set" } } }, "example": { "payload": [ { "gtin": "00847321012345", "marketPrice": { "amount": "0.000000", "currency": "USD" }, "offerStartDate": "2020-01-06", "marketTrending": "false", "lifecycleStatus": "ACTIVE", "unpublishReasons": "REASONABLE_PRICE_NOT_SATISFIED", "conversionRate": 0, "productName": "Baxton Studio BBT5111 Bar Stool-Brown Libra Dark Brown Modern Bar Stool with Nail Head Trim - 44.5 x 18.5 x 21.5 in. - Pack of 2", "gmvAmount": { "amount": 0, "currency": "USD" }, "itemId": "196412345", "customerRating": "4", "pageViews": 3, "price": { "amount": "309.95", "currency": "USD" }, "unpublishedDate": "2020-08-04", "brand": "Baxton Studio", "sku": "DEAL12345", "condition": "New", "productType": "Stools", "offerEndDate": "2049-12-30", "publishStatus": "PUBLISHED", "isCustomerFavorite": true }, { "gtin": "07612981712345", "marketPrice": { "amount": "0.000000", "currency": "USD" }, "offerStartDate": "2019-11-13", "marketTrending": "false", "lifecycleStatus": "ACTIVE", "unpublishReasons": "REASONABLE_PRICE_NOT_SATISFIED", "conversionRate": 0, "productName": "Franke Bernadine Kitchen Faucet Stainless Steel", "gmvAmount": { "amount": 0, "currency": "USD" }, "itemId": "236212345", "customerRating": "0", "pageViews": 88, "price": { "amount": "187.98", "currency": "USD" }, "unpublishedDate": "2020-08-13", "brand": "Franke", "sku": "DEAL12345", "condition": "Pre-Owned: Like New", "productType": "faucets", "offerEndDate": "2049-12-30", "publishStatus": "UNPUBLISHED", "isCustomerFavorite": false }, { "gtin": "00190931112345", "marketPrice": { "amount": "0.000000", "currency": "USD" }, "offerStartDate": "2019-04-09", "marketTrending": "false", "lifecycleStatus": "ACTIVE", "unpublishReasons": "REASONABLE_PRICE_NOT_SATISFIED", "conversionRate": 0, "productName": "Coastal Blue Women's SwimsuitDeep V Ruffle Front One Piece S 4-6 Swimsuit", "gmvAmount": { "amount": 0, "currency": "USD" }, "itemId": "332612345", "customerRating": "0", "pageViews": 0, "price": { "amount": "31.98", "currency": "USD" }, "unpublishedDate": "2020-09-13", "brand": "Coastal Blue", "sku": "DEAL12345", "condition": "Restored Premium", "productType": "One-Piece Swimsuits", "offerEndDate": "2049-12-30", "publishStatus": "UNPUBLISHED", "isCustomerFavorite": false } ], "totalCount": 7, "totalGmvAmount": { "amount": "3760.95", "currency": "USD" } } } } } } } } }, "components": { "securitySchemes": { "accessToken": { "type": "apiKey", "in": "header", "name": "WM_SEC.ACCESS_TOKEN", "description": "Access token required for authenticating API requests.\n\nTo obtain a token, call `POST https://marketplace.walmartapis.com/v3/token` with your client ID and client secret using the client credentials grant type. Refer to the [Token API documentation](https://developer.walmart.com/us-marketplace/docs/get-an-access-token) for details.\n\nPass the resulting token in the `WM_SEC.ACCESS_TOKEN` header with every API request." } } } } ```