Fetch inbound preview

Call this endpoint to preview shipment destinations for Inventory Transfer Services (ITS), self-distribution, or single destination shipments. If you opted for ITS, you can use this fetch inbound preview API to get a detailed breakdown of the projected ITS fees. You can also compare available destination options by reviewing the shipping destinations between ITS and self-distribution by specifying the items and quantities you want to send.

You can use this API to decide between ITS and self-distribution before creating inbound shipments. You can review fee estimate for ITS by lane and destination. You can preview which WFS fulfillment centers (FCs) are most likely to receive your items. Use the results from this API as estimates for planning. The actual routing and fees will be finalized when you create shipments.

This page describes an example using only the required parameters and inputs for fetching an inbound preview order. For a full list of customization options and additional capabilities, refer to the Walmart WFS API Reference.

Endpoint

POST https://marketplace.walmartapis.com/v3/fulfillment/inbound-preview

Sample request

This sample request fetches the inbound preview for the specified inboundOrderId.

curl --request POST \ --url https://marketplace.walmartapis.com/v3/fulfillment/inbound-preview \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data '
{ "header": { "headerAttributes": { "buId": "0", "martId": "0" } }, "payload": { "returnAddress": { "addressLine1": "Street address", "addressLine2": "", "city": "Name of city", "stateCode": "2-letter state code", "countryCode": "US", "postalCode": "12345" }, "orderItems": [ { "nonSortItem": true, "productId": "06484856148873", "productType": "GTIN", "sku": "SKU-06476211912694", "itemDesc": "tennis ball", "itemQty": 5, "vendorPackQty": 5, "innerPackQty": 1, "expectedDeliveryDate": "2023-05-25T15:33:33-07:00", "addOnServices": [ { "serviceType": "LABEL" } ] } ], "inboundOrderId": "WFS_P132398111-ITS1011" }
}
'

import requests url = "https://marketplace.walmartapis.com/v3/fulfillment/inbound-preview" headers = { "Accept": "application/json", "Content-Type": "application/json",
} json_data = { "header": { "headerAttributes": { "buId": "0", "martId": "0" } }, "payload": { "returnAddress": { "addressLine1": "Street address", "addressLine2": "", "city": "Name of city", "stateCode": "2-letter state code", "countryCode": "US", "postalCode": "12345" }, "orderItems": [ { "nonSortItem": True, "productId": "06484856148873", "productType": "GTIN", "sku": "SKU-06476211912694", "itemDesc": "tennis ball", "itemQty": 5, "vendorPackQty": 5, "innerPackQty": 1, "expectedDeliveryDate": "2023-05-25T15:33:33-07:00", "addOnServices": [ { "serviceType": "LABEL" } ] } ], "inboundOrderId": "WFS_P132398111-ITS1011" }
} 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.
Replace inboundOrderId with the actual inbound order ID for which you want to preview the ITS and shipping destination options.

Sample response

This sample response details the estimated cost for ITS and shipping destination options.

{ "status": "OK", "payload": [ { "inboundOrderId": "WFS_P132398111-ITS1011", "previews": [ { "previewType": "inbound", "preview": [ { "shipNode": "4093", "isSortable": true, "isNonSortable": false, "nodeType": "ICC", "shipToAddress": { "fcName": "LAX2T", "addressLine1": "6720 Kimball Ave", "city": "Chino", "stateCode": "CA", "countryCode": "US", "postalCode": "91708" }, "totalNetTransferCharge": 1.25, "currencyUnit": "USD", "shipmentItems": [ { "vendorSku": "SKU-06476211912694", "productType": "GTIN", "productId": "06484856148873", "itemQty": 5, "netTransferCharge": 1.25, "currencyUnit": "USD" } ] } ] }, { "previewType": "selfMirroring", "preview": [ { "shipNode": "7441", "isSortable": true, "isNonSortable": false, "nodeType": "FC", "shipToAddress": { "fcName": "ORD1s", "addressLine1": "3501 Brandon Road", "city": "Joliet", "stateCode": "IL", "countryCode": "US", "postalCode": "60436" }, "shipmentItems": [ { "vendorSku": "SKU-06476211912694", "productType": "GTIN", "productId": "06484856148873", "itemQty": 4 } ] }, { "shipNode": "8103", "isSortable": true, "isNonSortable": false, "nodeType": "FC", "shipToAddress": { "fcName": "LAX1", "addressLine1": "6750 Kimball Avenue", "city": "Chino", "stateCode": "CA", "countryCode": "US", "postalCode": "91708" }, "shipmentItems": [ { "vendorSku": "SKU-06476211912694", "productType": "GTIN", "productId": "06484856148873", "itemQty": 1 } ] } ] } ] } ]
}

Result

On success this API returns a 200 OK response as an acknowledgement with the preview payload.

Updated 21 days ago