### Enrol Items Example

Source: https://developer.walmart.com/us-marketplace/reference/bulkupdateitemstatus

Example payload for enrolling items. Use this to specify items for enrollment.

```json
{
  "status": "ENROLL",
  "items": [
    {
      "itemId": "2719243"
    },
    {
      "itemId": "2719255"
    }
  ]
}
```

--------------------------------

### V4.8 MP_ITEM Feed Example

Source: https://developer.walmart.com/us-marketplace/reference/itembulkuploads

An example of the MP_ITEM feed structure for version 4.8. This includes feed header information and item details for product setup.

```json
{
  "MPItemFeedHeader": {
    "sellingChannel": "marketplace",
    "processMode": "REPLACE",
    "subset": "EXTERNAL",
    "locale": "en",
    "version": "4.8",
    "subCategory": "home_other"
  },
  "MPItem": [
    {
      "Orderable": {
        "sku": "testCardSku",
        "productIdentifiers": {
          "productIdType": "GTIN",
          "productId": "06146190200012"
        },
        "productName": "Ying Yang Apron, Abstract Graphic Design Yin Yang Circle Black and White Dots Pattern Cosmos and Energy, Unisex Kitchen Bib with Adjustable Neck for Cooking Gardening, Adult Size, Red, by Ambesonne",
        "brand": "davidson",
        "price": 1,
        "ShippingWeight": 1,
        "MustShipAlone": "No"
      },
      "Visible": {
        "Home Decor, Kitchen, & Other": {
          "shortDescription": "shelf",
          "mainImageUrl": "https://i5-qa.walmartimages.com/asr/9e9d04d1-6520-448e-b336-f40b7fb98707.c4c99539377709c2a9e332558177be8b.jpeg",
          "keyFeatures": [
            "@generated"
          ]
        }
      }
    }
  ]
}
```

--------------------------------

### Example Subscription Response

Source: https://developer.walmart.com/us-marketplace/reference/getallsubscriptions

An example of a subscription object returned by the API.

```APIDOC
## Example Response Body

### Success Response (200)

### Response Example
```json
{
  "events": [
    {
      "eventType": "OFFER_UNPUBLISHED",
      "subscriptionId": "243ba4d0-b322-11ea-b385-0127e9b85538",
      "partnerId": "10000000359"
    }
  ]
}
```
```

--------------------------------

### Request with SKUs Example

Source: https://developer.walmart.com/us-marketplace/reference/getshipmentquantityrecommendations

Use this example when you need to request replenishment information using a list of SKUs. Ensure the SKUs are valid and correctly formatted.

```json
{
  "listOfGtins": [],
  "listOfSkus": [
    "79903-108",
    "79903-109",
    "79903-110"
  ]
}
```

--------------------------------

### Request with GTINs Example

Source: https://developer.walmart.com/us-marketplace/reference/getshipmentquantityrecommendations

Use this example when you need to request replenishment information using a list of GTINs. Ensure the GTINs are valid and correctly formatted.

```json
{
  "listOfGtins": [
    "00723508807642",
    "00643131798370",
    "00643131799155"
  ],
  "listOfSkus": []
}
```

--------------------------------

### Subscription Event Example

Source: https://developer.walmart.com/us-marketplace/reference/updatesubscription

This snippet shows an example of a subscription event payload, including details about the event, resource, and authentication.

```APIDOC
## POST /subscriptions/events

### Description
This endpoint is used to receive and process subscription events from Walmart Marketplace.

### Method
POST

### Endpoint
/subscriptions/events

### Request Body
- **eventType** (string) - Required - The type of event that occurred (e.g., OFFER_UNPUBLISHED).
- **subscriptionId** (string) - Required - The unique identifier for the subscription.
- **partnerId** (string) - Required - The ID of the partner.
- **eventVersion** (string) - Required - The version of the event.
- **resourceName** (string) - Required - The name of the resource associated with the event.
- **eventUrl** (string) - Required - The URL to get more details about the event.
- **headers** (object) - Optional - HTTP headers required for accessing the destination URL.
  - **content-type** (string) - Optional - HTTP content type expected by the destination endpoint.
- **authDetails** (object) - Optional - Authentication details for accessing the destination URL.
  - **authHeaderName** (string) - Optional - Header name used to pass the authorization value.
  - **authMethod** (string) - Optional - Authentication method (e.g., BASIC_AUTH, OAUTH).
  - **userName** (string) - Optional - Username for basic authentication.
  - **password** (string) - Optional - Password for basic authentication.
  - **authUrl** (string) - Optional - OAuth server or token URL.
  - **clientSecret** (string) - Optional - Client secret for OAuth.
  - **clientId** (string) - Optional - Client ID for OAuth.
- **status** (string) - Required - The status of the subscription.

### Request Example
```json
{
  "eventType": "OFFER_UNPUBLISHED",
  "subscriptionId": "243ba4d0-b322-11ea-b385-0127e9b85538",
  "partnerId": "12300000359",
  "eventVersion": "V1",
  "resourceName": "ITEM",
  "eventUrl": "https://example.com/events",
  "headers": {
    "content-type": "application/json"
  },
  "authDetails": {
    "authHeaderName": "Authorization",
    "authMethod": "BASIC_AUTH",
    "userName": "abc",
    "password": "test"
  },
  "status": "ACTIVE"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Subscription event received successfully."
}
```
```

