Call this endpoint to identify items that are currently on Walmart Fulfillment Services (WFS) hazmat compliance hold, including IN_REVIEW, ACTION_NEEDED, and PROHIBITED states.

When you convert items to WFS, items that either you or Walmart's systems identify as potentially containing hazardous materials will be put on hold status for further review by our Compliance team. Use the message returned by this endpoint to review error details, identity what needs to be fixed, and resubmit the item to convert to WFS.

Some typical use cases where we can use the hazmat items on hold API are:

• Review which SKUs are blocked by hazmat hold and their current status.
• When status is ACTION_NEEDED, it means invalid date was identified in your item setup submission. In this APIs response, review the error field and description, correct the date, and resubmit to WFS using the Convert items for WFS API.
• Checking items that are IN_REVIEW, which can last up to 72 business hours until it clears compliance review.
• If an item is marked as PROHIBITED, remove or replace the item and resubmit to WFS using the Convert items for WFS API.

For more information related to Hazmat items and what to do if your item is considered hazmat, review
WFS hazardous materials (hazmat): Overview in Marketplace Learn.

Note: This page describes an example using only the required parameters and inputs to review hazmat items on hold. For a full list of customization options and additional capabilities, refer to the Marketplace WFS API Reference.

Endpoint

POST https://marketplace.walmartapis.com/v3/items/onhold/search

Sample request

This sample request demonstrates how to retrieve hazmat related information for identified by the specified GTIN.

curl --request POST \ --url 'https://marketplace.walmartapis.com/v3/items/onhold/search' \ --header 'WM_QOS.CORRELATION_ID: 2f9d8f2b-9d7a-4f2e-9a6b-9c4e7b7d1e21' \ --header 'WM_SEC.ACCESS_TOKEN: <ACCESS_TOKEN>' \ --header 'WM_SVC.NAME: Walmart Marketplace' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "query": { "field": "gtin", "value": "06154035330299" }, "filters": [ { "field": "status", "op": "equals", "values": ["PROHIBITED","IN_REVIEW","ACTION_NEEDED"] } ], "sort": { "field": "updatedAt", "order": "DESC" } }'

import requests url = "https://marketplace.walmartapis.com/v3/items/onhold/search" headers = { "WM_QOS.CORRELATION_ID": "2f9d8f2b-9d7a-4f2e-9a6b-9c4e7b7d1e21", "WM_SEC.ACCESS_TOKEN": "<ACCESS_TOKEN>", "WM_SVC.NAME": "Walmart Marketplace", "Accept": "application/json", "Content-Type": "application/json",
} json_data = { "query": { "field": "gtin", "value": "06154035330299" }, "filters": [ { "field": "status", "op": "equals", "values": ["PROHIBITED", "IN_REVIEW", "ACTION_NEEDED"] } ], "sort": { "field": "updatedAt", "order": "DESC" }
} response = requests.post(url, headers=headers, json=json_data)
print(response.status_code)
print(response.text)

Modify your code

• Use a unique WM_QOS.CORRELATION_ID for each request.
• Replace WM_SEC.ACCESS_TOKEN with your valid access token obtained through authentication.
• For gtin enter the actual GTIN for which hazmat compliance should be reviewed..

Sample response

The following sample response shows the hazmat status for the specified GTIN. Review the status, description, severity, and related fields to identify what actions are required to bring the items into compliance with WFS hazmat guidelines.

{ "status": "OK", "header": {}, "payload": { "nextCursor": "?limit=1&offset=1", "totalItems": 207, "actionNeeded": 4, "inReview": 203, "prohibited": 0, "items": [ { "gtin": "00051494401255", "productName": "INNATE Response Formulas, Men Over 40 One Daily Iron Free, Multivitamin, Vegetarian, Non-GMO, 60 tablets (60 Servings", "category": "Medicine & Supplements", "subCategory": "medicine_and_supplements", "status": "ACTION_NEEDED", "sku": "SD-AB-12345", "createdAt": 1611140177328, "updatedAt": 1629992924901, "primaryImage": "image.jpg", "errors": [ { "code": "ERR_EXT_DATA_4001029", "field": "batteryTechnologyType", "description": "This item may contain a lithium or lead acid battery that requires additional compliance information, check the 'Battery Type' field.", "severity": "ERROR", "category": "REQUEST" } ] } ] }
}

Result

On success, the response includes hazmat compliance details for the requested items. When applicable error codes, descriptions, and severity explain what actions to take to ensure items are in compliance status.