Apinoa Docs

Browse

키워드 없이 Walmart 카테고리 하나의 상품을 나열합니다.

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

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

요청

curl "https://gateway.apinoa.com/v1/walmart/browse?categoryId=3944_133251_1095191_1230614_1230478&ratingMin=4" \
  -H "x-api-key: $APINOA_API_KEY"

파라미터

파라미터타입필수설명
categoryIdstring예REQUIRED. The underscore-joined chain from a Walmart category URL, e.g. 3944_133251_1095191_1230614_1230478. A bare department or leaf id is refused with CATEGORY_NOT_BROWSABLE — use categories to walk down to a chain.
brandsstring listBrand names as the marketplace spells them, e.g. brands=Nike,Adidas.
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",
    "page": {
      "index": 1,
      "size": 39,
      "total": 2269
    },
    "items": [
      {
        "marketplace": "walmart",
        "id": "11381374703",
        "title": "Apple AirPods 4",
        "price": {
          "currency": "USD",
          "amount": 99
        },
        "listPrice": {
          "currency": "USD",
          "amount": 129.99
        },
        "url": "https://www.walmart.com/ip/Apple-AirPods-4/11381374703",
        "imageUrl": "https://i5.walmartimages.com/seo/Apple-AirPods-4_43ffea38-e233-4fee-8a6f-7ff92ad713ae.97d6d24546e5cbdfcdc0e2fa52c969b1.…",
        "seller": {
          "name": "Walmart.com",
          "id": "F55CDC31AB754BB68FE0B39041159D63"
        },
        "rating": {
          "average": 4.3,
          "count": 88450
        },
        "status": "In stock",
        "inStock": true,
        "delivery": {
          "carrier": "Shipping",
          "code": "SHIPPING",
          "estimate": "Free shipping, arrives today",
          "free": true
        },
        "shippingOptions": [
          {
            "carrier": "Delivery",
            "code": "DELIVERY",
            "estimate": "Delivery as soon as 13 mins"
          },
          {
            "carrier": "Shipping",
            "code": "SHIPPING",
            "estimate": "Free shipping, arrives today",
            "free": true
          }
        ],
        "deliveryTo": {
          "label": "Sacramento, CA 95829",
          "country": "US",
          "postalCode": "95829"
        },
        "offersSummary": {
          "count": 10
        },
        "category": [
          {
            "id": "3944",
            "name": "Electronics"
          },
          {
            "id": "133251",
            "name": "Audio"
          }
        ],
        "badges": [
          "Rollback"
        ],
        "promotions": [
          "Save with Walmart+"
        ],
        "attributes": [],
        "ext": {
          "optionsFromPrice": {
            "currency": "USD",
            "amount": 68
          }
        }
      }
    ],
    "facets": [
      {
        "id": "price",
        "name": "Price",
        "kind": "range",
        "values": [],
        "min": 0,
        "max": 160,
        "maps_to": "priceMin"
      },
      {
        "id": "brand",
        "name": "Brand",
        "kind": "select",
        "values": [
          {
            "value": "JLab",
            "name": "JLab"
          },
          {
            "value": "JBL",
            "name": "JBL"
          }
        ],
        "maps_to": "brands"
      }
    ]
  }
}

에러

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

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

가격

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

참고

  • categoryId는 Walmart 카테고리 URL의 밑줄로 이어진 체인입니다: walmart.com/browse/<dept>/<slug>/3944_133251_1095191_1230614_1230478이면 3944_133251_1095191_1230614_1230478입니다. 리프 id만으로는 해석되지 않으며, Categories가 체인을 돌려줍니다.
  • 키워드를 뺀 search와 같은 필터를 받습니다. query는 400입니다.
  • 응답에는 query 키가 없고, 그 외에는 검색 응답과 완전히 같습니다.

이 페이지 내용