--------------------------------

### Subscription Event Example

Source: https://developer.walmart.com/us-marketplace/reference/getallsubscriptions

This is an example of a subscription event payload. It includes details about the event type, subscription ID, and partner ID.

```json
{
  "events": [
    {
      "eventType": "OFFER_UNPUBLISHED",
      "subscriptionId": "243ba4d0-b322-11ea-b385-0127e9b85538",
      "partnerId": "10000000359"
    }
  ]
}
```

--------------------------------

### Search Items Example Payload

Source: https://developer.walmart.com/us-marketplace/reference/getcatalogsearch

Example of a successful response when searching for items, including basic item details.

```json
{
  "All": 682
}
```

--------------------------------

### Example Event Payload

Source: https://developer.walmart.com/us-marketplace/reference/updatesubscription

This is an example of an event payload for the OFFER_UNPUBLISHED event. It includes details about the subscription, partner, resource, event URL, headers, and authentication.

```json
{
  "eventType": "OFFER_UNPUBLISHED",
  "subscriptionId": "243ba4d0-b322-11ea-b385-0127e9b85538",
  "partnerId": "12300000359",
  "eventVersion": "V1",
  "resourceName": "ITEM",
  "eventUrl": "https://example.com/events",
  "headers": {
    "content-type": "application/json"
  },
  "authDetails": {
    "authHeaderName": "Authorization",
    "authMethod": "BASIC_AUTH",
    "userName": "abc",
    "password": "test"
  },
  "status": "ACTIVE"
}
```

--------------------------------

### Item Price Response Example

Source: https://developer.walmart.com/us-marketplace/reference/updateprice

Example of a successful Item Price API response in XML format. This indicates the price of an item has been updated and may take up to five minutes to reflect on Walmart.com.

```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:ItemPriceResponse xmlns:ns2="http://walmart.com/">
    <ns2:mart>WALMART_US</ns2:mart>
    <ns2:sku>97964_KFTest</ns2:sku>
    <ns2:message>The price of the item has been updated. Allow up to five minutes for this change to be reflected on the Walmart.com.</ns2:message>
</ns2:ItemPriceResponse>

```

--------------------------------

### POST /v3/cppreference

Source: https://developer.walmart.com/us-marketplace/reference/optcapprograminprice

Set up CAP SKU All (Legacy). This API helps Sellers to completely opt-in or opt-out from CAP program.

```APIDOC
## POST /v3/cppreference

### Description
This API helps Sellers to completely opt-in or opt-out from CAP program.

If the subsidyEnrolled value = "true", the Seller enrolls in the CAP program. All eligible SKUs (current and future) are by default opt-in. Seller should use the SKU opt-in/opt-out API to opt-out individual items.

If the subsidyEnrolled value = "false", the Seller stops participating in the CAP program and all eligible SKUs (current and future) are opt-out of the CAP program.

### Method
POST

### Endpoint
https://marketplace.walmartapis.com/v3/cppreference

### Parameters
#### Header Parameters
- **WM_SEC.ACCESS_TOKEN** (string) - Required - The access token retrieved in the Token API call
- **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 which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
- **WM_SVC.NAME** (string) - Required - Walmart Service Name

### Request Body
- **subsidyEnrolled** (boolean) - Required - A Boolean parameter that allows all sellers to completely enroll in or out of the Competitive Price Adjustment program
- **subsidyPreference** (boolean) - Optional - A Boolean parameter that determines whether offer level subsidy setting override seller level subsidy setting

### Request Example
```json
{
  "subsidyEnrolled": true,
  "subsidyPreference": false
}
```

### Response
#### Success Response (200)
- **martId** (string) - A unique ID that a user or seller uses for a marketplace.
- **statusInfo** (object) - Contains status information about the operation.
  - **subsidyEnrolled** (boolean) - A Boolean parameter that allows all sellers to completely enroll in or out of the Competitive Price Adjustment program
  - **subsidyPreference** (boolean) - A Boolean parameter that determines whether offer level subsidy setting override seller level subsidy setting

#### Response Example
```json
{
  "martId": "9876",
  "statusInfo": {
    "subsidyEnrolled": true,
    "subsidyPreference": false
  }
}
```
```

