Walmart Utilities API

openapi: 3.0.1
info:
  title: Walmart Cost Management Assortment Recommendations Utilities 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: Utilities
paths:
  /v3/utilities/taxonomy:
    get:
      tags:
      - Utilities
      summary: Walmart Taxonomy by Spec
      description: 'The Taxonomy by Item spec API exposes the category taxonomy that Walmart.com uses to categorize items for each Item spec version. It returns a list of all Categories and Sub-categories that are available on Walmart.com for the Item spec version you specify.

        You can specify the feedType and version for these available Item specs. Make sure to specify the corresponding version that is available for that feed type:

        *   Item spec 3.2 feed type: item

        *   Item spec 4.0 feed types: MP_ITEM, MP_WFS_ITEM, or MP_MAINTENANCE

        *   Item spec 4.1 feed types: MP_WFS_ITEM, or MP_MAINTENANCE

        *   Item spec 4.2 feed type: MP_ITEM or MP_WFS_ITEM

        *   Item spec 4.3 feed type: MP_ITEM or MP_MAINTENANCE'
      operationId: getTaxonomyResponse
      parameters:
      - name: feedType
        in: query
        description: Specifies the Feed Type
        required: false
        schema:
          type: string
          enum:
          - item
          - MP_ITEM
          - MP_WFS_ITEM
          - MP_MAINTENANCE
      - name: version
        in: query
        description: Specifies the version for the Feed Type
        required: false
        schema:
          type: string
          enum:
          - '3.2'
          - '4.0'
          - '4.1'
          - '4.2'
      - 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
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        category:
                          type: string
                          description: Type of item
                        subcategory:
                          type: array
                          description: Specific kind of category
                          items:
                            type: object
                            properties:
                              subCategoryName:
                                type: string
                                description: Name of specific kind of category
                              subCategoryId:
                                type: string
                                description: ID of specific kind of category
                            description: Specific kind of category
              example:
                status: SUCCESS
                payload:
                - category: Animal
                  subcategory:
                  - subCategoryName: Animal Accessories
                    subCategoryId: 559c5d924fff3d64de18bf45
                  - subCategoryName: Animal Food
                    subCategoryId: 559c5d8f4fff3d64de18bf3d
                  - subCategoryName: Animal Health & Grooming
                    subCategoryId: 559c5d90ed25b136f13a05df
                  - subCategoryName: Animal Other
                    subCategoryId: 56f2eb66208f9a06158f1748
                - category: Art & Craft
                  subcategory:
                  - subCategoryName: Art & Craft
                    subCategoryId: 571fdff7208f9a0cdb760a7f
  /v3/utilities/taxonomy/departments:
    get:
      tags:
      - Utilities
      summary: Walmart All Departments
      description: Get list of departments
      operationId: getDepartmentList
      parameters:
      - 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
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  payload:
                    type: array
                    items:
                      type: object
                      properties:
                        superDepartment:
                          type: string
                          description: The super-department name for which the department have to be fetched
                        superDepartmentId:
                          type: string
                          description: The super-department id for which the department have to be fetched
                        departments:
                          type: array
                          items:
                            type: object
                            properties:
                              departmentName:
                                type: string
                                description: The department name for which the categories have to be fetched
                              departmentId:
                                type: string
                                description: The department id for which the categories have to be fetched
              example:
                status: SUCCESS
                payload:
                - superDepartment: 13 HOUSEHOLD CHEMICALS
                  superDepartmentId: '44000'
                  departments:
                  - departmentName: LAUNDRY AND HOUSEHOLD CHEMICALS
                    departmentId: '44003'
                  - departmentName: HOUSEHOLD CHEMICALS MISC L2
                    departmentId: '44004'
                - superDepartment: 94 PRODUCE
                  superDepartmentId: '80100'
                  departments:
                  - departmentName: PRODUCE L2
                    departmentId: '1080100'
                - superDepartment: 01 CANDY AND TOBACCO
                  superDepartmentId: '86000'
                  departments:
                  - departmentName: CANDY AND TOBACCO L2
                    departmentId: '1086000'
                - superDepartment: 34 LADIES APPAREL
                  superDepartmentId: '56000'
                  departments:
                  - departmentName: WOMENS SEASONAL
                    departmentId: '56007'
                  - departmentName: WOMENS
                    departmentId: '56004'
                  - departmentName: JUNIORS
                    departmentId: '56002'
                  - departmentName: WOMENS PLUS
                    departmentId: '56006'
                  - departmentName: OUTDOOR WOMENS HIKE AND ALPINE APPAREL
                    departmentId: '1056114'
                  - departmentName: WOMENS ACTIVEWEAR
                    departmentId: '56146'
                  - departmentName: MATERNITY
                    departmentId: '56003'
                  - departmentName: LADIES APPAREL MISC L2
                    departmentId: '1056125'
                - superDepartment: 08 PETS AND SUPPLIES
                  superDepartmentId: '47000'
                  departments:
                  - departmentName: PETS L2
                    departmentId: '1047022'
                  - departmentName: CAT
                    departmentId: '47012'
                  - departmentName: BIRD AQUATICS SMALL ANIMAL
                    departmentId: '47014'
                  - departmentName: DOG
                    departmentId: '47010'
  /v3/utilities/taxonomy/departments/{departmentId}:
    get:
      tags:
      - Utilities
      summary: Walmart All Categories
      description: Get list of categories for a specific department
      operationId: getCategories
      parameters:
      - name: departmentId
        in: path
        description: departmentId
        required: true
        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
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                  response:
                    type: object
                    properties:
                      departmentName:
                        type: string
                        description: The department name for which the categories have to be fetched
                      departmentId:
                        type: string
                        description: The department id for which the categories have to be fetched
                      category:
                        type: array
                        items:
                          type: object
                          properties:
                            categoryName:
                              type: string
                              description: The category name for which the top trending items have to be fetched
                            categoryId:
                              type: string
                              description: The category id for which the top trending items have to be fetched
              example:
                status: SUCCESS
                response:
                  departmentName: LAUNDRY AND HOUSEHOLD CHEMICALS
                  departmentId: '44003'
                  category:
                  - categoryName: CLEANING PRODUCTS
                    categoryId: '44106'
                  - categoryName: LAUNDRY CARE
                    categoryId: '44108'
                  - categoryName: HOUSEHOLD CHEMICALS L3
                    categoryId: '1044076'
                  - categoryName: HOME FRAGRANCE
                    categoryId: '44107'
                  - categoryName: CLEANING TOOLS
                    categoryId: '1044080'
  /v3/utilities/apiStatus:
    get:
      tags:
      - Utilities
      summary: Walmart Api Platform Status
      description: Get all marketplace Apis status
      operationId: getApiPlatformStatus
      parameters:
      - 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
      responses:
        '200':
          description: Successful Operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  apiStatuses:
                    type: array
                    description: A-List of all API statuses
                    items:
                      type: object
                      properties:
                        apiGroup:
                          type: string
                          description: The marketplace api group
                          enum:
                          - Returns
                          - Items
                          - Sandbox
                          - Lagtime
                          - Promos
                          - Orders
                          - Authentication
                          - Price
                          - Refunds
                          - Authorization
                          - Inventory
                        status:
                          type: string
                          description: The current status of marketplace api group
                          enum:
                          - OPERATIONAL
                          - SERVICE_DEGRADATION
                          - SERVICE_OUTAGE
                          - UNKNOWN
                        lastUpdatedTime:
                          type: string
                          description: The time at which the status of api group collected. This datetime field is in the ISO 8601 format.
                      description: A-List of all API statuses
              example:
                apiStatuses:
                - apiGroup: Returns
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Items
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Sandbox
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Lagtime
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Promos
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Orders
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Authentication
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Price
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Refunds
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Authorization
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
                - apiGroup: Inventory
                  status: OPERATIONAL
                  lastUpdatedTime: '2022-01-12T07:30:48.611Z'
x-tagGroups:
- name: 1P Suppliers DSV Cost Reference
  tags:
  - DSV Cost