{"_id":"56a990712d8fd90d0036eeeb","githubsync":"","parentDoc":null,"editedParams":true,"project":"567f0c06143cc60d00c1fdbe","user":"567f0baca74a1c0d003e1fba","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"},"editedParams2":true,"__v":37,"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"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-28T03:52:17.007Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -X GET https://tophatter.com/merchant_api/v1/products.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'status=in_stock'"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"identifier\": \"amazon-fire-7\",\n    \"internal_id\": 11818243,\n    \"category\": \"Electronics | Hardware (Computers/Tablets/Phones) | Computers/Tablets\",\n    \"title\": \"Fire 7 Tablet with Alexa, 7\\\" Display, 8 GB, 4 Colors Available!\",\n    \"description\": \"The next generation of our best-selling Fire tablet ever - now thinner, lighter, and with longer battery life and an improved display. More durable than the latest iPad\\r\\nBeautiful 7\\\" IPS display with higher contrast and sharper text, a 1.3 GHz quad-core processor, and up to 8 hours of battery life. 8 or 16 GB of internal storage and a microSD slot for up to 256 GB of expandable storage.\\r\\n\\r\\nNow with Alexa, for quick access to the information and entertainment you want. Ask questions, play music, check your calendar, get the news, weather, and more - just press the home button and ask.\\r\\n\\r\\nAsk Alexa to call or message almost anyone, or make video calls to family and friends with a Fire tablet, Echo Spot, Echo Show, or the Alexa App. Instantly connect to enabled Echo devices.\\r\\n\\r\\nEnjoy millions of movies, TV shows, songs, Kindle eBooks, apps and games - including Netflix, Facebook, HBO, Spotify, and more.\\r\\n\\r\\nPrime members get unlimited access to over a thousand books and magazines, millions of songs, and thousands of movies and TV episodes - at no additional cost.\\r\\n\\r\\nWatch downloaded videos anywhere with a Prime membership, Netflix plan, or Showtime subscription.\",\n    \"condition\": \"New with Tags\",\n    \"brand\": \"Amazon\",\n    \"material\": \"\",\n    \"available_quantity\": 10,\n    \"variations\": [\n        {\n            \"identifier\": \"B01GEW27DA\",\n            \"internal_id\": 26054992,\n            \"size\": null,\n            \"color\": \"Black\",\n            \"quantity\": 4,\n            \"created_at\": \"2018-04-03T11:33:10-07:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"B01J90O7KK\",\n            \"internal_id\": 26054993,\n            \"size\": null,\n            \"color\": \"Canary Yellow\",\n            \"quantity\": 2,\n            \"created_at\": \"2018-04-03T11:33:10-07:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"B01IO618J8\",\n            \"internal_id\": 26054994,\n            \"size\": null,\n            \"color\": \"Marine Blue\",\n            \"quantity\": 2,\n            \"created_at\": \"2018-04-03T11:33:10-07:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        },\n        {\n            \"identifier\": \"B01J90OCNM\",\n            \"internal_id\": 26054995,\n            \"size\": null,\n            \"color\": \"Punch Red\",\n            \"quantity\": 2,\n            \"created_at\": \"2018-04-03T11:33:10-07:00\",\n            \"disabled_at\": null,\n            \"deleted_at\": null\n        }\n    ],\n    \"retail_price\": 60,\n    \"cost_basis\": 50,\n    \"minimum_bid_amount\": 1,\n    \"max_daily_schedules\": null,\n    \"scheduling_fee_bid\": 0,\n    \"reserve_price\": null,\n    \"shipping_price\": 5,\n    \"shipping_origin\": \"United States\",\n    \"fulfillment_partner\": null,\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    \"upsells\": [],\n    \"primary_image\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/original.jpg\",\n    \"extra_images\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/original.jpg|https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/original.jpg|https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/original.jpg\",\n    \"all_images\": [\n        {\n            \"thumbnail\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/thumbnail.jpg\",\n            \"square\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/square.jpg\",\n            \"medium\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/medium.jpg\",\n            \"large\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/large.jpg\",\n            \"original\": \"https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/original.jpg\"\n        },\n        {\n            \"thumbnail\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/thumbnail.jpg\",\n            \"square\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/square.jpg\",\n            \"medium\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/medium.jpg\",\n            \"large\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/large.jpg\",\n            \"original\": \"https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/original.jpg\"\n        },\n        {\n            \"thumbnail\": \"https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/thumbnail.jpg\",\n            \"square\": \"https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/square.jpg\",\n            \"medium\": \"https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/medium.jpg\",\n            \"large\": \"https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/large.jpg\",\n            \"original\": \"https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/original.jpg\"\n        },\n        {\n            \"thumbnail\": \"https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/thumbnail.jpg\",\n            \"square\": \"https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/square.jpg\",\n            \"medium\": \"https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/medium.jpg\",\n            \"large\": \"https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/large.jpg\",\n            \"original\": \"https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/original.jpg\"\n        }\n    ],\n    \"ratings_count\": 77,\n    \"ratings_average\": 4.3247,\n    \"created_at\": \"2018-04-03T11:33:10-07:00\",\n    \"updated_at\": \"2019-03-11T21:22:52-07:00\",\n    \"disabled_at\": \"2018-05-23T14:55:24-07:00\",\n    \"deleted_at\": null\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"58351195b4e4250f00c9dde6","ref":"","in":"query","required":false,"desc":"Optional - Filter the results by product status. See the \"Filtering By Status\" section below for the list of sort options.","default":"","type":"string","name":"status"},{"_id":"576c6a18151ca30e00c851cb","ref":"","in":"query","required":false,"desc":"Optional - Filter the results by product category. If not set, products under all categories are returned. Only the first two levels of categorization are accepted. For example, instead of \"Electronics | Audio | Headphones\" you can only specify \"Electronics | Audio\" for this filter.","default":"","type":"string","name":"category"},{"_id":"56a994351801ac0d00881b95","ref":"","in":"query","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":"56a994351801ac0d00881b94","ref":"","in":"query","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":"576c6860ba92910e0099ad67","ref":"","in":"query","required":false,"desc":"Optional - Sort the products using the provided option. See the \"Sorting\" section below for the list of sort options.","default":"created_at_descending","type":"string","name":"sort"},{"_id":"58351195b4e4250f00c9dde5","ref":"","in":"query","required":false,"desc":"Optional - Return a pagination summary along with the list of products.","default":"false","type":"boolean","name":"pagination"}],"url":"/products.json"},"isReference":false,"order":1,"body":"[block:api-header]\n{\n  \"title\": \"Filtering By Status\"\n}\n[/block]\nYou can filter your products by the following `status` values:\n- `in_stock`\n- `enabled`\n- `disabled`\n- `deleted`\n- `sold_out`\n- `problematic`\n- `low_inventory`\n- `banned`\n[block:api-header]\n{\n  \"title\": \"Sorting\"\n}\n[/block]\nYou can sort your products using the following `sort` options:\n- `created_at_ascending`\n- `created_at_descending`\n- `updated_at_ascending`\n- `updated_at_descending`\n- `unique_id_ascending`\n- `unique_id_descending`\n- `ratings_ascending`\n- `ratings_descending`\n- `target_price_ascending`\n- `target_price_descending`\n- `sfb_ascending`\n- `sfb_descending`\n- `sales_ascending`\n- `sales_descending`\n- `reserve_price_descending`\n- `reserve_price_ascending`\n[block:api-header]\n{\n  \"title\": \"Pagination\"\n}\n[/block]\nThe `pagination` flag is useful if you need to get a count of the total number of products available to fetch. When the `pagination` flag is used the list of products will appear under a key called `results`, and the pagination information will be returned as demonstrated in the following example.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET https://tophatter.com/merchant_api/v1/products.json \\\\\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\\\\n-d 'page=1' \\\\\\n-d 'per_page=100' \\\\\\n-d 'pagination=1'\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"results\\\": [...],\\n  \\\"from\\\": 1,\\n  \\\"to\\\": 50,\\n  \\\"page\\\": 1,\\n  \\\"per_page\\\": 50,\\n  \\\"total_entries\\\": 150\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIn the case above, there are 150 products total, and `results` contain products 1 through 50.","excerpt":"","slug":"product-list","type":"endpoint","title":"List Products"}

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