--------------------------------

### Create Working Directory

Source: https://developer.walmart.com/us-marketplace/reference/multichannel-solutions-java-openapi-client-integration-guide

Creates a new directory for the integration and navigates into it.

```bash
mkdir walmart-mcs-integration
cd walmart-mcs-integration
```

--------------------------------

### GET /simulations/items

Source: https://developer.walmart.com/us-marketplace/reference/getitems

Retrieves a list of all items currently simulated in the Marketplace dynamic sandbox. This endpoint is useful for verifying simulation setups or retrieving existing simulated item data.

```APIDOC
## GET /simulations/items

### Description
This request lists all items in the Marketplace dynamic sandbox.

### Method
GET

### Endpoint
/simulations/items

### Parameters
#### Header Parameters
- **Accept** (string) - Optional - Specifies the data type expected in a response sent from the server. Valid values are: application/json.
- **WM_SEC.ACCESS_TOKEN** (string) - Required - Access token returned by the Token API. This value is required for token-based authentication.
- **WM_SVC.NAME** (string) - Required - Specifies the name of the Walmart service being called.

### Response
#### Success Response (200)
- **SellerItem** (array) - A list of seller items.

#### Error Response (400)
- **error** (array) - Array of objects containing error information.
  - **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.
```

--------------------------------

### Get Access Token using Authorization Code Grant

Source: https://developer.walmart.com/us-marketplace/reference

This example demonstrates how to request an access token using the Authorization Code grant type. The 'code' and 'redirect_uri' parameters are required for this grant type.

```shell
curl --request POST \
     --url https://marketplace.walmartapis.com/v3/token \
     --header 'accept: application/json' \
     --header 'content-type: application/x-www-form-urlencoded' \
     --data grant_type=authorization_code \
     --data code=65CA5DA313A549D49D15D3119D9AD85D \
     --data redirect_uri=https://example-client-app.com
```

--------------------------------

### GET /v3/webhooks/eventTypes

Source: https://developer.walmart.com/us-marketplace/reference/geteventtypes

Retrieve the list of event types and resource names available for subscription. Notifications are triggered only for event types that you subscribe to using the create subscription API. Event types are workflow events fired when statuses or conditions change (for example, an offer moving from published to unpublished, an order auto-cancellation, or a buy box change). Resource names are functional API categories (for example, ITEM, PRICE, ORDER, INVENTORY). Permissions to subscribe to an event type are governed by the resource's delegated access permissions.

```APIDOC
## GET /v3/webhooks/eventTypes

### Description
Retrieve the list of event types and resource names available for subscription. Notifications are triggered only for event types that you subscribe to using the create subscription API.

Event types are workflow events fired when statuses or conditions change (for example, an offer moving from published to unpublished, an order auto-cancellation, or a buy box change).

Resource names are functional API categories (for example, ITEM, PRICE, ORDER, INVENTORY). Permissions to subscribe to an event type are governed by the resource's delegated access permissions.

### Method
GET

### Endpoint
/v3/webhooks/eventTypes

### Parameters
#### Header Parameters
- **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 identify 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 - Name of the Walmart service being called.

### Response
#### Success Response (200)
- **eventTypes** (array) - List of event type definitions available for subscription.
  - **resourceName** (string) - Resource (functional category) that the event type maps to (for example, ITEM, PRICE, ORDER).
  - **eventType** (string) - Event type you can subscribe to.
  - **eventVersion** (string) - Version identifier of the event type.
  - **description** (string) - Description of the specific event type.

#### Response Example
```json
{
  "events": [
    {
      "resourceName": "INVENTORY",
      "eventType": "INVENTORY_OOS",
      "eventVersion": "V1",
      "description": "Notification for inventory out of stock"
    },
    {
      "resourceName": "ITEM",
      "eventType": "OFFER_PUBLISHED",
      "eventVersion": "V1",
      "description": "Notification when an offer is published."
    }
  ]
}
```
```

--------------------------------

### Bulk Item Setup (Multiple) API

Source: https://developer.walmart.com/us-marketplace/reference/fulfillment

Sets up new items for ingestion with the WFS item spec.

