All WFS orders
Market availability: CA and MX
This API is in legacy state and will be removed on November 31, 2027. We recommend transitioning to the Get all orders API to fetch WFS orders that use shipNodetype attribute APIs.
The All WFS orders API helps sellers monitor WFS orders, track order statuses, and integrate order information into their order management systems.
Endpoint
GET https://marketplace.walmartapis.com/v3/orders/wfsFunction
Use this API to:
- Include order details
- Add item quantities
- Incorporate the fulfillment status
- Insert shipping information
- Include applicable charges
- Access WFS order information
Request sample
curl --request GET \ --url https://marketplace.walmartapis.com/v3/orders/wfs \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: us' \ --header 'accept: application/json'Modify your code
Before sending your request, verify the API endpoint, authentication credentials, and Marketplace headers.
1. Verify the API endpoint
The request uses the following endpoint to retrieve WFS orders:
https://marketplace.walmartapis.com/v3/orders/wfs
2. Specify the Walmart Marketplace
The request sample uses the US Marketplace:
--header 'WM_MARKET: us'
Replace US with the appropriate Marketplace value for the orders you want to retrieve, such as CA for Canada or MX for Mexico.
3. Verify the API version and response format
The request includes:
--header 'WM_GLOBAL_VERSION: 3.1' \
--header 'accept: application/json'
These headers specify the global API version and request a JSON response.
4. Include authentication credentials
Ensure that your integration includes the required Walmart Marketplace authentication headers and a valid access token. The provided cURL sample does not include authentication headers.
5. Retrieve additional orders using pagination
When the response contains a nextCursor value, use it to request the next page of orders.
Response samples
200 - Sample 1-CA
{ "list": { "meta": { "totalCount": 58, "limit": 1, "nextCursor": "?limit=1&hasMoreElements=true&soIndex=58&cursor=MTowfjA6MA&poIndex=1&orgId=4c824e1b-6862-4cf2-83d1-b37650e8cb85&partnerId=10011361291&sellerId=103341661&createdStartDate=2024-08-01T00:00:00.000Z&createdEndDate=2025-03-19T00:00:00.000Z&shipNodeType=WFSFulfilled" }, "elements": { "order": [ { "purchaseOrderId": "309111467141707", "customerOrderId": "900000031161229", "customerEmailId": "[email protected]", "orderDate": 1741687136956, "shippingInfo": { "phone": "7785554321", "estimatedDeliveryDate": 1743619600000, "estimatedShipDate": 1743519600000, "methodCode": "Standard", "postalAddress": { "name": "QaTest Test", "address1": "3354 Innes Road", "address2": null, "city": "Ottawa", "state": "ON", "postalCode": "K1C 1T1", "country": "CA", "addressType": "RESIDENTIAL" }, "carrierMethodName": null }, "orderLines": { "orderLine": [ { "lineNumber": "1", "item": { "productName": "SANTAgift", "sku": "JKLK03459201434140" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "CAD", "amount": 51 }, "tax": { "taxName": "HST", "taxAmount": { "currency": "CAD", "amount": 6.63 } }, "isDiscount": false, "discountType": null }, { "chargeType": "PRODUCT", "chargeName": "ITEM_PRICE_AFTER_DISCOUNT", "chargeAmount": { "currency": "CAD", "amount": 51 }, "tax": { "taxAmount": { "currency": "CAD", "amount": 0 } }, "isDiscount": null, "discountType": null }, { "chargeType": "TAX", "chargeName": "TAX", "chargeAmount": { "currency": "CAD", "amount": 6.63 }, "tax": { "taxAmount": { "currency": "CAD", "amount": 0 } }, "isDiscount": false, "discountType": null } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Created", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": null, "trackingInfo": null, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "fulfillment": { "fulfillmentOption": "DELIVERY", "shipMethod": "STANDARD", "storeId": null, "offerId": "11A732608E27331282B894743C169714", "pickUpDateTime": null, "pickUpBy": null, "shippingProgramType": null, "predictedShipNodeName": null } } ] } } ] } }
}200 - Sample 2-MX
Market availability: MX
{ "list": { "meta": { "totalCount": 1862, "limit": 1, "nextCursor": "?limit=1&hasMoreElements=true&soIndex=1862&cursor=MX4tMX4w&poIndex=1&orgId=1dbe6250-6320-4517-9ac8-14f2f5dbdd1a&partnerId=10900032872&createdStartDate=2024-08-01&createdEndDate=2025-03-19" }, "elements": { "order": [ { "customerOrderId": "70020239368201", "orderDate": 1742342393713, "shippingInfo": { "phone": "5103295632", "postalAddress": { "name": "ACCEPT ACCEPT", "address1": "PRIVADA UNIÓN", "address2": "43", "address3": "AEROPUERTO INTERNACIONAL DE LA ciudad de mexico", "address4": "VENUSTIANO CARRANZA", "city": "MIGUEL HIDALGO", "state": "CMX", "postalCode": "11220", "country": "MX", "addressType": null }, "carrierMethodName": null }, "totalLines": "1", "totalQuantity": "1", "orderLines": { "orderLine": [ { "primeLineNumber": "1", "coLineNumber": "1", "item": { "upc": "00675150683886", "offerId": "0A645946499F4CAD9CC5312371DA4540", "productName": "Amplificador digital Bluetooth receptor de amplificador de audio HiFi Bluetooth 5.0 60W para sistem Baoblaze amplificador estéreo", "sku": "SKU-06751506838867", "condition": "New", "imageUrl": "https://example.com/images/mock-product-image.jpg", "unitPrice": { "currency": "MXN", "amount": 995.4 }, "unitPriceWithoutTax": { "currency": "MXN", "amount": 858.1 } }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeAmount": { "currency": "MXN", "amount": 858.1 }, "tax": { "taxName": "TOTAL_TAX", "taxAmount": { "currency": "MXN", "amount": 137.3 } }, "taxDetails": [ { "taxName": "TOTAL_TAX", "taxAmount": { "currency": "MXN", "amount": 137.3 } } ], "isDiscount": null, "discountType": null } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "orderLineStatuses": { "orderLineStatus": [ { "status": "Cancelled", "subSellerId": null, "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "cancellationReason": "REJECT", "trackingInfo": null, "returnCenterAddress": null, "sellerOrderId": null, "shipmentPackages": null } ] }, "refund": null, "shippingMethod": "STANDARD", "soPrimeLineSubLineNo": "70020239368201-1-1", "promiseDeliveryDate": "2026-04-26T19:00:00.000+0000", "isMSIEnabled": "N", "seller": { "id": "DC_6071", "name": "Test seller14fo", "shipNodeType": "WFSFulfilled" }, "isWFSEnabled": "Y", "fulfillmentType": "WFS" } ] }, "shipments": [ { "shipmentLines": [ { "primeLineNo": "1", "quantity": { "unitOfMeasurement": "EACH", "amount": "1" } } ], "shipmentNo": "null_1", "status": "Shipment Canceled", "packageNo": "null_1", "isSellerOwnedShipment": "N", "shipmentAdditionalDate": { "expectedShipmentShippedDate": "" } } ], "orderTotal": { "currency": "MXN", "amount": 0 } } ] } }
}400
{ "errors": [ { "code": "INVALID_REQUEST_CONTENT.GMP_ORDER_API", "description": "Invalid request content.", "info": "Request content is not valid.", "severity": "ERROR", "category": "DATA" } ]
}401
{ "errors": [ { "code": "UNAUTHORIZED.GMP_ORDER_API", "description": "Unauthorized request.", "info": "Authentication failed. Verify your credentials.", "severity": "ERROR", "category": "APPLICATION" } ]
}403
{ "errors": [ { "code": "FORBIDDEN.GMP_ORDER_API", "description": "Access denied.", "info": "You do not have permission to perform this action.", "severity": "ERROR", "category": "APPLICATION" } ]
}404
{ "errors": [ { "code": "NOT_FOUND.GMP_ORDER_API", "description": "Resource not found.", "info": "The requested purchase order was not found.", "severity": "ERROR", "category": "DATA" } ]
}429
{ "code": "REQUEST_THRESHOLD_VIOLATED", "description": "Too many requests in a given amount of time.", "info": "You have exceeded the rate limit for this API. Retry after the time indicated in the Retry-After header.", "severity": "ERROR", "category": "SYSTEM", "causes": [], "errorIdentifiers": {}, "field": "RateLimitExceeded"
}500
{ "errors": [ { "code": "INTERNAL_SERVER_ERROR.GMP_ORDER_API", "description": "An internal server error occurred.", "info": "Retry the request. If the issue persists, contact support.", "severity": "ERROR", "category": "SYSTEM" } ]
}Result
A successful request returns HTTP 200 and a JSON response containing the WFS orders associated with the specified Marketplace.
Pagination metadata
totalCount: Total number of orders matching the request criteria.limit: Maximum number of orders returned on the current page.nextCursor: Cursor query string used to retrieve the next page of orders.
For example, the CA response returns a totalCount of 58 and a limit of 1, indicating that one order is returned on the current page out of 58 matching orders.
Order information
Each returned order can include:
- Order identifiers, dates, and shipping information.
- Product names, SKUs, and ordered quantities.
- Order-line statuses, such as
CreatedorCancelled. - Product charges, taxes, and currency information.
- Fulfillment information and shipping methods.
- Shipment details and cancellation reasons, when applicable.
Response structures can vary by Marketplace. For example, the CA response includes a purchaseOrderId and an order-line fulfillment object. The MX response includes WFS-specific fields such as:
"isWFSEnabled": "Y",
"fulfillmentType": "WFS"
The MX example also includes a cancelled order line and a shipment with the status Shipment Canceled, demonstrating that WFS orders can be returned with different fulfillment and order-line statuses.
Next steps
After successfully retrieving WFS orders, review the returned order details, fulfillment information, and order-line statuses to confirm that your integration is receiving the expected data.
Updated 16 minutes ago

