{"_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":12,"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=earbud'"}]},"method":"post","results":{"codes":[{"name":"","code":"[\n\t{\n    \"identifier\": \"RH00001\",\n    \"internal_id\": fake-internal-id (11111111),\n    \"category\": \"Electronics | Audio | Headphones\",\n    \"title\": \"Electronic Wireless Earbuds\",\n    \"description\": \"1. Listening to music/songs \\r\\n2. Reminder/Voice Prompts\\r\\n3. Power capacity will show on your cellular phone, you can see the power situation anytime\\r\\n4. Support up to One to two connections, can be connected to two mobile phones at the same time \\r\\n5. Bluetooth headset connected to the phone after the shutdown\\r\\n6. Intelligent compatibility: support all Bluetooth mobile phone, tablet, notebook, singing it, QQ music, movies, etc., universal all mobile phone \\r\\n\\r\\n\\r\\nSpecification: \\r\\n1. Driver: 15mm \\r\\n2. Impedance: 32 OHM \\r\\n3. Bluetooth version: Bluetooth v4.2 + EDR \\r\\n4. Bluetooth use band: 2.4GHz \\r\\n5. Power level: CLASS II \\r\\n6. Output power: 30mW \\r\\n7. Bluetooth distance: 10 meters barrier \\r\\n8. Frequency response: 20-20000Hz \\r\\n9. Operating voltage range: 3.0V-4.2V \\r\\n10. Mic sensitivity: -42dB \\r\\n11. With A2DP / AVRCP high quality stereo audio transmission and remote control protocol \\r\\n12. Powerful noise de-noising circuit (active noise reduction) \\r\\n13. switch between Chinese and English (boot does not connect Bluetooth state, press the switch 2 times, hear the tone switch successfully) \\r\\n13. Talk time is about 6 hours \\r\\n14. music time about 4-5 hours \\r\\n15. Standby time is about 120 hours \\r\\n\\r\\nPackage Includes: \\r\\n2xmini Bluetooth Headphones(left and right earphones) \\r\\n1x Charging box \\r\\n1xUSB Charging Cable \\r\\n1xUser Manual\",\n    \"condition\": \"New\",\n    \"brand\": \"\",\n    \"material\": \"abs\",\n    \"available_quantity\": 0,\n    \"variations\": [\n        {\n            \"identifier\": \"RH00001-Red\",\n            \"internal_id\": fake-internal-id (11111112),\n            \"size\": null,\n            \"color\": \"Red\",\n            \"quantity\": 5,\n            \"created_at\": \"2019-02-23T16:57:03-08:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"RH00001-Black\",\n            \"internal_id\": fake-internal-id (11111113),\n            \"size\": null,\n            \"color\": \"Black\",\n            \"quantity\": 5,\n            \"created_at\": \"2019-02-23T16:57:03-08:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"RH00001-White\",\n            \"internal_id\": fake-internal-id (11111114),\n            \"size\": null,\n            \"color\": \"White\",\n            \"quantity\": 5,\n            \"created_at\": \"2019-02-23T16:57:03-08:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"RH00001-Pink\",\n            \"internal_id\": fake-internal-id (11111115),\n            \"size\": null,\n            \"color\": \"Pink\",\n            \"quantity\": 5,\n            \"created_at\": \"2019-02-23T16:57:03-08:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"RH00001-Gold\",\n            \"internal_id\": fake-internal-id (11111116),\n            \"size\": null,\n            \"color\": \"Gold\",\n            \"quantity\": 5,\n            \"created_at\": \"2019-02-23T16:57:03-08:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        }\n    ],\n    \"retail_price\": fake-retail-price (999),\n    \"cost_basis\": fake-cost-basis (19),\n    \"minimum_bid_amount\": 5,\n    \"max_daily_schedules\": null,\n    \"scheduling_fee_bid\": 1.1,\n    \"reserve_price\": null,\n    \"shipping_price\": 5,\n    \"shipping_origin\": \"China\",\n    \"fulfillment_partner\": null,\n    \"weight\": null,\n    \"days_to_fulfill\": 5,\n    \"days_to_deliver\": 14,\n    \"expedited_shipping_price\": fake-expedited-shipping-price (12),\n    \"expedited_days_to_deliver\": 10,\n    \"buy_one_get_one_price\": 19, // soon-to-be-deprecated\n    \"buy_one_get_one_available\": true,\n    \"upsells\": [\n        {\n            \"type_description\": \"buy_one_get_one\",\n            \"amount\": \"fake-amount (19.0)\",\n            \"description\": null\n        },\n        {\n            \"type_description\": \"accessory\",\n            \"amount\": \"fake-amount (4.0)\",\n            \"description\": \"1*color box\",\n            \"identifier\": null,\n            \"image\": null\n        }\n    ],\n    \"primary_image\": \"https://images.tophatter.com/original1.jpg\",\n    \"extra_images\": \"https://images.tophatter.com/original2.jpg|https://images.tophatter.com/original3.jpg|https://images.tophatter.com/original4.jpg|https://images.tophatter.com/original5.jpg|https://images.tophatter.com/original6.jpg|https://images.tophatter.com/original7.jpg|https://images.tophatter.com/original8.jpg\",\n    \"all_images\": [...],\n    \"ratings_count\": 170,\n    \"ratings_average\": 4.1882,\n    \"created_at\": \"2019-02-23T16:57:03-08:00\",\n    \"updated_at\": \"2019-03-24T21:19:42-07:00\",\n    \"disabled_at\": null,\n    \"deleted_at\": null\n\t}\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