```APIDOC
## POST /v3/feeds?feedType=MP_WFS_ITEM

### Description
Sets up new items for ingestion with the WFS item spec.

### Method
POST

### Endpoint
/v3/feeds?feedType=MP_WFS_ITEM

### Parameters
#### Query Parameters
- **feedType** (string) - Required - Specifies the feed type as MP_WFS_ITEM.

### Request Body
(Refer to the Bulk Item Setup API documentation for request body details)

### Response
#### Success Response (200)
- **feedId** (string) - The ID of the feed submitted.

#### Response Example
{
  "feedId": "123456789"
}
```

--------------------------------

### Build Generated Java Client with Maven

Source: https://developer.walmart.com/us-marketplace/reference/multichannel-solutions-java-openapi-client-integration-guide

Navigates to the generated client project directory and builds it using Maven. This compiles the code, downloads dependencies, and installs the artifact locally.

```bash
cd walmart-mcs-java-client
mvn clean install
```

--------------------------------

### GET /v3/inventory

Source: https://developer.walmart.com/us-marketplace/reference/getinventory

Retrieve the current inventory for a single SKU. You can specify a shipNode to get inventory for a particular fulfillment center, or omit it to get inventory for your default ship node.

```APIDOC
## GET /v3/inventory

### Description
Retrieve the current inventory for a single SKU.

• If you do not add the `shipNode` query parameter, Walmart returns the quantity at your default ship node.
• Add `shipNode` to see stock at a specific fulfillment center.

Use this call to confirm stock before you accept or ship orders. The response shows the number of units available to sell (`amount`), the unit of measure (`EACH`), and the date the inventory becomes available if you set one.

### Method
GET

### Endpoint
/v3/inventory

### Parameters
#### Query Parameters
- **sku** (string) - Required - A unique alphanumeric ID you assign to each item. Use the same value in every request that references the item, including your XSD catalog file.

If the SKU contains any of the following characters, encode them:

": / ? # [ ] @ ! $ & ' ( ) * + , ; = { } %"

Encode spaces as "%20". You do not need to encode any other characters.
- **shipNode** (string) - Optional - The unique ID of the ship node (fulfillment center) whose inventory you want to retrieve. If you omit this parameter, the response includes inventory for every ship node linked to your seller seller account.

#### Header Parameters
- **WM_SEC.ACCESS_TOKEN** (string) - Required - The access token retrieved in the Token API call
- **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 which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
- **WM_SVC.NAME** (string) - Required - Walmart Service Name

### Response
#### Success Response (200)
- **sku** (string) - A unique alphanumeric ID you assign to each item. The response returns the decoded SKU.
- **quantity** (object) - Required - Contains the amount and unit of the inventory.
  - **unit** (string) - A unit of measure. Walmart Marketplace supports only `EACH`, which indicates one individual sellable item.
  - **amount** (number) - The number of units available for the item.
```

--------------------------------

### Dis-Enrol Items Example

Source: https://developer.walmart.com/us-marketplace/reference/bulkupdateitemstatus

Example payload for dis-enrolling items. Use this to specify items for removal.

```json
{
  "status": "DISENROLL",
  "items": [
    {
      "itemId": "2719243"
    },
    {
      "itemId": "2719255"
    }
  ]
}
```

--------------------------------

### Sample 1: Ship Node Details

Source: https://developer.walmart.com/us-marketplace/reference/updatefulfillmentcenter

Provides details for a specific ship node, including its type, status, address, and supported shipping services. This is a basic configuration example.

```json
{
  "shipNode": "84955660770217985",
  "nodeType": "PHYSICAL",
  "shipNodeName": "Seller test-distributor",
  "status": "ACTIVE",
  "timeZone": "PST",
  "distributorSupportedServices": [
    "TWO_DAY_DELIVERY"
  ],
  "customNodeId": "91ab1234",
  "postalAddress": {
    "addressLine1": "111 CALIFORNIA SA",
    "city": "SC GABRIEL",
    "state": "CA",
    "country": "USA",
    "postalCode": "90706"
  },
  "shippingDetails": [
    {
      "twoDayShipping": [
        {
          "carrierMethodName": "FEDEX",
          "carrierMethodType": "GROUND"
        }
      ]
    }
  ]
}
```

--------------------------------

### Calendar Day Configurations Example

Source: https://developer.walmart.com/us-marketplace/reference/createfulfillmentcenter

Illustrates calendar day configurations for a ship node, including standard processing schedules for each day of the week and additional days off. This is useful for managing fulfillment schedules.

