### Get All Orders API Request Example Source: https://developer.walmart.com/us-marketplace/reference/getallorders This example demonstrates how to make a GET request to the Get All Orders endpoint. Ensure you include the necessary authentication headers and query parameters for filtering. ```bash curl -X GET \ 'https://marketplace.walmartapis.com/v3/orders?limit=100&nextCursor=X2V4dE5leHRDdXJzb3I9MTAw' \ -H 'accept: application/json' \ -H 'authorization: Basic ' ``` -------------------------------- ### cURL Request Example Source: https://developer.walmart.com/cl-marketplace/reference/getlagtime This example demonstrates how to make a POST request to the Get Lead Time API using cURL. Ensure you include the necessary headers such as WM_MARKET, accept, and content-type. ```Shell curl --request POST \ --url https://marketplace.walmartapis.com/v3/items/lagtimes \ --header 'WM_MARKET: cl' \ --header 'accept: application/json' \ --header 'content-type: application/json' ``` -------------------------------- ### Bulk Item Setup (Multiple) Source: https://developer.walmart.com/mx-marketplace/docs/walmart-fulfillment-services-wfs-api-overview Sets up items for ingestion into the WFS system. This is the first step for preparing items for WFS. ```APIDOC ## POST /v3/feeds?feedType=MP_WFS_ITEM ### Description Sets up items for ingestion with the WFS item spec. ### Method POST ### Endpoint /v3/feeds?feedType=MP_WFS_ITEM ### Request Body (Schema not provided in source) ### Response (Schema not provided in source) ``` -------------------------------- ### Example API Request for Item Setup Requirements Source: https://developer.walmart.com/global-marketplace/docs/get-item-setup-requirements Use this cURL command to make a POST request to the Get Spec API. Ensure you provide the correct feedType, version, and productTypes in the JSON payload. This example requests requirements for 'Baby Blankets'. ```curl curl --request POST \ --url https://marketplace.walmartapis.com/v3/items/spec \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data \ '{ "feedType": "MP_WFS_ITEM", "version": "5.0.20240517-04_08_27-api", "productTypes": [ "Baby Blankets” ] }' ``` -------------------------------- ### cURL Request for Bulk Item Setup Source: https://developer.walmart.com/global-marketplace/reference/itembulkuploads This example demonstrates how to make a POST request to the Bulk Item Setup API using cURL. It includes essential headers such as WM_GLOBAL_VERSION, WM_MARKET, accept, and content-type. Ensure you replace placeholder values with your actual token and market information. ```shell curl --request POST \ --url https://marketplace.walmartapis.com/v3/feeds \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: us' \ --header 'accept: application/json' \ --header 'content-type: multipart/form-data' ``` -------------------------------- ### Bulk Item Setup (Multiple) Source: https://developer.walmart.com/ca-marketplace/docs/walmart-fulfillment-services-wfs-api-overview Sets up multiple items for ingestion into WFS. ```APIDOC ## Bulk Item Setup (Multiple) ### Description Sets up multiple items for ingestion into WFS. ### Method POST ### Endpoint /v3/feeds?feedType=MP_WFS_ITEM ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **field1** (type) - Description #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Price Trends Example Source: https://developer.walmart.com/us-marketplace/docs/get-trends-api-1 This example demonstrates how to call the Get Price Trends API to retrieve price data for a specific product. ```APIDOC ## Get Price Trends ### Description Retrieves historical weekly price data for a product. ### Method GET ### Endpoint `/v3/internal/price-trends` ### Parameters #### Query Parameters - **productId** (string) - Required - The unique identifier of the product. - **week** (string) - Optional - The week number for which to retrieve data (e.g., "1", "52"). - **year** (string) - Optional - The year for which to retrieve data (e.g., "2023", "2024"). ### Response #### Success Response (200) - **priceTrends** (array) - An array of price trend objects. - **week** (string) - The week number. - **year** (string) - The year. - **value** (number) - The price value for that week and year. #### Response Example ```json { "priceTrends": [ { "week": "47", "year": "2023", "value": 10.99 }, { "week": "48", "year": "2023", "value": 10.99 } ] } ``` ``` -------------------------------- ### Get Partner Statement Response Example Source: https://developer.walmart.com/us-marketplace/reference/getpartnerstatement-1 This example demonstrates a successful response from the Get Partner Statement API, showing the structure of the financial data returned for a partner. ```APIDOC ## Get Partner Statement Response Example ### Description This is an example of a successful response from the Get Partner Statement API. It includes partner identification, outstanding balances, and detailed financial breakdowns. ### Response #### Success Response (200) - **statusCode** (number) - The HTTP status code of the response. - **status** (string) - The status message of the response. - **error** (string) - Any error message associated with the response. - **partnerId** (string) - The unique identifier for the partner. - **payload** (object) - Contains the main financial data for the partner. - **outstandingMCABalance** (number) - The outstanding balance for the partner. - **sellerInfo** (object) - Information about the seller. - **storeFrontUrl** (string) - The URL of the seller's storefront. ### Response Example ```json { "statusCode": 200, "status": "OK", "error": "", "partnerId": "10000003437", "payload": { "outstandingMCABalance": 0, "sellerInfo": { "storeFrontUrl": "https%3A%2F%2Fwww.walmart.com%2Fseller%2F3346" } } } ``` ``` -------------------------------- ### Example of setting up multiple item variants Source: https://developer.walmart.com/global-marketplace/docs/setting-up-multiple-variants-of-an-item This JSON example demonstrates how to structure a bulk item setup feed to include multiple variants of a single product. It shows how to assign a `variantGroupId`, specify the primary variant, and list the varying attributes. ```json { "MPItemFeedHeader": { "businessUnit": "WALMART_US", "locale": "en", "version": "2.0.20230221-12_22_32-api" }, "MPItem": [ {"Orderable": { "productId": "123456", "sku": "ABC123"}, "Visible": { "Toothpastes": { "productName": "Colgate Crest Toothpaste", "flavor": "Peppermint", "variantGroupId": "001960968586AX6", "isPrimaryVariant": "Yes", "variantAttributeNames": "flavor"}}}, {"Orderable": { "productId": "123456", "sku": "ABC1245"}, "Visible": { "Toothpastes": { "productName": "Colgate Crest Toothpaste", "flavor": "Spearmint", "variantGroupId": "001960968586AX6", "isPrimaryVariant": "No", "variantAttributeNames": "flavor"}}}]} ``` -------------------------------- ### Sample Request using Python Source: https://developer.walmart.com/global-marketplace/docs/create-subscription Demonstrates how to create a subscription using Python's requests library. Ensure to set the Authorization header if required. ```python import requests url = "https://marketplace.walmartapis.com/v3/webhooks/subscriptions" headers = { "Accept": "application/json", "Content-Type": "application/json", # "Authorization": "Basic ", # if required } # Example body (edit to your needs or set to {} if you truly have no body) payload = { "eventType": "OFFER_UNPUBLISHED", "eventVersion": "V1", "resourceName": "ITEM", "eventUrl": "https://example.com/events", "headers": { "content-type": "application/json" }, "authDetails": { "authMethod": "BASIC_AUTH", "authHeaderName": "Authorization", "userName": "abc", "password": "test" }, "status": "ACTIVE" } resp = requests.post(url, headers=headers, json=payload, timeout=30) resp.raise_for_status() # raises if not 2xx print(resp.status_code) print(resp.json()) ``` -------------------------------- ### Get Partner Statement API Example Response Source: https://developer.walmart.com/us-marketplace/reference/getpartnerstatement-1 An example successful response from the Get Partner Statement API, showing outstanding balance, seller information, and financial aggregates. ```json { "statusCode": 200, "status": "OK", "error": "", "partnerId": "10000003437", "payload": { "outstandingMCABalance": 0, "sellerInfo": { "storeFrontUrl": "https%3A%2F%2Fwww.walmart.com%2Fseller%2F3346" } } } ``` -------------------------------- ### Get Item Not Found Example Source: https://developer.walmart.com/suppliers/reference/getanitem This example demonstrates the response structure when an item is not found. ```APIDOC ## Get Item Not Found Example ### Description This example shows the structure of the error response when a requested item cannot be found. ### Response #### Success Response (404) - **error** (array) - An array of error objects detailing the reason for the failure. - **code** (string) - Error code of the response. - **field** (string) - Specifies which field contains the error. - **description** (string) - Description of the error. - **info** (string) - Information about the error. - **severity** (string) - Severity of the error. - **category** (string) - Category of the error. - **causes** (array) - List of error causes. - **errorIdentifiers** (object) - Error identifiers associated with the error. #### Response Example ```json { "error": [ { "code": "CONTENT_NOT_FOUND.GMP_ITEM_QUERY_API", "field": "404_NOT_FOUND", "description": "No Items found for the input parameters.", "info": "Requested content could not be found.", "severity": "INFO", "category": "APPLICATION", "causes": [], "errorIdentifiers": {} } ] } ``` ``` -------------------------------- ### Create Subscription Request Example Source: https://developer.walmart.com/us-marketplace/reference/createsubscription This example demonstrates the structure of a request to create a subscription. It includes details about the events to subscribe to, the notification URL, and authentication methods. ```json { "subscriptions": [ { "eventType": "ITEM", "notificationURL": "https://example.com/notifications", "authDetails": { "authMethod": "BASIC_AUTH", "userName": "user", "password": "password" }, "headers": { "content-type": "application/json" } } ] } ``` -------------------------------- ### Get Shipping Estimate - Basic Example Source: https://developer.walmart.com/us-marketplace/reference/getshippingestimate This example demonstrates a basic request to get a shipping estimate for a custom package. Ensure all required fields like purchaseOrderId, boxItems, boxDimensions, shipByDate, deliverByDate, carriers, and addresses are correctly populated. ```json { "packageType": "CUSTOM_PACKAGE", "purchaseOrderId": "91088062299813853", "boxItems": [ { "lineNumber": 1, "sku": "sku-1NMeZnK1B1MNJdXde5771022", "quantity": 1 } ], "boxDimensions": { "boxWeightUnit": "LB", "boxWeight": 0.8, "boxLength": 6, "boxWidth": 6, "boxHeight": 6, "boxDimensionUnit": "IN" }, "shipByDate": "2023-06-05T08:00:00.611Z", "deliverByDate": "2023-06-07T23:00:00.611Z", "carriers": [ "FEDEX" ], "fromAddress": { "postalCode": "91776", "countryCode": "US", "addressLines": [ "311 E VALLEY BLVD STE 112 PMB 271as" ], "city": "SAN GABRIEL1as", "state": "CA" }, "toAddress": { "postalCode": "94085", "countryCode": "US", "addressLines": [ "748 N Mathilda Ave", "Room # 224" ], "city": "SUNNYVALE", "state": "CA" }, "includeServicesNotMeetingDeliveryPromise": true } ``` -------------------------------- ### Example Shipping Configuration Source: https://developer.walmart.com/us-marketplace/reference/getshippingconfigurations This example demonstrates the structure of a shipping configuration, including partner details and category-specific lag time exceptions. ```json { "configuration": { "type": "object", "properties": { "categories": { "type": "array", "description": "List of item setup category level lag time exceptions configured for seller", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the item setup category which was used to request lag time exception" }, "fulfillmentLagTime": { "type": "integer", "description": "Maximum lag time configured for the item setup category", "format": "int32" } }, "description": "List of item setup category level lag time exceptions configured for seller" } } } } }, "example": { "partner": { "partnerId": "100009", "partnerName": "The seller's legal name", "partnerDisplayName": "The seller name shown on walmart.com", "partnerStoreId": "Partner/Seller ID for Walmart store URL" }, "configurations": [ { "configurationName": "LAG_TIME", "configuration": { "categories": [ { "name": "Art & Craft", "fulfillmentLagTime": 2 }, { "name": "Garden & Patio", "fulfillmentLagTime": 3 } ] } } ] } } ``` -------------------------------- ### Get Fulfillment Lag Time Example Source: https://developer.walmart.com/us-marketplace/reference/getlagtime This example shows how to retrieve the fulfillment lag time for a specific product using its SKU. ```APIDOC ## GET /lagtime ### Description Retrieves the fulfillment lag time for a product. ### Method GET ### Endpoint /lagtime ### Query Parameters - **sku** (string) - Required - A seller-provided Product ID. ### Response #### Success Response (200) - **sku** (string) - A seller-provided Product ID. Response will have decoded value. - **fulfillmentLagTime** (integer) - The number of days between when the item is ordered and when it is shipped. ### Response Example ```xml 1068155 1 ``` ``` -------------------------------- ### Bulk Item Setup (Multiple) API Source: https://developer.walmart.com/us-marketplace/docs/walmart-fulfillment-services-wfs-api-overview Use this API to set up new items for ingestion into the WFS system. ```APIDOC ## Bulk Item Setup (Multiple) API ### Description Sets up items for ingestion with the WFS item spec. ### Method POST ### Endpoint /v3/feeds?feedType=MP_WFS_ITEM ``` -------------------------------- ### Set up CAP SKU All Source: https://developer.walmart.com/doc/us/mp/us-mp-throttling Sets up CAP SKU All. Limited to 30 requests per minute. ```APIDOC ## POST /v3/cppreference ### Description Sets up CAP SKU All. ### Method POST ### Endpoint /v3/cppreference ### Rate Limit 30/min ``` -------------------------------- ### Sandbox API Call Example Source: https://developer.walmart.com/cl-marketplace/docs/walmart-sandbox This is an example of a GET request to a Walmart sandbox API endpoint. Use this format to test your integration. ```http GET https://sandbox.walmartapis.com/v3/reports/downloadReport?requestId=your-request-id ``` -------------------------------- ### Bulk Item Setup (Multiple) Source: https://developer.walmart.com/global-marketplace/reference/itembulkuploads Use this API for initial item setup and maintenance. This API updates items in bulk, allowing you to update up to 10,000 items at once. Updates with more than 10,000 items are not supported. To ensure optimal feed processing time, keep feed sizes below 25 MB, except for FITMENT_ACES and FITMENT_PIES feeds, which support files up to 50 MB. ```APIDOC ## POST /v3/feeds ### Description Use this API for initial item setup and maintenance. This API updates items in bulk, allowing you to update up to 10,000 items at once. Updates with more than 10,000 items are not supported. To ensure optimal feed processing time, keep feed sizes below 25 MB, except for FITMENT_ACES and FITMENT_PIES feeds, which support files up to 50 MB. You can use the Bulk Item Setup API for any of the following item spec versions by specifying the corresponding feed type as a query parameter: **FeedTypes** | **Availability** ---|--- MP_MAINTENANCE, MP_ITEM_MATCH | Global SKU_TEMPLATE_MAP | Global MP_ITEM_INTL | CA, MX, CL MP_ITEM, MP_WFS_ITEM | US Only OMNI_WFS, RETIRE_ITEM, SHIPPING_OVERRIDES, FITMENT_ACES, FITMENT_PIES, SPLIT_AND_MERGE | US Only OMNI_WFSSETUP | CA , MX **Download the request body sample from** [US Samples JSON](link-to-us-samples) [CA Samples JSON](link-to-ca-samples) [MX Samples JSON](link-to-mx-samples) [CL Samples JSON](link-to-cl-samples) ### Method POST ### Endpoint https://marketplace.walmartapis.com/v3/feeds ### Query Parameters - **feedType** (string) - Required - Enum: MP_MAINTENANCE, MP_ITEM_MATCH, SKU_TEMPLATE_MAP, MP_ITEM_INTL, MP_ITEM, MP_WFS_ITEM, OMNI_WFS, RETIRE_ITEM, SHIPPING_OVERRIDES, FITMENT_ACES, FITMENT_PIES, SPLIT_AND_MERGE, OMNI_WFSSETUP. The type of feed, which specifies the nature of the update. Choose from the above options based on the item specification version and the type of update you need to perform. ### Request Body - **file** (file) - Required - The request body consists of a Feed file attached to the request based on the feedType selected. ### Headers - **WM_SEC.ACCESS_TOKEN** (string) - Required - Access token obtained from the Token API. This is required for authenticating requests to Walmart Marketplace APIs. - **WM_CONSUMER.CHANNEL.TYPE** (string) - Optional - A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding. - **WM_QOS.CORRELATION_ID** (string) - Required - A unique ID that identifies each API call and is used to track and debug issues. Use a randomly generated GUID for this ID. - **WM_SVC.NAME** (string) - Required - Specifies the name of the Walmart service being called. - **WM_MARKET** (string) - Required - Enum: us, ca, mx, cl. The target market of the API call. - **WM_GLOBAL_VERSION** (string) - Required - Enum: 3.1. The version of the global API used. ### Responses #### Success Response (200) Successful Operation #### Error Responses - **400** Bad Request - **500** Internal Server Error ### Request Example ```shell curl --request POST \ --url https://marketplace.walmartapis.com/v3/feeds \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: us' \ --header 'accept: application/json' \ --header 'content-type: multipart/form-data' ``` ``` -------------------------------- ### Get Item Recommendations Example Source: https://developer.walmart.com/us-marketplace/reference/getassortmentrecommendations-1 This example demonstrates how to retrieve item recommendations. It includes details about the recommended items, their pricing, and competitor information. ```APIDOC ## Get Item Recommendations ### Description Retrieves a list of recommended items, including details about their pricing and competitor information. ### Method GET ### Endpoint /us-marketplace/reference/getassortmentrecommendations ### Query Parameters - **recommendationType** (string) - Required - Specifies the type of recommendation, e.g., "ITEM". - **limit** (integer) - Optional - The maximum number of records to return. - **nextCursor** (string) - Optional - Cursor for fetching the next page of results. ### Response #### Success Response (200) - **payload** (object) - Contains the recommendation details. - **recommendationType** (string) - The type of recommendation. - **meta** (object) - Metadata about the recommendations. - **totalRecords** (integer) - Total number of records available. - **recordsFetched** (integer) - Number of records fetched in this response. - **limit** (integer) - The limit applied to the number of records. - **nextCursor** (string) - Cursor for the next page of results. - **records** (array) - An array of recommended item objects. - **itemRecommendationUniqueId** (string) - Unique identifier for the item recommendation. - **itemDetails** (object) - Details of the recommended item. - **title** (string) - The title of the item. - **itemId** (string) - The Walmart item ID. - **itemPrice** (object) - Walmart's item price details. - **amount** (double) - The numerical amount of the price. - **currency** (string) - Currency associated with the price. - **shippingPrice** (object) - Walmart's item shipping price details. - **amount** (double) - The numerical amount of the price. - **currency** (string) - Currency associated with the price. - **competitors** (array) - An array of competitor item information. - **itemId** (string) - Competitor item ID. - **url** (string) - Competitor item URL. - **itemPrice** (object) - Competitor's item price details. - **amount** (double) - The numerical amount of the price. - **currency** (string) - Currency associated with the price. - **shippingPrice** (object) - Competitor's item shipping price details. - **amount** (double) - The numerical amount of the price. - **currency** (string) - Currency associated with the price. ### Request Example ```json { "recommendationType": "ITEM", "limit": 2, "nextCursor": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmFvVTU3ZXNnUktHbjNxeUJHVHJ6VHcAAAAAAAApuhZqRkg2QURYNFFGR29ZMndCRnp4eEl3" } ``` ### Response Example ```json { "payload": { "recommendationType": "ITEM", "meta": { "totalRecords": 7, "recordsFetched": 2, "limit": 2, "nextCursor": "FGluY2x1ZGVfY29udGV4dF91dWlkDXF1ZXJ5QW5kRmV0Y2gBFmFvVTU3ZXNnUktHbjNxeUJHVHJ6VHcAAAAAAAApuhZqRkg2QURYNFFGR29ZMndCRnp4eEl3" }, "records": [ { "itemRecommendationUniqueId": "552855525", "itemDetails": { "title": "Disney Mirrorverse 5\" Figure WV1 - Sulley", "itemId": "123456789", "itemPrice": { "amount": 19.99, "currency": "USD" }, "shippingPrice": { "amount": 5.99, "currency": "USD" }, "competitors": [ { "itemId": "987654321", "url": "http://competitor.com/item/987654321", "itemPrice": { "amount": 18.99, "currency": "USD" }, "shippingPrice": { "amount": 4.99, "currency": "USD" } } ] } } ] } } ``` ``` -------------------------------- ### Carrier Configuration Example Source: https://developer.walmart.com/us-marketplace/docs/create-simplified-shipping-settings-configurations This example demonstrates how to configure carrier settings, including shipping priority, carrier services, and regional applicability. It also shows how to define shipping charges based on weight. ```APIDOC ## PUT /v3/settings/shipping/simplifiedshippingsettings/account ### Description This endpoint allows you to create or update account-level simplified shipping settings. ### Method PUT ### Endpoint https://marketplace.walmartapis.com/v3/settings/shipping/simplifiedshippingsettings/account ### Request Body - **simplifiedShippingSettings** (object) - Required - Contains the simplified shipping settings configuration. - **accountConfigs** (object) - Required - Account-level configuration. - **shippingPriority** (string) - Required - The priority for shipping (e.g., "FASTEST"). - **migrateFreeShippingOffers** (boolean) - Optional - Indicates if free shipping offers should be migrated. - **carrierConfigs** (array) - Required - List of carrier configurations. - **carriers** (array) - Required - List of carriers and their services. - **carrierName** (string) - Required - The name of the carrier (e.g., "USPS"). - **carrierService** (string) - Required - The specific service offered by the carrier (e.g., "USPS_PRIORITY_MAIL_EXPRESS"). - **configurations** (array) - Required - Specific configuration details for the carriers. - **regions** (array) - Optional - Regions where this configuration applies. - **regionCode** (string) - Required - Code for the region (e.g., "C"). - **regionName** (string) - Required - Name of the region (e.g., "48 State"). - **addressTypes** (array) - Required - Types of addresses this configuration applies to (e.g., ["STREET"]). - **shippingCharge** (object) - Optional - Defines the shipping charge details. - **rateModelType** (string) - Required - The type of rate model (e.g., "PER_SHIPMENT_PRICING"). - **perShippingCharge** (object) - Required if rateModelType is PER_SHIPMENT_PRICING - Details for per-shipment charges. - **unitOfMeasure** (string) - Required - Unit of measure for the charge (e.g., "LB"). - **shippingAndHandling** (object) - Required - Shipping and handling charges. - **amount** (number) - Required - The amount. - **currency** (string) - Required - The currency (e.g., "USD"). - **chargePerWeight** (object) - Required - Charge per weight. - **amount** (number) - Required - The amount. - **currency** (string) - Required - The currency (e.g., "USD"). ### Request Example ```json { "simplifiedShippingSettings": { "accountConfigs": { "shippingPriority": "FASTEST", "migrateFreeShippingOffers": true, "carrierConfigs": [ { "carriers": [ { "carrierName": "USPS", "carrierService": "USPS_PRIORITY_MAIL_EXPRESS" } ], "configurations": [ { "regions": [ { "regionCode": "C", "regionName": "48 State" } ], "addressTypes": [ "STREET" ], "shippingCharge": { "rateModelType": "PER_SHIPMENT_PRICING", "perShippingCharge": { "unitOfMeasure": "LB", "shippingAndHandling": { "amount": 0, "currency": "USD" }, "chargePerWeight": { "amount": 0, "currency": "USD" } } } } ] } ] } } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success status of the operation. - **message** (string) - A message describing the result of the operation. #### Response Example ```json { "status": "SUCCESS", "message": "Shipping settings updated successfully." } ``` ``` -------------------------------- ### Get Item Setup Requirements Source: https://developer.walmart.com/us-marketplace/docs/get-item-setup-requirements Retrieve item setup requirements by specifying the feed type, version, and product types in the request body. ```APIDOC ## POST https://marketplace.walmartapis.com/v3/items/spec ### Description Retrieves item setup requirements for specified product types. ### Method POST ### Endpoint https://marketplace.walmartapis.com/v3/items/spec ### Parameters #### Query Parameters - **feedType** (string) - Required - The Feed Type of the Item Setup data model. - **version** (string) - Required - The specific version of the spec. - **productTypes** (array of strings) - Required - A list of product types (up to 20). ### Request Body - **feedType** (string) - Required - The Feed Type of the Item Setup data model. - **version** (string) - Required - The specific version of the spec. - **productTypes** (array of strings) - Required - A list of product types. ### Request Example ```json { "feedType": "MP_WFS_ITEM", "version": "5.0.20240517-04_08_27-api", "productTypes": [ "Baby Blankets" ] } ``` ### Response #### Success Response (200) - **spec** (object) - Contains the item setup requirements schema. ``` -------------------------------- ### Create Subscription Response Example Source: https://developer.walmart.com/us-marketplace/reference/createsubscription This example shows the structure of a successful response when creating subscriptions. It lists the created subscriptions with their IDs, partner IDs, and event details. ```json { "subscriptions": [ { "eventType": "OFFER_UNPUBLISHED", "subscriptionId": "620b45a0-b321-11ea-ac13-1f88d6025b7d", "partnerId": "12300000359", "eventVersion": "V1", "resourceName": "ITEM", "status": "ACTIVE" } ] } ``` -------------------------------- ### Order Structure Example Source: https://developer.walmart.com/us-marketplace/reference/getallorders This is an example of the structure of an order object returned by the Get All Orders API. It includes details about the purchase order, customer, shipping, and order lines. ```json { "purchaseOrderId": "2792163543930", "customerOrderId": "4851974348317", "customerEmailId": "8244CABDE158461D9BF57F92BDD147D6@relay.walmart.com", "orderType": "REGULAR", "orderDate": 1564794937000, "shippingInfo": { "phone": "5019411012", "estimatedDeliveryDate": 1565895600000, "estimatedShipDate": 1565150400000, "methodCode": "Value", "postalAddress": { "name": "Debbie Chandler", "address1": "1012 Campground Road", "city": "Cabot", "state": "AR", "postalCode": "72023", "country": "USA", "addressType": "RESIDENTIAL" } }, "orderLines": { "orderLine": [ { "lineNumber": "3", "item": { "productName": "Motorola TurboPower 15 USB-C / Type C car charger - Turbo Power for Moto Z, Z2, Z3, Z4, X4, G7, G6, G6 Plus [Not for G6 Play] (Retail Box)", "sku": "AC004" }, "charges": { "charge": [ { "chargeType": "PRODUCT", "chargeName": "ItemPrice", "chargeAmount": { "currency": "USD", "amount": 0 }, "tax": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0 } }, "taxAndOtherFees": { "taxName": "Tax1", "taxAmount": { "currency": "USD", "amount": 0 } } } ] }, "orderLineQuantity": { "unitOfMeasurement": "EACH", "amount": "1" }, "statusDate": 1565496044000, "orderLineStatuses": { "orderLineStatus": [ { "status": "Cancelled", "statusQuantity": { "unitOfMeasurement": "EACH", "amount": "1" } } ] }, "fulfillment": { "fulfillmentOption": "S2H" } } ] }, "trackingInfo": { "shipDateTime": 1566331824000, "carrierName": { "carrier": "UPS" }, "methodCode": "Value", "trackingNumber": "123456789", "trackingURL": "http://walmart.narvar.com/walmart/tracking/ups?&type=MP&seller_id=8&promise_date=08/29/2019&dzip=78717&tracking_numbers=123456789" }, "fulfillment": { "fulfillmentOption": "S2H", "shipMethod": "VALUE", "pickUpDateTime": 1566586800000 } } ``` -------------------------------- ### Get Unpublished Recommendations Source: https://developer.walmart.com/us-marketplace/docs/get-wfs-unpublished-recommendations Retrieves a list of unpublished items and insights summary. This example shows how to get the 15 most recent unpublished items, sorted by creation date. ```APIDOC ## GET /v3/wfs/recommendation/unpublished ### Description Retrieves a paginated list of unpublished items and an insights summary. Results can be filtered and sorted. ### Method GET ### Endpoint https://marketplace.walmartapis.com/v3/wfs/recommendation/unpublished ### Query Parameters - **showInsights** (boolean) - Optional - Whether to include insights in the response. - **limit** (integer) - Optional - The maximum number of items to return. - **offset** (integer) - Optional - The starting point for pagination. - **sort_order** (string) - Optional - The order to sort the results (e.g., ASC, DESC). - **sort_by** (string) - Optional - The field to sort the results by (e.g., created_date). ### Request Example ```bash GET https://marketplace.walmartapis.com/v3/wfs/recommendation/unpublished?showInsights=true&limit=15&offset=0&sort_order=DESC&sort_by=created_date ``` ### Response #### Success Response (200) - **status** (string) - The status of the response. - **payload** (object) - Contains the unpublished items and total insights. - **unpublishedItems** (array) - List of unpublished items. - **gtin** (string) - Global Trade Item Number. - **sku** (string) - Seller's Stock Keeping Unit. - **itemId** (string) - Walmart Item ID. - **brand** (string) - Brand name of the item. - **itemName** (string) - Name of the item. - **itemCondition** (string) - Condition of the item. - **unitsStored** (integer) - Number of units stored. - **publishingStatus** (string) - Current publishing status. - **insights** (object) - Insights related to the unpublished item. - **unpublishedIssueType** (string) - The reason the item is unpublished. - **estimatedStorageFee** (number) - The estimated storage cost. - **inventoryValue** (number) - The value of the inventory. - **customerFavorite** (boolean) - Indicates if the item is a customer favorite. - **totalInsights** (object) - Summary insights for all unpublished items. - **totalUnpublishedUnitsStored** (integer) - Total units stored for all unpublished items. - **totalEstimatedStorageFee** (number) - Total estimated storage fees. - **totalInventoryValue** (number) - Total inventory value. - **totalRecords** (integer) - Total number of unpublished records. #### Error Response (400) - **status** (string) - Indicates an error occurred. - **message** (string) - Description of the error. #### Error Response (500) - **status** (string) - Indicates an internal server error. - **message** (string) - Description of the error. ``` -------------------------------- ### Create Subscription with Basic Authentication Source: https://developer.walmart.com/us-marketplace/reference/createsubscription This example shows how to create a subscription with basic authentication. The `authDetails` object specifies the authentication method and credentials required for the `eventUrl`. ```json { "events": [ { "eventType": "OFFER_UNPUBLISHED", "eventVersion": "V1", "resourceName": "ITEM", "eventUrl": "https://example.com/events", "authDetails": { "authMethod": "BASIC_AUTH", "userName": "abc" } } ] } ``` -------------------------------- ### Get Feed Item Status Example Source: https://developer.walmart.com/us-marketplace/reference/getfeeditemstatus This example shows the structure of the response when retrieving the status of items in a feed. It includes overall feed information and detailed status for each item. ```APIDOC ## GET /us/marketplace/feeds/{feedId}/items/status ### Description Retrieves the ingestion status for all items within a specified feed. ### Method GET ### Endpoint /us/marketplace/feeds/{feedId}/items/status ### Parameters #### Query Parameters - **offset** (integer) - Optional - The starting point of the item status list to retrieve. - **limit** (integer) - Optional - The maximum number of item statuses to return. ### Response #### Success Response (200) - **feedId** (string) - The unique identifier for the feed. - **feedStatus** (string) - The overall status of the feed (e.g., PROCESSED, PROCESSING). - **feedSubmissionDate** (string) - The date and time the feed was submitted. - **itemsReceived** (integer) - The total number of items received in the feed. - **itemsSucceeded** (integer) - The number of items that were successfully processed. - **itemsFailed** (integer) - The number of items that failed processing. - **itemsProcessing** (integer) - The number of items currently being processed. - **offset** (integer) - The offset used for pagination. - **limit** (integer) - The limit used for pagination. - **itemDetails** (array) - A list of item-level ingestion status details. - **itemIngestionStatus** (object) - **martId** (integer) - The mart ID associated with the item. - **sku** (string) - The Stock Keeping Unit for the item. - **wpid** (string) - The Walmart Product ID for the item. - **index** (integer) - The position of the item within the original feed payload. - **itemid** (string) - The item ID. - **productIdentifiers** (object) - Product identifiers for the item. - **productIdentifier** (array) - **productIdType** (string) - The type of product identifier (e.g., GTIN, UPC). - **productId** (string) - The product identifier value. - **ingestionStatus** (string) - Item ingestion status. Allowed values: INPROGRESS, SUCCESS, DATA_ERROR, SYSTEM_ERROR, TIMEOUT_ERROR. - **ingestionErrors** (object) - List of errors for the item. - **ingestionError** (array) - **type** (string) - Error type for the item-level failure. Allowed values: DATA_ERROR, SYSTEM_ERROR, TIMEOUT_ERROR. - **code** (string) - Item-level error code. - **description** (string) - Item-level error description. #### Response Example ```xml F129C19240844B97A3C6AD8F1A2C4997@AU8BAQA PROCESSED 2019-09-12T17:53:23.059Z 1 1 0 0 0 20 0 0960B3B82687490FA5E51CB0801478A4@AU8BAgA 71ZLHHMKNS6G 0 51681142 GTIN 00363824587165 UPC 363824587165 SUCCESS ``` ``` -------------------------------- ### Set up items for WFS using Bulk Item Setup API Source: https://developer.walmart.com/ca-marketplace/docs/walmart-fulfillment-services-wfs-api-overview Use this API to set up multiple items for ingestion into the WFS system. This is the first step in preparing your inventory for WFS fulfillment. ```http POST /v3/feeds?feedType=MP_WFS_ITEM ``` -------------------------------- ### Get Carrier Rate Quote - Parcel Source: https://developer.walmart.com/global-marketplace/reference/getcarrierratequotes Example cURL request to get a rate quote for a Parcel shipment. Ensure to include necessary headers like WM_GLOBAL_VERSION and WM_MARKET. ```Shell curl --request GET \ --url 'https://marketplace.walmartapis.com/v3/fulfillment/inbound-shipments-quote?quoteType=Parcel' \ --header 'WM_GLOBAL_VERSION: 3.1' \ --header 'WM_MARKET: US' \ --header 'accept: application/json' ``` -------------------------------- ### Get Item Setup Requirements Source: https://developer.walmart.com/global-marketplace/docs/get-item-setup-requirements This API endpoint retrieves the item setup requirements for specified product types and versions. It requires feedType, version, and productTypes as query parameters. ```APIDOC ## POST https://marketplace.walmartapis.com/v3/items/spec ### Description Retrieves item setup requirements for specific product types and versions. This API is compatible with 4.X and 5.X specifications and is available in the US market only. ### Method POST ### Endpoint https://marketplace.walmartapis.com/v3/items/spec ### Query Parameters - **feedType** (string) - Required - The Feed Type of the Item Setup data model. - **version** (string) - Required - The specific version of the spec. - **productTypes** (array of strings) - Required - Up to 20 product types (e.g., "Baby Blankets", "Animal Food"). ### Request Body This endpoint does not explicitly define a request body in the provided documentation, but the example shows a JSON payload with `feedType`, `version`, and `productTypes`. ### Request Example ```json { "feedType": "MP_WFS_ITEM", "version": "5.0.20240517-04_08_27-api", "productTypes": [ "Baby Blankets" ] } ``` ### Response #### Success Response (200) - The response will contain the item setup requirements schema in JSON format. Specific fields are not detailed in the source. #### Response Example (Response example not provided in the source text) ```