Update shipment quantities

Call this endpoint to modify the shipment quantity before the shipment arrives at Walmart Fulfillment Centers. All modifications to the shipment quantity must be made prior to initiating delivery.

Modifications to the shipment quantity are not allowed if the shipment status is Receiving, In-progress, Closed, or Cancelled. Ensure to follow these guidelines:

  • You can add up to a maximum of 6 shipment units per SKU.
  • For each SKU, you must provide a new quantity greater than 0.
  • To remove an SKU from a shipment unit, you can reduce the shipment quantity to 0.
  • We recommend not to update all SKU quantities to 0, as it will cancel the entire inbound order.

Note: This page describes an example using only the required parameters and inputs to update shipment quantities. For a full list of customization options and additional capabilities, refer to the Marketplace WFS API Reference.

Endpoint

PUT https://marketplace.walmartapis.com/v3/fulfillment/shipment-quantities

Sample request

This sample request demonstrates how to update the shipment quantity for a SKU.

curl --request PUT \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/shipment-quantities' \ --header 'WM_QOS.CORRELATION_ID: 7c6f5f7a-5d6a-4c61-8e3a-2a0f6d5b5d10' \ --header 'WM_SEC.ACCESS_TOKEN: <Access_Token>' \ --header 'WM_SVC.NAME: <Your_Service_Name>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '
{ "inboundOrderId": "123543", "shipmentId": "1234", "orderItems": [ { "sku": "WILL-SL969", "updatedShipmentQty": 11 } ]
}
'
import requests url = "https://marketplace.walmartapis.com/v3/fulfillment/shipment-quantities" headers = { "WM_QOS.CORRELATION_ID": "7c6f5f7a-5d6a-4c61-8e3a-2a0f6d5b5d10", "WM_SEC.ACCESS_TOKEN": "<Access_Token>", "WM_SVC.NAME": "<Your_Service_Name>", "Accept": "application/json", "Content-Type": "application/json",
} json_data = { "inboundOrderId": "123543", "shipmentId": "1234", "orderItems": [ { "sku": "WILL-SL969", "updatedShipmentQty": 11 } ]
} response = requests.put(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.
  • Replace SKU with the actual SKU.
  • Set updateShipmentQty to the intended shipment quantity.

Sample response

This sample response shows that the update to shipment quantity was successful.

{ "status": "OK"
}

Result

If successful, the API returns an HTTP status 200 OK with a JSON response.