```json
{
  "shipNode": "91539778610008065",
  "nodeType": "PHYSICAL",
  "shipNodeName": "my distrubutor786",
  "status": "ACTIVE",
  "timeZone": "PST",
  "distributorSupportedServices": [
    "TWO_DAY_DELIVERY"
  ],
  "customNodeId": "92hb1234",
  "postalAddress": {
    "addressLine1": "36 CALIFORNIA SAA233",
    "city": "SC GABRIEL22",
    "state": "CA",
    "country": "USA",
    "postalCode": "90100"
  },
  "shippingDetails": [
    {
      "twoDayShipping": [
        {
          "carrierMethodName": "FEDEX",
          "carrierMethodType": "GROUND"
        }
      ]
    }
  ],
  "calendarDayConfiguration": {
    "standardProcessingSchedule": {
      "sunday": {
        "isWorkingDay": false
      },
      "monday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "tuesday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "wednesday": {
        "isWorkingDay": false
      },
      "thursday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "friday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "saturday": {
        "isWorkingDay": true,
        "cutOffTime": "15:45"
      }
    },
    "additionalDaysOff": [
      "2030-12-24",
      "2030-12-25"
    ]
  }
}
```

--------------------------------

### GET /v3/insights/performance/refunds/report

Source: https://developer.walmart.com/us-marketplace/reference/getrefundsordersreport

Retrieves a report of all orders impacting Refunds metrics. This API is deprecated and will be removed on March 27, 2027. Consider using the Get Returns Performance Orders Report and Get Item Not Received Metrics APIs instead.

```APIDOC
## GET /v3/insights/performance/refunds/report

### Description
Returns the report of all the orders impacting Refunds metrics.

**Deprecation notice**: This API is in legacy state and will be removed on March 27, 2027. We recommend transitioning to the <a href="https://developer.walmart.com/us-marketplace/reference/getreturnreport">Get Returns Performance Orders Report</a> and <a href="https://developer.walmart.com/us-marketplace/reference/getinrreport">Get Item Not Received Metrics</a> APIs.

### Method
GET

### Endpoint
/v3/insights/performance/refunds/report

### Parameters
#### Query Parameters
- **reportDuration** (integer) - Optional - Report Duration in days (default: 30)

#### Header Parameters
- **Authorization** (string) - Required - Basic authorization header. Base 64 encodes the Client ID and Client Secret retrieved in step two of the integration steps.
- **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 identify 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.

### Response
#### Success Response (200)
- **data** (string) - The data will be returned in a .xlsx file in your folder.

#### Response Example
(Binary data for .xlsx file)
```

--------------------------------

### Sample 2: Calendar Day Configurations

Source: https://developer.walmart.com/us-marketplace/reference/updatefulfillmentcenter

Includes ship node details along with specific calendar day configurations, defining working days, cut-off times, and additional days off. Use this for detailed scheduling.

```json
{
  "shipNode": "84955660770217985",
  "nodeType": "PHYSICAL",
  "shipNodeName": "Seller test-distributor",
  "status": "ACTIVE",
  "timeZone": "PST",
  "distributorSupportedServices": [
    "TWO_DAY_DELIVERY"
  ],
  "customNodeId": "91ab1234",
  "postalAddress": {
    "addressLine1": "111 CALIFORNIA SA",
    "city": "SC GABRIEL",
    "state": "CA",
    "country": "USA",
    "postalCode": "90706"
  },
  "shippingDetails": [
    {
      "twoDayShipping": [
        {
          "carrierMethodName": "FEDEX",
          "carrierMethodType": "GROUND"
        }
      ]
    }
  ],
  "calendarDayConfiguration": {
    "standardProcessingSchedule": {
      "sunday": {
        "isWorkingDay": false
      },
      "monday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "tuesday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "wednesday": {
        "isWorkingDay": false
      },
      "thursday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "friday": {
        "isWorkingDay": true,
        "cutOffTime": "11:30"
      },
      "saturday": {
        "isWorkingDay": true,
        "cutOffTime": "15:45"
      }
    },
    "additionalDaysOff": [
      "2021-12-24",
      "2021-12-25"
    ]
  }
}
```

--------------------------------

### Item Response Example

Source: https://developer.walmart.com/us-marketplace/reference/getanitem

An example of the XML response for an item, detailing its attributes, status, and potential duplication information.