status:
string
Optional - Filter the results by product status. See the "Filtering By Status" section below for the list of sort options.
category:
string
Optional - Filter the results by product category. If not set, products under all categories are returned. Only the first two levels of categorization are accepted. For example, instead of "Electronics | Audio | Headphones" you can only specify "Electronics | Audio" for this filter.
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.
sort:
stringcreated_at_descending
Optional - Sort the products using the provided option. See the "Sorting" section below for the list of sort options.
pagination:
booleanfalse
Optional - Return a pagination summary along with the list of products.

Examples


Result Format


Documentation

[block:api-header] { "title": "Filtering By Status" } [/block] You can filter your products by the following `status` values: - `in_stock` - `enabled` - `disabled` - `deleted` - `sold_out` - `problematic` - `low_inventory` - `banned` [block:api-header] { "title": "Sorting" } [/block] You can sort your products using the following `sort` options: - `created_at_ascending` - `created_at_descending` - `updated_at_ascending` - `updated_at_descending` - `unique_id_ascending` - `unique_id_descending` - `ratings_ascending` - `ratings_descending` - `target_price_ascending` - `target_price_descending` - `sfb_ascending` - `sfb_descending` - `sales_ascending` - `sales_descending` - `reserve_price_descending` - `reserve_price_ascending` [block:api-header] { "title": "Pagination" } [/block] The `pagination` flag is useful if you need to get a count of the total number of products available to fetch. When the `pagination` flag is used the list of products will appear under a key called `results`, and the pagination information will be returned as demonstrated in the following example. [block:code] { "codes": [ { "code": "curl -X GET https://tophatter.com/merchant_api/v1/products.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'page=1' \\\n-d 'per_page=100' \\\n-d 'pagination=1'", "language": "curl" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"results\": [...],\n \"from\": 1,\n \"to\": 50,\n \"page\": 1,\n \"per_page\": 50,\n \"total_entries\": 150\n}", "language": "json" } ] } [/block] In the case above, there are 150 products total, and `results` contain products 1 through 50.