Call this endpoint to retrieve details related to a specific WFS inbound shipment such as SKU-level details, quantities, and receipt status.

After you create inbound shipments, you can use this API to review shipment details and use this information to resolve errors, if any. In case you encounter errors, resolve it and resubmit the Create Inbound Shipment request, to create the inbound order with the same inbound order ID.

Note: This page describes an example using only the required parameters and inputs to check for inbound order errors. For a full list of customization options and additional capabilities, refer to the Marketplace WFS API Reference.

Some possible inbound order errors are:

The SKU is not in the WFS catalog – The Seller must make the item eligible for WFS. You need to convert all SKUs to the WFS catalog. See Convert Items for WFS.
Missing required information – Indicates missing value in the CVS file for one of the required fields. Repeat the create an inbound shipment process. See Create Inbound Shipment.
Invalid Product ID – Indicates that there are incorrect number of digits in the productId.
Duplicate Inbound Order ID – Indicates that theshipmentId specified already exists for previous orders.
Duplicate Product ID – Indicates that the productId is provided multiple times in the CVS file. Make sure to remove duplicate entries for productId in your request to create the inbound order.

After you resubmit an inbound order that previously had errors, the historical errors for the inbound order ID are removed and no longer accessible.

Endpoint

GET https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-errors

Sample request

Use this sample request to check for inbound shipment errors for all shipments.

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-errors?offset=0&limit=10' \ --header 'Authorization: Basic <base64(clientId:clientSecret)>' \ --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' \

import requests url = "https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-errors" headers = { "WM_QOS.CORRELATION_ID": "Correlation_ID", "WM_SEC.ACCESS_TOKEN": "Access_Token", "WM_SVC.NAME": "Walmart Service Name", "Accept": "application/json", "Content-Type": "application/json",
} params = { "offset": 0, "limit": 10,
} response = requests.get(url, headers=headers, params=params)
print(response.status_code)
print(response.text)

Use this sample request to check for inbound shipment errors for a specific shipment. Specify the shipmentId that you created when you called the Create Inbound Shipment API.

curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-errors?shipmentId=4846GDM&offset=0&limit=10' \ --header 'Authorization: Basic <base64(clientId:clientSecret)>' \ --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' \

import requests url = "https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipment-errors" headers = { "Authorization": "Basic <base64(clientId:clientSecret)>", "WM_QOS.CORRELATION_ID": "Correlation_ID", "WM_SEC.ACCESS_TOKEN": "Access_Token", "WM_SVC.NAME": "Walmart Service Name", "Accept": "application/json",
} params = { "shipmentId": "4846GDM", "offset": 0, "limit": 10,
} response = requests.get(url, headers=headers, params=params)
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.

Sample response

{ "headers": { "limit": 10, "offset": 0, "totalCount": 1 }, "payload": [ { "inboundOrderId": "test-shipment-1", "createdDate": "2020-10-19T01:06:24.207Z", "returnAddress": { "addressLine1": "address line 1", "city": "Sunnyvale", "stateCode": "CA", "countryCode": "US", "postalCode": "94087" }, "orderItems": [ { "productId": "7036848676 ", "productType": "UPC", "sku": "sku1", "itemDesc": "product 1", "itemQty": 20, "vendorPackQty": 2, "innerPackQty": 10, "expectedDeliveryDate": "2020-10-27T16:00:00.000Z" }, { "productId": "703684867 ", "productType": "UPC", "sku": "sku2", "itemDesc": "product 2", "itemQty": 30, "vendorPackQty": 3, "innerPackQty": 30, "expectedDeliveryDate": "2020-10-27T16:00:00.000Z" } ], "errors": [ { "code": "400.WSAAS.100", "field": "orderItems[0].productId", "description": "Product ID with Product Type UPC should be 12 digit", "info": "Product ID with Product Type UPC should be 12 digit:703684867609 ", "severity": "ERROR", "category": "REQUEST" }, { "code": "400.WSAAS.100", "field": "orderItems[1].productId", "description": "Product ID with Product Type UPC should be 12 digit", "info": "Product ID with Product Type UPC should be 12 digit:703684867661 ", "severity": "ERROR", "category": "REQUEST" } ] } ]
}

Result

If successful, the API returns an HTTP status 200 OK with a JSON response. The response includes a paginated list of inbound shipment errors, if any. If there are no errors, an empty payload is returned.