```APIDOC
## GET /items/response

### Description
Retrieves the response for an item, including details about its status, attributes, and any duplication information.

### Method
GET

### Endpoint
/items/response

### Response
#### Success Response (200)
- **ItemResponse** (object) - Contains details about the item response.
  - **mart** (string) - The marketplace identifier (e.g., WALMART_US).
  - **sku** (string) - The Stock Keeping Unit.
  - **condition** (string) - The condition of the item (e.g., New).
  - **availability** (string) - The availability status (e.g., Preorder).
  - **wpid** (string) - Walmart Product ID.
  - **gtin** (string) - Global Trade Item Number.
  - **productName** (string) - The name of the product.
  - **productType** (string) - The type of the product.
  - **price** (object) - Pricing information.
    - **currency** (string) - The currency of the price (e.g., USD).
    - **amount** (string) - The price amount.
  - **publishedStatus** (string) - The publication status (e.g., UNPUBLISHED).
  - **unpublishedDescription** (string) - Description explaining why the item is unpublished.
  - **lifecycleStatus** (string) - The lifecycle status of the item (e.g., RETIRED).
  - **isDuplicate** (boolean) - Indicates if the item is a duplicate.
  - **isCustomerFavorite** (boolean) - Indicates if the item is a customer favorite.
  - **duplicateItemDetails** (object) - Details about duplicate items.
    - **status** (string) - The status of the duplicate item.
    - **lastUpdatedDate** (string) - The date the duplicate item was last updated.
    - **identifiedDate** (string) - The date the duplicate item was identified.
    - **destinationItem** (object) - Details of the destination item.
      - **mart** (string) - The marketplace identifier.
      - **wpid** (string) - Walmart Product ID.
      - **upc** (string) - Universal Product Code.
      - **gtin** (string) - Global Trade Item Number.
      - **productName** (string) - The name of the destination product.
      - **productType** (string) - The type of the destination product.
    - **productAttributes** (object) - Attributes of the product.
      - **attributeName** (object) - Represents an attribute.
        - **sourceItemValue** (string) - The value from the source item.
        - **destinationItemValue** (string) - The value from the destination item.

#### Response Example
```xml
<?xml version="1.0" encoding="UTF-8"?>
<ns2:ItemResponses xmlns:ns2="http://walmart.com/">
        <ns2:ItemResponse>
                <ns2:mart>WALMART_US</ns2:mart>
                <ns2:sku>setup_by_ref</ns2:sku>
                <ns2:condition>New</ns2:condition>
                <ns2:availability>Preorder</ns2:availability>
                <ns2:wpid>2VYRD2YCHYX1</ns2:wpid>
                <ns2:gtin>05518319011365</ns2:gtin>
                <ns2:productName>WL_Sim_verizon</ns2:productName>
                <ns2:productType>Music</ns2:productType>
                <ns2:price>
                    <ns2:currency>USD</ns2:currency>
                    <ns2:amount>12.00</ns2:amount>
                </ns2:price>
                <ns2:publishedStatus>UNPUBLISHED</ns2:publishedStatus>
                <ns2:unpublishedDescription>
                    Your item is unpublished because the end date has passed. To republish your item, re-ingest the item with a new start and end date.
                </ns2:unpublishedDescription>
                <ns2:lifecycleStatus>RETIRED</ns2:lifecycleStatus>
                <ns2:isDuplicate>true</ns2:isDuplicate>
     <ns2:isCustomerFavorite>true</ns2:isCustomerFavorite>
             <ns2:duplicateItemDetails>
                        <ns2:status>IN_REVIEW</ns2:status>
                        <ns2:lastUpdatedDate>
                                Date</ns2:lastUpdatedDate>
                        <ns2:identifiedDate>
                                Date</ns2:identifiedDate>
                        <ns2:destinationItem>
                                <ns2:mart>WALMART_US</ns2:mart>
                                <ns2:wpid>22CQHNCN3EIA</ns2:wpid>
                                <ns2:upc>461011651375</ns2:upc>
                                <ns2:gtin>00461011651375</ns2:gtin>
                                <ns2:productName>(6 pack) Rio Luna Organic Diced Green Chiles</ns2:productName>
                                <ns2:productType>Canned & Jarred Vegetables</ns2:productType>
                        </ns2:destinationItem>
                        <ns2:productAttributes>
                                <ns2:attributeName>
                                        <ns2:sourceItemValue>a</ns2:sourceItemValue>
                                        <ns2:destinationItemValue>b</ns2:destinationItemValue>
                                </ns2:attributeName>
                        </ns2:productAttributes>
                </ns2:duplicateItemDetails>
        </ns2:ItemResponse>
</ns2:ItemResponses>
```
```

--------------------------------

### Ship Node Configuration Example

Source: https://developer.walmart.com/us-marketplace/reference/createfulfillmentcenter

Example JSON payload for configuring a ship node, including its name, status, time zone, supported services, custom ID, postal address, and shipping details.

