SmartKart

SmartKart · GPT Actions

Walmart Search API

This API allows text search on the Walmart.com catalogue and returns matching items available for sale online.

  • GET /searchSearch for items in the Walmart catalogue

    Allows searching for items with various filters like category, sort order, pagination, and more.

原始 API 定义
{
  "openapi": "3.0.0",
  "info": {
    "title": "Walmart Search API",
    "description": "This API allows text search on the Walmart.com catalogue and returns matching items available for sale online.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://developer.api.walmart.com/api-proxy/service/affil/product/v2",
      "description": "Walmart Search API server"
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "operationId": "searchItems",
        "summary": "Search for items in the Walmart catalogue",
        "description": "Allows searching for items with various filters like category, sort order, pagination, and more.\n",
        "parameters": [
          {
            "name": "publisherId",
            "in": "query",
            "required": false,
            "description": "Your Impact Radius Publisher Id",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": true,
            "description": "Search text - whitespace separated sequence of keywords to search for",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "categoryId",
            "in": "query",
            "required": false,
            "description": "Category id for search within a category",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "start",
            "in": "query",
            "required": false,
            "description": "Starting point of the results within the matching set of items",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "sort",
            "in": "query",
            "required": false,
            "description": "Sorting criteria, allowed types are relevance, price, title, bestseller, customerRating, new",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "order",
            "in": "query",
            "required": false,
            "description": "Sort ordering criteria, applicable for price sort type",
            "schema": {
              "type": "string",
              "enum": [
                "ascending",
                "descending"
              ]
            }
          },
          {
            "name": "numItems",
            "in": "query",
            "required": false,
            "description": "Number of matching items to be returned, max 25",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "responseGroup",
            "in": "query",
            "required": false,
            "description": "Specifies the item fields returned in the response",
            "schema": {
              "type": "string",
              "enum": [
                "base",
                "full"
              ]
            }
          },
          {
            "name": "facet",
            "in": "query",
            "required": false,
            "description": "Boolean flag to enable facets",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "facet.filter",
            "in": "query",
            "required": false,
            "description": "Filter on the facet attribute values",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "facet.range",
            "in": "query",
            "required": false,
            "description": "Range filter for facets",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response with a list of items",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "items": {
                      "type": "array",
                      "items": {
                        "type": "object"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  }
}