Walmart
Walmart Insight API

The Insight API from Walmart — 7 operation(s) for insight.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.1
info:
  title: Walmart Cost Management Assortment Recommendations Insight API
  description: 'This API allows drop ship vendor (DSV) users to update cost for items in bulk.


    **May 2024**<br>Built: 05/09/2024, 13:05:34

    '
  version: '1.0'
servers:
- url: https://api-gateway.walmart.com
  description: Production URL
- url: https://sandbox.walmartapis.com
  description: Sandbox URL
tags:
- name: Insight
paths:
  /v3/insights/items/listingQuality/items:
    post:
      tags:
      - Insight
      summary: Walmart Item Listing Quality Details
      description: 'Get each item''s listing quality details including: item quality score, offer score, content score and issues, and item performance.'
      externalDocs:
        description: View Guide
        url: /doc/us/mp/us-mp-insights/#3880
      operationId: itemsDetailsForListing
      parameters:
      - name: limit
        in: query
        description: Specify number of items to return. If no limit is specified, API returns 200 items by default.
        required: false
        schema:
          type: string
          default: '200'
      - name: nextCursor
        in: query
        description: Specify pagination for long list of items.
        required: false
        schema:
          type: string
      - in: header
        name: WM_SEC.ACCESS_TOKEN
        description: The access token retrieved in the Token API call
        required: true
        schema:
          type: string
        example: eyJraWQiOiIzZjVhYTFmNS1hYWE5LTQzM.....
      - in: header
        name: WM_CONSUMER.CHANNEL.TYPE
        description: A unique ID to track the consumer request by channel. Use the Consumer Channel Type received during onboarding
        required: false
        schema:
          type: string
      - in: header
        name: WM_QOS.CORRELATION_ID
        description: A unique ID which identifies each API call and used to track and debug issues; use a random generated GUID for this ID
        required: true
        schema:
          type: string
        example: b3261d2d-028a-4ef7-8602-633c23200af6
      - in: header
        name: WM_SVC.NAME
        description: Walmart Service Name
        required: true
        schema:
          type: string
        example: Walmart Service Name
      requestBody:
        description: Request payload
        content:
          application/json:
            schema:
              type: object
              properties:
                query:
                  type: object
                  properties:
                    field:
                      type: string
                      description: '| Attribute | Description | Data Type

                        | --- | ----------- | -------

                        | title | Product Title | string |

                        | sku | An arbitrary alphanumeric unique ID, seller-specified, identifying each item | string |

                        | itemId | Specifies the item identifier generated by Walmart | string |'
                      enum:
                      - title
                      - sku
                      - itemId
                    value:
                      type: string
                filters:
                  type: array
                  items:
                    type: object
                    properties:
                      field:
                        type: string
                        description: '| Attribute | Description | Data Type

                          | --- | ----------- | -------

                          | contentDiscoverabilityPercentage | Item''s content and discoverability score expressed as a percentage. | string |

                          | qualityScorePercentage | Item''s overall Listing Quality score, rated as a percentage. | string |

                          | offerPercentage | Item''s offer score, based on: item price, shipping price and speed, and in-stock rate.| string |

                          | ratingReviewsPercentage | Rating and reviews score, as a percentage. | string |

                          | viewTrendingItems | Indicates to return details for trending items that have non-zero page views. Acceptable values are "true" if pageView > 0, or "false" if pageView >= 0. | string |

                          | viewPostPurchaseItems | Show items with post-purchase quality issues. If item has post-purchase value >= 1, it filters all items greater or equal based on post purchase value. | string |

                          | wfsFlag | Show WFS-eligible items. Value of this parameter can be true or false. | string |

                          | categoryName | Item''s category name. | string |

                          | hasIssues | Provides a count of item with issues. | integer |

                          | productType | Product type to classify the item (e.g. Pants). | string|

                          | attributeList | List of all available filter attributes. | string |

                          | productTypes | List of all available product. | List<String> |

                          | brandList | List of all available brand. | List<String> |

                          | oos | Filter using out of stock offer based on days. Min value = 0, Max Value = 7. | integer |

                          | fastAndFreeShipping | Possible values are 1 for offers eligible for free shipping and 0 for offers not eligible for free shipping. No value shows all the offers. | integer |

                          | priceMeetBeatFlag | Possible values are -1 for no match, 0 for lose, 1 for meets and 2 for beats. No value shows all the offers. | integer |

                          | conditionList | Specifies the condition of the item. Can take values (New, New without box, New without tags, Restored Premium, Restored, Remanufactured, Open Box, Pre-Owned: Like New, Pre-Owned: Good, Pre-Owned: Fair, New with defects) | List<String>'
                        enum:
                        - contentDiscoverabilityPercentage
                        - qualityScorePercentage
                        - offerPercentage
                        - ratingReviewsPercentage
                        - viewTrendingItems
                        - viewPostPurchaseItems
                        - wfsFlag
                        - categoryName
                        - hasIssues
                        - productType
                        - attributeList
                        - productTypes
                        - brandList
                        - oos
                        - fastAndFreeShipping
                        - priceMeetBeatFlag
                        - conditionList
                      op:
                        type: string
                        enum:
                        - equals
                        - between
                      values:
                        type: array
                        items:
                          type: integer
                          format: int32
            examples:
              Query for SKU:
                value:
                  query:
                    field: sku
                    value: WB 433KP412-12
              Filter for quality score %:
                value:
                  filters:
                  - field: qualityScorePercentage
                    op: between
                    values:
                    - 10
                    - 50
              Filter for productType:
                value:
                  filters:
                  - field: viewPostPurchaseItems
                    op: equals
                    values:
                    - 0
                  - field: productType
                    op: equals
                    values:
                    - Music
              Filter for condition:
                value:
                  filters:
                  - field: conditionList
                    op: equals
                    values:
                    - New
                    - New without tags
        required: true
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  nextCursor:
                    type: string
                  totalItems:
                    type: string
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        productId:
                          type: string
                        scoreDetails:
                          type: object
                          properties:
                            offer:
                              type: object
                              properties:
                                issueCount:
                                  type: integer
                                  format: int32
                                price:
                                  type: object
                                  properties:
                                    amount:
                                      type: string
                                      description: The numerical value of the price
                                    currency:
                                      type: string
                                      description: The currency type
                                shippingSpeed:
                                  type: object
                                  properties:
                                    shippingType:
                                      type: string
                                    issueTitle:
                                      type: string
                                    issueDesc:
                                      type: string
                                    score:
                                      type: integer
                                      format: int32
                                publishAndTransactable:
                                  type: object
                                  properties:
                                    issueTitle:
                                      type: string
                                    totalIssue:
                                      type: integer
                                      format: int32
                                    maxIssue:
                                      type: integer
                                      format: int32
                                    issues:
                                      type: array
                                      items:
                                        type: object
                                        properties:
                                          date:
                                            type: string
                                          publishFlag:
                                            type: boolean
                                          transactableFlag:
                                            type: boolean
                                    score:
                                      type: integer
                                      format: int32
                            ratingReviews:
                              type: object
                              properties:
                                maxRating:
                                  type: string
                                ratingCount:
                                  type: string
                            postPurchase:
                              type: object
                              properties:
                                cancellations:
                                  type: object
                                  properties:
                                    defectedOrder:
                                      type: integer
                                      format: int32
                                    totalOrder:
                                      type: integer
                                      format: int32
                                    rate:
                                      type: integer
                                      format: int32
                                returns:
                                  type: object
                                issueCount:
                                  type: string
                                otd:
                                  type: object
                                  properties:
                                    defectedOrder:
                                      type: integer
                                      format: int32
                                    totalOrder:
                                      type: integer
                                      format: int32
                                    rate:
                                      type: integer
                                      format: int32
                            contentAndDiscoverability:
                              type: object
                              properties:
                                issueCount:
                                  type: integer
                                  format: int32
                                issues:
                                  type: array
                                  items:
                                    type: object
                                    properties:
                                      score:
                                        type: number
                                        format: double
                                      isEditable:
                                        type: boolean
                                      attributeValue:
                                        type: string
                                      isSpecAttribute:
                                        type: boolean
                                      attributeName:
                                        type: string
                                      issueCount:
                                        type: integer
                                        format: int32
                                      issues:
                                        type: array
                                        items:
                                          type: object
                                          properties:
                                            title:
                                              type: string
                                            value:
                                              type: string
                        wfsEnabled:
                          type: string
                        priority:
                          type: string
                        productName:
                          type: string
                        itemId:
                          type: string
                        sellerId:
                          type: string
                        pageViews:
                          type: string
                        stats:
                          type: object
                          properties:
                            gmv:
                              type: object
                              properties:
                                amount:
                                  type: string
                                currency:
                                  type: string
                            pageViews:
                              type: string
                            orders:
                              type: string
                            conversionRate:
                              type: string
                            totalUnits:
                              type: string
                        imageUrL:
                          type: string
                        qualityScore:
                          type: object
                          properties:
                            score:
                              type: number
                              format: double
                            values:
                              type: array
                              items:
                                type: object
                                properties:
                                  scoreType:
                                    type: string
                                  scoreValue:
                                    type: integer
                                    format: int32
                                  impact:
                                    type: string
                        offerId:
                          type: string
                        sku:
                          type: string
                        category:
                          type: string
                        postPurchaseIssues:
                          type: string
                        productType:
                          type: string
                        condition:
                          type: string
                  status:
                    type: string
              examples:
                Query for SKU:
                  value:
                    nextCursor: AoIFQC8AAAAAAAAATQwRUM0RUVGQTRCODRCNUE5NjE2QjNEMUFGNUNDNUNC
                    totalItems: 1
                    payload:
                    - qualityScoreData:
                        score: 15.5
                        values:
                        - impact: MEDIUM
                          scoreType: content & Discoverability
                          scoreValue: 62
                        - impact: HIGH
                          scoreType: offer
                          scoreValue: 0
                        - impact: MEDIUM
                          scoreType: Rating & Reviews
                          scoreValue: 0
                      productId: 3F82A2A8W0DJ
                      scoreDetails:
                        offer:
                          shippingSpeed:
                            score: 0
                            issueDesc: Please consider providing free ThreeDay Shipping (enable through Shipping Templates) or TwoDay Shipping for customers
                            issueTitle: Consider Faster Shipping
                            shippingType: Value
                          price:
                            score: null
                            walmartShipping: 0
                            additionalDes: null
                            competitorShipping: 0
                            competitorPrice:
                              amount: 34.95
                              currency: USD
                            price:
                              amount: 36.29
                              currency: USD
                            issueTitle: Price Not Competitive
                            asin: B00PDHPL5Y
                          publishAndTransactable:
                            score: 0
                            issueTitle: Issue Detected
                            maxIssue: 7
                            totalIssue: 7
                            issues:
                            - date: '2021-05-18'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-17'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-16'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-15'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-14'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-13'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-12'
                              transactableFlag: false
                              publishFlag: true
                          issueCount: 9
                        contentAndDiscoverability:
                          issueCount: 12
                          issues:
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: capacity
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 100
                            isEditable: true
                            attributeValue: Plastic
                            isSpecAttribute: false
                            attributeName: material
                            issueCount: 0
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: manufacturer_part_number
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 99.9
                            isEditable: true
                            attributeValue: Oasis Supply
                            isSpecAttribute: true
                            attributeName: brand
                            issueCount: 0
                          - score: 100
                            isEditable: true
                            attributeValue: New
                            isSpecAttribute: false
                            attributeName: condition
                            issueCount: 0
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: color
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 100
                            isEditable: true
                            attributeValue: 00616450784447
                            isSpecAttribute: false
                            attributeName: gtin
                            issueCount: 0
                          - score: 100
                            isEditable: true
                            attributeValue: '12'
                            isSpecAttribute: false
                            attributeName: package_quantity
                            issueCount: 0
                          - score: 100
                            isEditable: false
                            attributeValue: Multi use
                            isSpecAttribute: false
                            attributeName: recommended_use
                            issueCount: 0
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: food_storage_jar_and_container_type
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 45
                            isEditable: true
                            attributeValue: 'Dimensions:  length: 12.5" - width: 9 1/2"Base width at highest point: 2 3/8"Base width at lowest point: 2" - total compartment height: 3 1/2"Compartment top diameter: 2 1/4" - compartment bottom diameter: 2"High dome. Crystal clear ,12 per order'
                            isSpecAttribute: true
                            attributeName: product_long_description
                            issueCount: 1
                            issues:
                            - title: NOT_ENOUGH_BULLET_POINTS
                              value: This description includes 0 key feature bullets, while it should contain 5 or more. Please include more key features.
                          - score: 0
                            isEditable: true
                            isSpecAttribute: true
                            attributeName: number_of_pieces
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 71.4
                            isEditable: true
                            attributeValue: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
                            isSpecAttribute: true
                            attributeName: product_name
                            issueCount: 1
                            issues:
                            - title: MISSING_KEY_ATTRIBUTES
                              value: This title includes key attributes such as 'brand', but is missing others such as 'capacity', 'material', and 'recommended use'.
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: features
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 100
                            isEditable: true
                            attributeValue: This high dome clear cupcake container comes with 12 individual compartments to store a dozen of your delectable cupcakes or muffins. This container is great for bakeries, grocery stores, and catering businesses looking to transport desserts to their events. The high dome structure helps make sure that decorative icing or toppings stay pristine during travel. The lid is detachable, so you'll be able to use this container as its own display without worrying about the top of the lid getting in the way. Just take the top off after your treats have reached their destination, and you're all set up with a grab-and-go dessert station. This container provides a tight, reliable seal, while the crystal clear OPS plastic construction gives your products optimum marketability.
                            isSpecAttribute: true
                            attributeName: product_short_description
                            issueCount: 0
                          - score: 46.6
                            attributeValue: '2'
                            isSpecAttribute: true
                            attributeName: images
                            issueCount: 5
                            issues:
                            - title: IMAGE_COUNT_TOO_LOW
                              value: This item has only 2 image(s), while this category requires the item have 5 or more images. Please add more images.
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: shape
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                        ratingReviews:
                          maxRating: 5
                          ratingCount: 0
                      wfsEnabled: 0
                      priority: LOW
                      categoryName: Food & Beverage
                      updatedTimestamp: '2021-05-20 12:56:28.984'
                      productName: Oasis Supply 12-Compartment Hinged High Dome Clear Cupcake Container, Clear, 12-Pack
                      itemId: '916854860'
                      stats:
                        orders: '0'
                        conversionRate: '0'
                        gmvAmount:
                          amount: '0'
                          currency: USD
                        totalUnits: '0'
                      sku: WB 433KP412-12
                      condition: New
                      productType: Food Storage Jars & Containers
                      trends:
                      - statsType: GMV
                      - statsType: pageViews
                      - statsType: orders
                      - statsType: conversionRate
                      - values:
                        - value:
                            currency: USD
                        statsType: totalUnits
                    status: OK
                Filter for quality score %:
                  value:
                    nextCursor: AoIFQC8AAAAAAAA/ATQwRUM0RUVGQTRCODRCNUE5NjE2QjNEMUFGNUNDNUNC
                    totalItems: 1
                    payload:
                    - qualityScoreData:
                        score: 15.5
                        values:
                        - impact: MEDIUM
                          scoreType: content & Discoverability
                          scoreValue: 62
                        - impact: HIGH
                          scoreType: offer
                          scoreValue: 0
                        - impact: MEDIUM
                          scoreType: Rating & Reviews
                          scoreValue: 0
                      productId: 3F82A2A8W0DJ
                      scoreDetails:
                        offer:
                          shippingSpeed:
                            score: 0
                            issueDesc: Please consider providing free ThreeDay Shipping (enable through Shipping Templates) or TwoDay Shipping for customers
                            issueTitle: Consider Faster Shipping
                            shippingType: Value
                          price:
                            score: null
                            walmartShipping: 0
                            additionalDes: null
                            competitorShipping: 0
                            competitorPrice:
                              amount: 34.95
                              currency: USD
                            price:
                              amount: 36.29
                              currency: USD
                            issueTitle: Price Not Competitive
                            asin: B00PDHPL5Y
                          publishAndTransactable:
                            score: 0
                            issueTitle: Issue Detected
                            maxIssue: 7
                            totalIssue: 7
                            issues:
                            - date: '2021-05-18'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-17'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-16'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-15'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-14'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-13'
                              transactableFlag: false
                              publishFlag: true
                            - date: '2021-05-12'
                              transactableFlag: false
                              publishFlag: true
                          issueCount: 9
                        contentAndDiscoverability:
                          issueCount: 12
                          issues:
                          - score: 0
                            isEditable: true
                            isSpecAttribute: false
                            attributeName: capacity
                            issueCount: 1
                            issues:
                            - title: MISSING
                              value: Missing
                          - score: 100
                            isEditable: 

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/walmart/refs/heads/main/openapi/walmart-insight-api-openapi.yml
Walmart Insight API

Documentation

Specifications

Other Resources

OpenAPI Specification