```json
{
  "shipNodeHeader": {
    "version": "1.2"
  },
  "shipNode": [
    {
      "shipNodeName": "my distrubutor786",
      "status": "ACTIVE",
      "timeZone": "PST",
      "distributorSupportedServices": [
        "TWO_DAY_DELIVERY"
      ],
      "customNodeId": "92hb1234",
      "postalAddress": {
        "addressLine1": "36 CALIFORNIA SAA233",
        "city": "SC GABRIEL22",
        "state": "CA",
        "country": "USA",
        "postalCode": "90100"
      },
      "shippingDetails": [
        {
          "twoDayShipping": [
            {
              "carrierMethodName": "FEDEX",
              "carrierMethodType": "GROUND"
            }
          ]
        }
      ]
    }
  ]
}
```

--------------------------------

### POST /v3/feeds

Source: https://developer.walmart.com/us-marketplace/reference/itembulkuploads

Use this API for initial item setup and maintenance. It allows for bulk updates of up to 10,000 items at once. Feed sizes should ideally be kept below 25 MB, with exceptions for FITMENT_ACES and FITMENT_PIES feeds 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.

The Bulk Item Setup API supports requests in two formats: file as an attachment or provide the JSON payload directly in the request body. The API supports all feed types and spec versions identified in the Item spec: Versioning and diff reporting article. Make sure to include the correct feed type as a query parameter in your request. Available feed types:

*   MP_ITEM: Set up a new seller fulfilled item.
*   MP_WFS_ITEM: Set up a new Walmart fulfilled item. 
*   MP_MAINTENANCE: Update existing items in your catalog.
*   MP_ITEM_MATCH: Use item setup info from an existing Walmart catalog item to set up your own offer. 
*   OMNI_WFS: Convert a seller fulfilled item to Walmart fulfilled item. 
*  FITMENT_ACES/FITMENT_PIES: For automotive fitment items. Requires a zip file in the request body.
*   DELETE_ITEM: Delete seller-fulfilled items from your catalog.

<b>Download and review the request body samples for guidance on formatting the updated feed file before uploading it for processing.</b>

### Method
POST

### Endpoint
/v3/feeds

### Parameters
#### Query Parameters
- **feedType** (string) - Required - The type of feed specifies the nature of the update. Select an option from the drop-down list based on the item specification version and the type of update you need to perform. Example: MP_WFS_ITEM indicates the new WFS Item set up.
Available options: RETIRE_ITEM, MP_ITEM, MP_WFS_ITEM, MP_ITEM_MATCH, MP_MAINTENANCE, SKU_TEMPLATE_MAP, SHIPPING_OVERRIDES, OMNI_WFS, FITMENT_ACES, FITMENT_PIES, SPLIT_AND_MERGE, DELETE_ITEM

#### Header Parameters
- **Content-Type** (string) - Required - The feed payload can be submitted either as a file attachment or as a JSON payload in the request body. When the payload is sent as a file attachment, the Content-Type must be 'multipart/form-data'. When the payload is provided as a JSON payload in the request body, the Content-Type must be 'application/json'.
Available options: application/json, multipart/form-data
- **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 identify the consumer request by channel. Use the Consumer Channel Type received during onboarding.
- **WM_QOS.CORRELATION_ID** (string) - Optional - A unique ID to track the request across different services.

### Request Example
```json
{
  "example": "request body"
}
```

### Response
#### Success Response (200)
- **field1** (type) - Description

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### Example API Response Payload

Source: https://developer.walmart.com/us-marketplace/reference/getreturnordersstatus

Provides an example of a successful API response payload, illustrating the structure of return order details.

