{"_id":"56a98f8fcc0f740d005bc176","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"},"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"},"editedParams":true,"user":"567f0baca74a1c0d003e1fba","__v":22,"githubsync":"","project":"567f0c06143cc60d00c1fdbe","editedParams2":true,"parentDoc":null,"updates":["5b121c08a977e80003dacd5c"],"next":{"pages":[],"description":""},"createdAt":"2016-01-28T03:48:31.693Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"# Using the identifier:\ncurl -X GET https://tophatter.com/merchant_api/v1/products/retrieve.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'identifier=6631A'\n\n# Using the internal_id:\ncurl -X GET https://tophatter.com/merchant_api/v1/products/retrieve.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'internal_id=19301513'"}]},"method":"get","results":{"codes":[{"code":"{\n  \"identifier\": \"6631A\",\n  \"internal_id\": 19301513,\n  \"category\": \"Electronics | Hardware (Computers/Tablets/Phones) | Mobile\",\n  \"title\": \"Apple iPhone 6S\",\n  \"description\": \"The Apple iPhone 6s features 3D Touch, a powerful A9 chip, and a gorgeous 4.7-inch Retina HD display. Available in Space Gray or Silver\",\n  \"condition\": \"New\",\n  \"brand\": null,\n  \"material\": null,\n  \"available_quantity\": 350,\n  \"variations\": [\n    {\n      \"identifier\": \"6631A-S\",\n      \"internal_id\": 43415169,\n      \"size\": null,\n      \"color\": \"Silver\",\n      \"quantity\": 100,\n      \"created_at\": \"2019-02-14T00:04:15-08:00\",\n      \"disabled_at\": null,\n      \"deleted_at\": null\n    },\n    {\n      \"identifier\": \"6631A-SG\",\n      \"internal_id\": 43415170,\n      \"size\": null,\n      \"color\": \"Space Gray\",\n      \"quantity\": 250,\n      \"created_at\": \"2019-02-14T00:04:15-08:00\",\n      \"disabled_at\": null,\n      \"deleted_at\": null\n    }\n  ],\n  \"retail_price\": null,\n  \"cost_basis\": 75,\n  \"minimum_bid_amount\": 1,\n  \"max_daily_schedules\": null,\n  \"scheduling_fee_bid\": 1.1,\n  \"reserve_price\": null,\n  \"shipping_price\": 0,\n  \"shipping_origin\": \"China\",\n  \"fulfillment_partner\": null,\n  \"weight\": null,\n  \"days_to_fulfill\": 3,\n  \"days_to_deliver\": 14,\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/0c9e6cfbdfcca16eed85f84551609e8f/original.jpg\",\n  \"extra_images\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/original.jpg|https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/original.jpg\",\n  \"all_images\": [\n    {\n      \"thumbnail\": \"https://images.tophatter.com/0c9e6cfbdfcca16eed85f84551609e8f/thumbnail.jpg\",\n      \"square\": \"https://images.tophatter.com/0c9e6cfbdfcca16eed85f84551609e8f/square.jpg\",\n      \"medium\": \"https://images.tophatter.com/0c9e6cfbdfcca16eed85f84551609e8f/medium.jpg\",\n      \"large\": \"https://images.tophatter.com/0c9e6cfbdfcca16eed85f84551609e8f/large.jpg\",\n      \"original\": \"https://images.tophatter.com/0c9e6cfbdfcca16eed85f84551609e8f/original.jpg\"\n    },\n    {\n      \"thumbnail\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/thumbnail.jpg\",\n      \"square\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/square.jpg\",\n      \"medium\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/medium.jpg\",\n      \"large\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/large.jpg\",\n      \"original\": \"https://images.tophatter.com/43e14d1f22720d5b9a0f463925441302/original.jpg\"\n    },\n    {\n      \"thumbnail\": \"https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/thumbnail.jpg\",\n      \"square\": \"https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/square.jpg\",\n      \"medium\": \"https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/medium.jpg\",\n      \"large\": \"https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/large.jpg\",\n      \"original\": \"https://images.tophatter.com/be8b0f664160ffe5c5e5a0bc56464771/original.jpg\"\n    }\n  ],\n  \"ratings_count\": 0,\n  \"ratings_average\": null,\n  \"created_at\": \"2019-02-14T00:04:15-08:00\",\n  \"updated_at\": \"2019-02-14T00:04:15-08:00\",\n  \"disabled_at\": null,\n  \"deleted_at\": null\n}","name":"","status":200,"language":"json"}]},"settings":"","auth":"required","params":[{"_id":"56a998361801ac0d00881b9c","ref":"","in":"query","required":true,"desc":"The identifier of the product you want to retrieve.","default":"","type":"string","name":"identifier"},{"_id":"5c65272bd3ee6b002a5856fb","ref":"","in":"query","required":false,"desc":"The Tophatter internal ID of the product you want to retrieve. Only required if you aren't already using the `identifier`.","default":"","type":"int","name":"internal_id"}],"url":"/products/retrieve.json"},"isReference":false,"order":3,"body":"","excerpt":"","slug":"product-retrieve","type":"endpoint","title":"Retrieve a Product"}

getRetrieve a Product


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

identifier:
required
string
The identifier of the product you want to retrieve.
internal_id:
integer
The Tophatter internal ID of the product you want to retrieve. Only required if you aren't already using the `identifier`.

Examples


Result Format