{"_id":"58351296b85f2f0f0046391a","githubsync":"","parentDoc":null,"version":{"_id":"567f0c06143cc60d00c1fdc1","__v":9,"project":"567f0c06143cc60d00c1fdbe","createdAt":"2015-12-26T21:52:06.734Z","releaseDate":"2015-12-26T21:52:06.734Z","categories":["567f0c07143cc60d00c1fdc2","56a9783109cb9c0d00f0c7d3","56a97837f834950d0037b363","56a9783b2d8fd90d0036eed6","56a979912d8fd90d0036eed8","5834b5691a80690f00d31faf","5834b5e4f775120f00c45f9d","5bf1a1473031e4005075ae14","5c64c200244bda003204b97f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":11,"category":{"_id":"56a9783109cb9c0d00f0c7d3","__v":9,"pages":["56a98f8fcc0f740d005bc176","56a98fa21801ac0d00881b88","56a98fad257fbc0d00d47630","56a98fb8318e6c1700a19d02","56a99061257fbc0d00d47637","56a990712d8fd90d0036eeeb","56a992361801ac0d00881b91","56a99bfe1801ac0d00881ba1","56a9a64d09cb9c0d00f0c7f0"],"project":"567f0c06143cc60d00c1fdbe","version":"567f0c06143cc60d00c1fdc1","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-28T02:08:49.783Z","from_sync":false,"order":1,"slug":"products","title":"Products"},"project":"567f0c06143cc60d00c1fdbe","user":"567f0baca74a1c0d003e1fba","updates":["5b6c599cb81a170003fb2293"],"next":{"pages":[],"description":""},"createdAt":"2016-11-23T03:52:54.451Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X POST https://tophatter.com/merchant_api/v1/products/search.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'query=iPad'"}]},"method":"post","results":{"codes":[{"name":"","code":"[\n  {\n    \"identifier\": \"MP2G2LL-A\",\n    \"internal_id\": 11165780,\n    \"category\": \"Electronics | Hardware (Computers/Tablets/Phones) | Computers/Tablets\",\n    \"title\": \"Apple iPad (5th Generation) ‑ Wi‑Fi ‑ 32 GB ‑ Silver ‑ 9.7\\\"\",\n    \"description\": \"Powerful, portable, and personal with a gorgeous 9.7-inch Retina display in a thin, durable aluminum design that weighs just a pound. iPad puts incredible capabilities in your hands with a powerful A9 chip, 8MP camera, FaceTime HD camera, Touch ID, Apple Pay, Wi-Fi, all-day battery life, and over a million apps on the App Store.\",\n    \"condition\": \"New with Tags\",\n    \"brand\": \"\",\n    \"material\": \"\",\n    \"available_quantity\": 97,\n    \"variations\": [\n      {\n        \"identifier\": \"MP2G2LL-A\",\n        \"internal_id\": 25235663,\n        \"size\": null,\n        \"color\": null,\n        \"quantity\": 99,\n        \"created_at\": \"2018-03-26T16:46:25-07:00\",\n        \"disabled_at\": null,\n        \"deleted_at\": null\n      }\n    ],\n    \"retail_price\": 329,\n    \"cost_basis\": 1000,\n    \"minimum_bid_amount\": 1,\n    \"max_daily_schedules\": null,\n    \"shipping_price\": 0,\n    \"shipping_origin\": \"United States\",\n    \"weight\": null,\n    \"days_to_fulfill\": 5,\n    \"days_to_deliver\": 10,\n    \"expedited_shipping_price\": null,\n    \"expedited_days_to_deliver\": null,\n    \"buy_one_get_one_price\": null,\n    \"primary_image\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/original.jpg?io=true&format=pjpg&auto=webp\",\n    \"extra_images\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/original.jpg?io=true&format=pjpg&auto=webp|https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/original.jpg?io=true&format=pjpg&auto=webp\",\n    \"all_images\": [\n      {\n        \"thumbnail\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/thumbnail.jpg?io=true&format=pjpg&auto=webp\",\n        \"square\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/square.jpg?io=true&format=pjpg&auto=webp\",\n        \"medium\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/medium.jpg?io=true&format=pjpg&auto=webp\",\n        \"large\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/large.jpg?io=true&format=pjpg&auto=webp\",\n        \"original\": \"https://images.tophatter.com/653b5629ec784d831741d8a74b2beb44/original.jpg?io=true&format=pjpg&auto=webp\"\n      },\n      {\n        \"thumbnail\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/thumbnail.jpg?io=true&format=pjpg&auto=webp\",\n        \"square\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/square.jpg?io=true&format=pjpg&auto=webp\",\n        \"medium\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/medium.jpg?io=true&format=pjpg&auto=webp\",\n        \"large\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/large.jpg?io=true&format=pjpg&auto=webp\",\n        \"original\": \"https://images.tophatter.com/a1d0ed19b4bef8ddc07c79fca9339407/original.jpg?io=true&format=pjpg&auto=webp\"\n      },\n      {\n        \"thumbnail\": \"https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/thumbnail.jpg?io=true&format=pjpg&auto=webp\",\n        \"square\": \"https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/square.jpg?io=true&format=pjpg&auto=webp\",\n        \"medium\": \"https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/medium.jpg?io=true&format=pjpg&auto=webp\",\n        \"large\": \"https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/large.jpg?io=true&format=pjpg&auto=webp\",\n        \"original\": \"https://images.tophatter.com/d36d5df195898ab14e3cdcea23ca5353/original.jpg?io=true&format=pjpg&auto=webp\"\n      }\n    ],\n    \"ratings_count\": 1,\n    \"ratings_average\": 5,\n    \"created_at\": \"2018-03-26T16:46:25-07:00\",\n    \"updated_at\": \"2018-04-03T19:08:21-07:00\",\n    \"disabled_at\": \"2018-04-03T11:22:53-07:00\",\n    \"deleted_at\": null\n  }\n]","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"5835146461b4300f0032e6c1","ref":"","in":"body","required":true,"desc":"A search query string.","default":"","type":"string","name":"query"},{"_id":"5835146461b4300f0032e6bf","ref":"","in":"body","required":false,"desc":"Optional - When paginating, the page of products to return. Example: Assuming a per_page value of 50, page 1 would return products 1 to 50 and page 2 would return products 51 to 100.","default":"1","type":"int","name":"page"},{"_id":"5835146461b4300f0032e6be","ref":"","in":"body","required":false,"desc":"Optional - The number of products to return per page. 1000 is the maximum value.","default":"50","type":"int","name":"per_page"},{"_id":"5835146461b4300f0032e6bd","ref":"","in":"body","required":false,"desc":"Optional - Return a pagination summary along with the list of products.","default":"false","type":"boolean","name":"pagination"}],"url":"/products/search.json"},"isReference":false,"order":2,"body":"","excerpt":"","slug":"product-search","type":"endpoint","title":"Search Products"}

postSearch Products


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

query:
required
string
A search query string.
page:
integer1
Optional - When paginating, the page of products to return. Example: Assuming a per_page value of 50, page 1 would return products 1 to 50 and page 2 would return products 51 to 100.
per_page:
integer50
Optional - The number of products to return per page. 1000 is the maximum value.
pagination:
booleanfalse
Optional - Return a pagination summary along with the list of products.

Examples


Result Format