```APIDOC
## Example API Response Payload

### Description
This example demonstrates the structure of a successful API response, specifically for return order details.

### Response
#### Success Response (200)
- **header** (object) - Contains header attributes like martId, buId, pageCount, and totalCount.
- **payload** (array) - An array of return order objects.
  - **returnOrderId** (string) - The unique identifier for the return order.
  - **sellerOrderId** (string) - The seller's order ID.
  - **returnOrderLines** (array) - An array of return order line items.
    - **lineNo** (string) - The line number within the return order.
    - **returnReason** (string) - The reason for the return.
    - **returnReasonDesc** (string) - A detailed description of the return reason.
    - **itemDetail** (object) - Details about the item.
      - **sku** (string) - The Stock Keeping Unit of the item.
    - **qty** (object) - Quantity information.
      - **unitOfMeasure** (string) - The unit of measure for the quantity.
      - **measurementValue** (integer) - The numerical value of the quantity.
    - **lineQuantityInfo** (array) - Information about the quantity status of the line item.
      - **status** (string) - The status of the quantity.
      - **statusCode** (integer) - The numerical status code.
      - **statusDescription** (string) - A description of the status.
      - **statusQuantity** (object) - The quantity associated with the status.
        - **unitOfMeasure** (string) - The unit of measure for the status quantity.
        - **measurementValue** (integer) - The numerical value of the status quantity.
    - **imageURL** (string) - The URL of the item's image.
    - **faultCategory** (string) - The category of the fault.
    - **currentTrackingStatuses** (array) - An array of current tracking statuses.
      - **trackingStatus** (string) - The current tracking status.
      - **quantity** (object) - The quantity associated with the tracking status.
        - **unitOfMeasure** (string) - The unit of measure for the tracking quantity.
        - **measurementValue** (integer) - The numerical value of the tracking quantity.
      - **currentTrackingStatusTime** (string) - The timestamp of the current tracking status.
  - **returnLineGroups** (array) - An array of return line groups.
    - **groupNo** (string) - The group number.
    - **returnOrderGroupLines** (array) - An array of lines within the group.

### Response Example
```json
{
  "header": {
    "headerAttributes": {
      "martId": "202",
      "buId": "0",
      "pageCount": 2,
      "totalCount": 2
    }
  },
  "payload": [
    {
      "returnOrderId": "330259024293819922",
      "sellerOrderId": "100000578939695",
      "returnOrderLines": [
        {
          "lineNo": "1",
          "returnReason": "Incorrect item",
          "returnReasonDesc": "Incorrect item received",
          "itemDetail": {
            "sku": "SKU_123"
          },
          "qty": {
            "unitOfMeasure": "EA",
            "measurementValue": 1
          },
          "lineQuantityInfo": [
            {
              "status": "RETURN_CANCELLED",
              "statusCode": 9000,
              "statusDescription": "Return Cancelled",
              "statusQuantity": {
                "unitOfMeasure": "EA",
                "measurementValue": 1
              }
            }
          ],
          "imageURL": "image.jpeg",
          "faultCategory": "SELLER",
          "currentTrackingStatuses": [
            {
              "trackingStatus": "RETURN_CANCELLED",
              "quantity": {
                "unitOfMeasure": "EACH",
                "measurementValue": 1
              },
              "currentTrackingStatusTime": "2024-11-19T00:44:44Z"
            }
          ]
        }
      ],
      "returnLineGroups": [
        {
          "groupNo": "1",
          "returnOrderGroupLines": [
            {
              "lineNo": "1"
            }
          ]
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Get Refunded Orders Report (Deprecated)

Source: https://developer.walmart.com/us-marketplace/reference/getrefundsordersreport

This API returns the report of all the orders impacting Refunds metrics. It is in a legacy state and will be removed on March 27, 2027. Users are recommended to transition to the Get Returns Performance Orders Report and Get Item Not Received Metrics APIs.

```APIDOC
## Get Refunded Orders Report (Deprecated)

### Description
Returns the report of all the orders impacting Refunds metrics.

### Deprecation Notice
This API is in legacy state and will be removed on March 27, 2027. We recommend transitioning to the <a href="https://developer.walmart.com/us-marketplace/reference/getreturnreport">Get Returns Performance Orders Report</a> and <a href="https://developer.walmart.com/us-marketplace/reference/getinrreport">Get Item Not Received Metrics</a> APIs.

### Method
GET

### Endpoint
/v3/reporting/refundedOrders
```

--------------------------------

### Sample Subscription Configuration

Source: https://developer.walmart.com/us-marketplace/reference/createsubscription

This JSON structure defines an array of event subscriptions. Each subscription maps an event type and version to a resource and a destination URL. It can also include authentication details and status.

```json
{
  "events": [
    {
      "eventType": "OFFER_UNPUBLISHED",
      "eventVersion": "V1",
      "resourceName": "ITEM",
      "eventUrl": "https://example.com/events",
      "status": "ACTIVE"
    },
    {
      "eventType": "PO_CREATED",
      "eventVersion": "V1",
      "resourceName": "ORDER",
      "eventUrl": "https://example.com/orders",
      "status": "ACTIVE"
    }
  ]
}
```

```json
{
  "events": [
    {
      "eventType": "OFFER_UNPUBLISHED",
      "eventVersion": "V1",
      "resourceName": "ITEM",
      "eventUrl": "https://example.com/events",
      "authDetails": {
        "authMethod": "BASIC_AUTH",
        "userName": "abc",
        "password": "test"
      }
    }
  ]
}
```