Products returned by the Tophatter Merchant API have the following fields:
| Field | Description |
|---|---|
identifier | The unique identifier or SKU that your system uses to recognize this product. Only letters, numbers, spaces, dashes and underscores are allowed. |
internal_id | The unique identifier assigned to this product by Tophatter. |
category | The category of the product. The list of valid categories can be found here. |
title | The name of the product. |
description | The description of the product. Should not contain HTML. Newlines are okay. |
condition | The condition of the product. The list of valid conditions can be found here. |
brand | The brand of the product (if any). The list of valid brands can be found here. |
material | The material the product consists of. The list of recommended materials can be found here. |
available_quantity | The sum of quantity for each variation minus the number of items which have been won and are awaiting payment. |
variations | A list of the variations for this product. A variation consists of an indentifier, size, color, and quantity. Both size and color are optional. |
retail_price | The Manufacturer's Suggested Retail Price. |
cost_basis | The lowest price (excluding shipping and fees) at which you are willing to sell this product. |
buy_now_price | The price for this product when it appears in search results, catalogs, or your storefront. |
minimum_bid_amount | The starting price of a product in auction. |
scheduling_fee_bid | The maximum scheduling fee you are willing to pay for this item to be scheduled in auction. Charged every time an item is scheduled at auction. |
max_daily_schedules | The maximum number of times per day the product is scheduled. The number of schedules are also constrained by your inventory, budget, and bid |
shipping_price | The shipping price of the product when someone in the US purchases one. This price determines the shipping price to other countries when you set up your shipping rates. |
shipping_origin | The country the product ships from. |
fulfillment_partner | The 3PL or warehouse partner you're using to fulfill orders for this product. Example: noram. |
weight | The weight (in ounces) of the package when you ship this item. Used to help determine shipping costs in certain scenarios. |
days_to_fulfill | The number of days (after purchase) that it will take you to process & fulfill the order by shipping the item. |
days_to_deliver | The number of days you expect the shipment to be in transit to the buyer. Do not include the number of days it will take to fulfill the order. |
expedited_shipping_price | Optional - The shipping price of the product when someone in the US purchases it and chooses expedited shipping. Offering expedited shipping is optional. |
expedited_days_to_deliver | Optional - The number of days you expect the shipment to be in transit to the buyer when the buyer chooses expedited shipping. Offering expedited shipping is optional. |
buy_one_get_one_price | Optional - The price at which the customer can purchase an additional unit of this product. The "Buy One Get One" option is presented to customers during checkout. Offering this is optional. |
primary_image | URL of a photo of your product. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Images should be at least 500x480 pixels in size. |
extra_images | URLs of extra photos of your product. Link directly to the image, not the page where it is located. Same rules apply as primary_image. At least one extra image is required. You can specify multiple URLs separated by the character "|". Example: http://imgur.com/foo|http://imgur.com/bar |
all_images | All images in all available sizes (large, thumbnail, etc.) |
ratings_count | The number of customer ratings this product has received. |
ratings_average | The average rating for this product. |
created_at | The date and time the product was created in PDT (UTC -7). |
updated_at | The date and time the product was last updated in PDT (UTC -7). |
disabled_at | The date and time the product was disabled (if it is disabled) in PDT (UTC -7). If the product is not disabled this will be null. |
deleted_at | The date and time the product was deleted (if it is deleted) in PDT (UTC -7). If the product is not deleted this will be null. |
Examples
{
"identifier": "amazon-fire-7",
"internal_id": 11818243,
"category": "Electronics | Hardware (Computers/Tablets/Phones) | Computers/Tablets",
"title": "Fire 7 Tablet with Alexa, 7\" Display, 8 GB, 4 Colors Available!",
"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.",
"condition": "New with Tags",
"brand": "",
"material": "",
"available_quantity": 247,
"variations": [
{
"identifier": "B01GEW27DA",
"internal_id": 26054992,
"size": null,
"color": "Black",
"quantity": 69,
"created_at": "2018-04-03T11:33:10-07:00",
"disabled_at": null,
"deleted_at": null
},
{
"identifier": "B01J90O7KK",
"internal_id": 26054993,
"size": null,
"color": "Canary Yellow",
"quantity": 85,
"created_at": "2018-04-03T11:33:10-07:00",
"disabled_at": null,
"deleted_at": null
},
{
"identifier": "B01IO618J8",
"internal_id": 26054994,
"size": null,
"color": "Marine Blue",
"quantity": 66,
"created_at": "2018-04-03T11:33:10-07:00",
"disabled_at": null,
"deleted_at": null
},
{
"identifier": "B01J90OCNM",
"internal_id": 26054995,
"size": null,
"color": "Punch Red",
"quantity": 84,
"created_at": "2018-04-03T11:33:10-07:00",
"disabled_at": null,
"deleted_at": null
}
],
"retail_price": 50,
"cost_basis": 40,
"minimum_bid_amount": 1,
"max_daily_schedules": null,
"scheduling_fee_bid": 1.1,
"shipping_price": 0,
"shipping_origin": "United States",
"weight": null,
"days_to_fulfill": 5,
"days_to_deliver": 10,
"expedited_shipping_price": null,
"expedited_days_to_deliver": null,
"buy_one_get_one_price": null,
"primary_image": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/original.jpg?io=true&format=pjpg&auto=webp",
"extra_images": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/original.jpg?io=true&format=pjpg&auto=webp|https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/original.jpg?io=true&format=pjpg&auto=webp|https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/original.jpg?io=true&format=pjpg&auto=webp",
"all_images": [
{
"thumbnail": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/thumbnail.jpg?io=true&format=pjpg&auto=webp",
"square": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/square.jpg?io=true&format=pjpg&auto=webp",
"medium": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/medium.jpg?io=true&format=pjpg&auto=webp",
"large": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/large.jpg?io=true&format=pjpg&auto=webp",
"original": "https://images.tophatter.com/aa756f0f8c0f67b96746783a1cce017b/original.jpg?io=true&format=pjpg&auto=webp"
},
{
"thumbnail": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/thumbnail.jpg?io=true&format=pjpg&auto=webp",
"square": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/square.jpg?io=true&format=pjpg&auto=webp",
"medium": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/medium.jpg?io=true&format=pjpg&auto=webp",
"large": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/large.jpg?io=true&format=pjpg&auto=webp",
"original": "https://images.tophatter.com/019ece449b3b447ef6d60dc4001bf02c/original.jpg?io=true&format=pjpg&auto=webp"
},
{
"thumbnail": "https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/thumbnail.jpg?io=true&format=pjpg&auto=webp",
"square": "https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/square.jpg?io=true&format=pjpg&auto=webp",
"medium": "https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/medium.jpg?io=true&format=pjpg&auto=webp",
"large": "https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/large.jpg?io=true&format=pjpg&auto=webp",
"original": "https://images.tophatter.com/18dc20c3b8a51474054d736fb604ed73/original.jpg?io=true&format=pjpg&auto=webp"
},
{
"thumbnail": "https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/thumbnail.jpg?io=true&format=pjpg&auto=webp",
"square": "https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/square.jpg?io=true&format=pjpg&auto=webp",
"medium": "https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/medium.jpg?io=true&format=pjpg&auto=webp",
"large": "https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/large.jpg?io=true&format=pjpg&auto=webp",
"original": "https://images.tophatter.com/2a5f014398126aca0271481207d51bc4/original.jpg?io=true&format=pjpg&auto=webp"
}
],
"ratings_count": 0,
"ratings_average": null,
"created_at": "2018-04-03T11:33:10-07:00",
"updated_at": "2018-04-03T22:33:55-07:00",
"disabled_at": null,
"deleted_at": null
}