Apinoa Docs

Search

키워드로 Walmart를 검색하며, 가격·평점·브랜드·카테고리 필터를 지원합니다.

원본 .mdx 보기
GET | POST /v1/walmart/search

파라미터는 GET의 쿼리 문자열로도, POST의 JSON 본문으로도 보낼 수 있습니다. 둘은 같습니다.

요청

curl "https://gateway.apinoa.com/v1/walmart/search?query=wool+socks&priceMax=30" \
  -H "x-api-key: $APINOA_API_KEY"

파라미터

파라미터타입필수설명
querystring예Keywords to search for. Required: image search is not available on Walmart, so a keyword query is the only way to search.
brandsstring listBrand names as the marketplace spells them, e.g. brands=Nike,Adidas.
categoryIdstringNarrow to one category, by the marketplace's own id. Opaque and per-marketplace; take it from Product.category[].id or from a result's facets.
facetsstring | object listNarrowings taken from a result's facets, e.g. facets=Color:Black. The escape hatch for filters the typed vocabulary has no word for; prefer a typed parameter where one exists.
pageinteger1-based results page. There is no pageSize — the results page is server-fixed at about 50 organic items — and no cursor, since paging here is by number.
priceMaxnumber ≥ 0Highest price to return, in decimal major units.
priceMinnumber ≥ 0Lowest price to return, in decimal major units.
ratingMinnumber 0–5Lowest average star rating to return, on the marketplace's own 0-5 scale.
regionstringBuyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.
sortenumResult ordering: best_match, price_asc, price_desc, newly_listed or best_seller. Defaults to best_match, Walmart's own relevance ordering. best_match price_asc price_desc newly_listed best_seller

같은 파라미터와 모든 응답 타입은 OpenAPI 문서에도 있습니다.

응답

data에 SearchResult를 돌려줍니다. 실제 응답을 줄인 것입니다. 배열은 앞쪽 항목만 남기고 긴 텍스트는 잘랐습니다.

{
  "success": true,
  "data": {
    "marketplace": "walmart",
    "query": "wool socks",
    "page": {
      "index": 1,
      "size": 47,
      "total": 4888
    },
    "items": [
      {
        "marketplace": "walmart",
        "id": "344144554",
        "title": "Genuine Dickies Men's Wool Thermal Crew Sock, 3 Pack, Shoe Size 6-12",
        "price": {
          "currency": "USD",
          "amount": 15.98
        },
        "brand": "Dickies",
        "url": "https://www.walmart.com/ip/Genuine-Dickies-Men-s-Wool-Thermal-Crew-Sock-3-Pack-Shoe-Size-6-12/344144554",
        "imageUrl": "https://i5.walmartimages.com/seo/Genuine-Dickies-Men-s-Wool-Thermal-Crew-Sock-3-Pack-Shoe-Size-6-12_7f83249a-fb07-4602-…",
        "seller": {
          "name": "Walmart.com",
          "id": "F55CDC31AB754BB68FE0B39041159D63"
        },
        "rating": {
          "average": 4.7,
          "count": 552
        },
        "status": "In stock",
        "inStock": true,
        "sponsored": true,
        "category": [
          {
            "id": "5438",
            "name": "Clothing"
          },
          {
            "id": "133197",
            "name": "Mens Clothing"
          }
        ],
        "badges": [],
        "promotions": [],
        "attributes": []
      }
    ],
    "facets": [
      {
        "id": "suggested",
        "name": "Suggested",
        "kind": "select",
        "values": [
          {
            "value": "Merino Wool",
            "name": "Merino Wool"
          },
          {
            "value": "Crew",
            "name": "Crew"
          }
        ]
      },
      {
        "id": "brand",
        "name": "Brand",
        "kind": "select",
        "values": [
          {
            "value": "Loritta",
            "name": "Loritta"
          },
          {
            "value": "Wrangler",
            "name": "Wrangler"
          }
        ],
        "maps_to": "brands"
      }
    ]
  }
}

에러

상태코드의미
400INVALID_PARAMS파라미터가 없거나, 알 수 없거나, 범위를 벗어났습니다. 메시지에 이름이 나옵니다.
401UNAUTHORIZEDx-api-key 헤더가 없거나, 폐기되었거나 알 수 없는 키입니다.
402INSUFFICIENT_BALANCE잔액이 이 호출 비용에 모자랍니다. 대시보드에서 충전하세요.
429MARKETPLACE_SATURATED동시 호출이 너무 많습니다. Retry-After 초만큼 기다린 뒤 다시 시도하세요.
502UPSTREAM_ERROR플랫폼이 쓸 수 없는 응답을 보냈습니다. 간격을 두고 다시 시도하세요.

모든 코드는 Errors에 있습니다. 실패한 호출은 과금되지 않습니다.

가격

가격 호출당 $0.001. 정가 기준이며, 하루 1,000회를 넘으면 단가가 내려갑니다.

참고

  • ratingMin은 구간에 맞춰집니다. Walmart는 평점 구간("4 – 5 Stars", "3 – 3.9 Stars")으로 필터링하므로, 요청은 조건을 만족하는 가장 낮은 구간을 고릅니다. 3.5는 4–5를 선택하고, 4.5는 만족하는 구간이 없으므로 평점 필터를 보내지 않습니다.
  • 페이지네이션은 page로 합니다. 페이지 크기가 약 50개로 고정되어 있어 pageSize와 cursor는 없습니다.
  • 지원하지 않음: condition, freeShipping, inStock.

이 페이지 내용