Target

Search Target products

Searches Target products and returns products plus every filter group and option available for the current result set. Pass option ids back through filter_ids as a comma-separated list. A zero total with an empty products list is a valid no-results response. The sort enum accepts relevance, featured, price-low, price-high, rating, bestselling, and newest.

get/target/search

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/target/search
  • Auth: API key in header x-api-key

Query parameters

qstring required

Product search query

pageinteger

One-based page (1-50)

sort'relevance' | 'featured' | 'price-low' | 'price-high' | 'rating' | 'bestselling' | 'newest'

Result order

store_idinteger

Target store id used for pricing

filter_idsstring

Comma-separated Target filter option ids

Headers

x-api-keystring required

API key required

Response

OK

codeinteger
msgstring

Example response

{
  "code": 200,
  "data": {
    "count": 24,
    "filter_groups": [
      {
        "display_name": "Deals",
        "id": "d_deals",
        "options": [
          {
            "display_name": "Clearance",
            "id": "5tdv1",
            "url": "d_deals:clearance",
            "value": "clearance"
          }
        ],
        "type": "checkbox"
      }
    ],
    "page": 1,
    "page_size": 24,
    "products": [
      {
        "brand": "Starbucks",
        "category_id": "x2hqv",
        "parent_category_id": "4yi5p",
        "parent_tcin": "89169599",
        "price": {
          "current": 12.79,
          "formatted": "$12.79",
          "regular": 12.79,
          "store_id": 2885,
          "unit_formatted": "$1.07/ounce"
        },
        "rating": {
          "average": 4.51,
          "rating_count": 1586,
          "review_count": 1076
        },
        "tcin": "12954151",
        "title": "Starbucks Pike Place Roast Medium Ground Coffee - 12oz"
      }
    ],
    "query": "coffee",
    "sort": "relevance",
    "store_id": 2885,
    "total": 20939,
    "total_pages": 50
  },
  "msg": "OK"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.