Call this endpoint is to get recommended shipment quantities for the items that you plan to send to WFS in order to achieve optimal inventory levels.

This page describes an example using only the required parameters and inputs for retrieving the recommended shipment quantity. For a full list of customization options and additional capabilities, refer to the Walmart WFS API Reference.

Endpoint

get https://marketplace.walmartapis.com/v3/wfs/recommendation/shipment-quantity

Shipment quantity by GTIN

This section demonstrates how to retrieve recommended shipment quantities using Global Trade Identification Numbers (GTINs).

Sample request

This sample request retrieves recommended shipment quantities for a list of specified items identified by their GTIN.

curl --request GET \ --url https://marketplace.walmartapis.com/v3/wfs/recommendations/inbound \ --header 'WM_QOS.CORRELATION_ID: Correlation_ID' \ --header 'WM_SEC.ACCESS_TOKEN: Access_Token' \ --header 'WM_SVC.NAME: Walmart Service Name' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "gtins": [ "00723508807642", "00643131798370", "00643131799155" ]
}
'

import requests
import json url = "https://marketplace.walmartapis.com/v3/wfs/recommendations/inbound"
headers = { "WMQOS.CORRELATIONID": "CorrelationID", "WMSEC.ACCESSTOKEN": "AccessToken", "WMSVC.NAME": "Walmart Service Name", "accept": "application/json", "content-type": "application/json"
}
data = { "gtins": [ "00723508807642", "00643131798370", "00643131799155" ]
} response = requests.request("GET", url, headers=headers, data=json.dumps(data))
print(response.statuscode)
print(response.text)

Modify your code

Replace all placeholder values with your actual shipment data before making the API request.

Authorization - Replace with your actual Base64-encoded credentials.
WM_QOS.CORRELATION_ID - Use a unique correlation UUID to track the request.
WM_SEC.ACCESS_TOKEN - Replace with your valid access token obtained through authentication.

Response

The response provides a list of items with their item IDs, GTINs, and the suggested and maximum quantities recommended for replenishment.

{ "status": "OK", "payload": { "replenishments": [ { "itemId": "430783001", "gtin": "06943478024076", "upc": "0e45a142-55cd-4c79-911e-5e434edb16c0", "vendorSku": "HAPE-E3029", "suggestedQty": 100, "maxQty": 200 }, { "itemId": "667578490", "gtin": "06943478024953", "upc": "bea01a52-9903-415b-a2b2-ab5d8edb46a8", "vendorSku": "HAPE-E0457", "suggestedQty": 50, "maxQty": 100 } ] }
}

Shipment quantity by SKU

This section demonstrates how to retrieve recommended shipment quantities using Stock Keeping Units (SKUs).

Sample request

This sample request retrieves recommended shipment quantities for a list of specified items identified by their SKU.

curl --request GET \ --url https://marketplace.walmartapis.com/v3/wfs/recommendations/inbound \ --header 'WM_QOS.CORRELATION_ID: Correlation_ID' \ --header 'WM_SEC.ACCESS_TOKEN: Access_Token' \ --header 'WM_SVC.NAME: Walmart Service Name' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "sku": [ "79903-108", "79903-109", "79903-110" ]
}
'

import requests url = "https://marketplace.walmartapis.com/v3/wfs/recommendations/inbound"
headers = { "WMQOS.CORRELATIONID": "CorrelationID", "WMSEC.ACCESSTOKEN": "AccessToken", "WMSVC.NAME": "Walmart Service Name", "accept": "application/json", "content-type": "application/json"
}
params = [ ("sku", "79903-108"), ("sku", "79903-109"), ("sku", "79903-110")
] response = requests.get(url, headers=headers, params=params)
print(response.statuscode)
print(response.text)

Modify your code

Replace all placeholder values with your actual shipment data before making the API request.

Authorization - Replace with your actual Base64-encoded credentials.
WM_QOS.CORRELATION_ID - Use a unique correlation UUID to track the request.
WM_SEC.ACCESS_TOKEN - Replace with your valid access token obtained through authentication.

Sample response

The response provides a list of items with their item IDs, SKUs, and the suggested and maximum quantities recommended for replenishment.

{ "status": "OK", "payload": { "replenishments": [ { "itemId": "430783001", "gtin": "06943478024076", "upc": "0e45a142-55cd-4c79-911e-5e434edb16c0", "vendorSku": "HAPE-E3029", "suggestedQty": 100, "maxQty": 200 }, { "itemId": "667578490", "gtin": "06943478024953", "upc": "bea01a52-9903-415b-a2b2-ab5d8edb46a8", "vendorSku": "HAPE-E0457", "suggestedQty": 50, "maxQty": 100 } ] }
}

Result

If successful, the API returns an HTTP status 200 OK with a JSON response. This response confirms that the API processed your request and provides a list of recommended replenishments, including item IDs, GTINs, UPCs, vendor SKUs, and suggested and maximum quantities.

If the API Returns 400.WFS.100, it indicates that your request is missing a required identifier. You must provide either a GTIN or a SKU attribute in your request payload.