API Reference

Update a Product

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

📘

Tip

Only the "identifier" and the fields you wish to update are required. The most common use of the "update" API call is pricing updates (cost_basis, and shipping_price).

Body Params
string
required

The identifier of the product you wish to update.

int32

The Tophatter internal ID of the product you want to update. Only required if you aren't already using the identifier.

string

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

string

The name of the product.

string

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

string

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

string

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

string

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

int32

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

Target price (field name: cost_basis) should be the lowest price (excluding shipping) at which you are willing to sell a product.

int32

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

int32

The starting price of a product in auction.

float

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

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

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

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

int32

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

int32

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

boolean

Enable this feature if you have "Buy One Get One" promotion offer. The BOGO price will be equal to final bidding price + shipping price added.

string

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

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

Specify a gender to target (male/female)

Response

Updated less than a minute ago

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