API Reference

Create a Product

post
https://tophatter.com/merchant_api/v1/products.json

🚧

Common Issue - Variation Consistency

Each product must have one or more variations. Additionally, all variations should be consistent with respect to sizes and colors. In particular, all variations for a given product must have just a size, just a color, or both a size and color.

📘

Error Handling

If a 200 response is returned then the product has been successfully created. You can read more about error handling here.

Body Params
string
required

The unique identifier or SKU that your system uses to recognize this product. Only letters, numbers, spaces, dashes and underscores are allowed. The identifier cannot be changed after the product has been created.

string
required

The category of the product. The list of valid categories can be found here.

string
required

The name of the product.

string
required

The description of the product. Should not contain HTML. Newlines are okay.

string
Defaults to New

The condition of the product. The list of valid conditions can be found here.

string

Optional - The brand of the product (if any). The list of valid brands can be found here.

string

Optional - The material the product consists of. The list of recommended materials can be found here.

int32
required

The lowest price (excluding shipping) at which you are willing to sell this product.

int32
required

The price for this product when it appears in search results, catalogs, or your storefront.

int32

Optional - The Manufacturer's Suggested Retail Price. This field is recommended as it will show as a strikethrough price and appears next to the selling price for the product.

int32
Defaults to 1

The starting price of a product in auction.

float
Defaults to 0

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.

int32

The maximum number of times per day the product is scheduled. The number of schedules are also constrained by your inventory, budget, and bid.

int32
Defaults to 0

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.

string
Defaults to United States

The country the product ships from.

string

The 3PL or warehouse partner you're using to fulfill orders for this product. Example: noram.

int32

The weight (in ounces) of the package when you ship this item. Used to help determine shipping costs in certain scenarios.

int32
Defaults to 3

The number of days (after purchase) that it will take you to process & fulfill the order by shipping the item.

int32

Optional - The shipping price of the product when someone in the US purchases one and chooses expedited shipping.

int32

Optional - The number of days you expect the shipment to be in transit to the buyer when the buyer chooses expedited shipping.

boolean

Optional - Offer "Buy One Get One" for same price.

string
required

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.

string
required

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

string

Assign a product to specific campaign. Based on name of the campaign.

int32

Optional - If the highest bid is below this amount, sale will not go through. There is a fixed cost with setting a product with Reserve Price.

string

Optional - (male/female) Specify a gender to target

Response

Updated less than a minute ago

Language
Credentials
Basic
base64
:
Request
Response 
 Choose an example:
application/json
Updated less than a minute ago