{"_id":"56a9a64d09cb9c0d00f0c7f0","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,"editedParams2":true,"githubsync":"","project":"567f0c06143cc60d00c1fdbe","user":"567f0baca74a1c0d003e1fba","parentDoc":null,"__v":48,"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"},"updates":["5bab5c62dddbf3000332255f"],"next":{"pages":[],"description":""},"createdAt":"2016-01-28T05:25:33.776Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"identifier\": \"6631A\",\n  \"internal_id\": 19301513,\n  ...\n  \"scheduling_fee_bid\": 1.35,\n  ...\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"# Using the identifier:\ncurl -X POST https://tophatter.com/merchant_api/v1/products/update.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'identifier=6631A' \\\n-d 'scheduling_fee_bid=1.35'\n\n# Using the internal_id:\ncurl -X POST https://tophatter.com/merchant_api/v1/products/update.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'internal_id=19301513' \\\n-d 'scheduling_fee_bid=1.35'\n\n# Updating multiple variation quantities in a single call:\ncurl -X POST https://tophatter.com/merchant_api/v1/products/update.json \\\n-d 'access_token=YOUR_ACCESS_TOKEN' \\\n-d 'internal_id=19301513' \\\n-d 'variations[6631A-S][identifier]=6631A-S' \\\n-d 'variations[6631A-S][quantity]=500' \\\n-d 'variations[6631A-SG][identifier]=6631A-SG' \\\n-d 'variations[6631A-SG][quantity]=500'","language":"curl"}]},"method":"post","auth":"required","params":[{"_id":"56a9a6a509cb9c0d00f0c7f1","ref":"","in":"body","required":true,"desc":"The identifier of the product you wish to update.","default":"","type":"string","name":"identifier"},{"_id":"5c652532902ebe005067594e","ref":"","in":"body","required":false,"desc":"The Tophatter internal ID of the product you want to update. Only required if you aren't already using the `identifier`.","default":"","type":"int","name":"internal_id"},{"_id":"56a99773257fbc0d00d4764e","ref":"","in":"body","required":false,"desc":"The category of the product. The list of valid categories can be found [here](doc:categories).","default":"","type":"string","name":"category"},{"_id":"56a99773257fbc0d00d4765a","ref":"","in":"body","required":false,"desc":"The name of the product.","default":"","type":"string","name":"title"},{"_id":"56a99773257fbc0d00d47659","ref":"","in":"body","required":false,"desc":"The description of the product. Should not contain HTML. Newlines are okay.","default":"","type":"string","name":"description"},{"_id":"56a99773257fbc0d00d4764f","ref":"","in":"body","required":false,"desc":"The condition of the product. The list of valid conditions can be found [here](doc:conditions).","default":"","type":"string","name":"condition"},{"_id":"56a99773257fbc0d00d4764d","ref":"","in":"body","required":false,"desc":"The brand of the product (if any). The list of valid brands can be found [here](doc:brands).","default":"","type":"string","name":"brand"},{"_id":"56a99773257fbc0d00d4764b","ref":"","in":"body","required":false,"desc":"The material the product consists of. The list of recommended materials can be found [here](doc:materials).","default":"","type":"string","name":"material"},{"_id":"576b1fe8a3eb7a2b0042433d","ref":"","in":"body","required":false,"desc":"A hash of product variations, keyed by the unique identifier of each variation. A product variation consists of a unique id, size, color, and quantity. Both size and color are optional.","default":"","type":"object","name":"variations"},{"_id":"56a998d23b04f20d00ecca90","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"int","name":"retail_price"},{"_id":"56a99773257fbc0d00d47650","ref":"","in":"body","required":false,"desc":"Target price (field name: cost_basis) should be the lowest price (excluding shipping) at which you are willing to sell a product.","default":"","type":"int","name":"cost_basis"},{"_id":"5bd92dd49660a90023569032","ref":"","in":"body","required":false,"desc":"The starting price of a product in auction.","default":"","type":"int","name":"minimum_bid_amount"},{"_id":"5bc040e9e752030003c5cef4","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"float","name":"scheduling_fee_bid"},{"_id":"5bd92dd49660a90023569031","ref":"","in":"body","required":false,"desc":"The maximum number of times per day the product is scheduled. The number of schedules are also constrained by your inventory, budget, and bid.","default":"","type":"int","name":"max_daily_schedules"},{"_id":"56a99773257fbc0d00d47652","ref":"","in":"body","required":false,"desc":"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](https://tophatter.com/sellers/shipping_rates).","default":"","type":"int","name":"shipping_price"},{"_id":"56a99773257fbc0d00d4764a","ref":"","in":"body","required":false,"desc":"The country the product ships from.","default":"","type":"string","name":"shipping_origin"},{"_id":"5c64df67f49e7d00516e4fe6","ref":"","in":"body","required":false,"desc":"The 3PL or warehouse partner you're using to fulfill orders for this product. Example: `noram`.","default":"","type":"string","name":"fulfillment_partner"},{"_id":"56a99773257fbc0d00d47647","ref":"","in":"body","required":false,"desc":"The weight (in ounces) of the package when you ship this item. Used to help determine shipping costs in certain scenarios.","default":"","type":"int","name":"weight"},{"_id":"56a99773257fbc0d00d47649","ref":"","in":"body","required":false,"desc":"The number of days (after purchase) that it will take you to process & fulfill the order by shipping the item.","default":"","type":"int","name":"days_to_fulfill"},{"_id":"5772e2a0dceb570e003a91d0","ref":"","in":"body","required":false,"desc":"The shipping price of the product when someone in the US purchases one and chooses expedited shipping.","default":"","type":"int","name":"expedited_shipping_price"},{"_id":"5772e2a0dceb570e003a91cf","ref":"","in":"body","required":false,"desc":"The number of days you expect the shipment to be in transit to the buyer when the buyer chooses expedited shipping.","default":"","type":"int","name":"expedited_days_to_deliver"},{"_id":"5c988eb103c0cd00eae456ba","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"boolean","name":"buy_one_get_one_available"},{"_id":"56a99773257fbc0d00d47646","ref":"","in":"body","required":false,"desc":"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.","default":"","type":"string","name":"primary_image"},{"_id":"56a99773257fbc0d00d47645","ref":"","in":"body","required":false,"desc":"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","default":"","type":"string","name":"extra_images"}],"url":"/products/update.json"},"isReference":false,"order":5,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Tip\",\n  \"body\": \"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).\"\n}\n[/block]","excerpt":"","slug":"product-update","type":"endpoint","title":"Update a Product"}

postUpdate a Product


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

identifier:
required
string
The identifier of the product you wish to update.
internal_id:
integer
The Tophatter internal ID of the product you want to update. Only required if you aren't already using the `identifier`.
category:
string
The category of the product. The list of valid categories can be found [here](doc:categories).
title:
string
The name of the product.
description:
string
The description of the product. Should not contain HTML. Newlines are okay.
condition:
string
The condition of the product. The list of valid conditions can be found [here](doc:conditions).
brand:
string
The brand of the product (if any). The list of valid brands can be found [here](doc:brands).
material:
string
The material the product consists of. The list of recommended materials can be found [here](doc:materials).
variations:
object
A hash of product variations, keyed by the unique identifier of each variation. A product variation consists of a unique id, size, color, and quantity. Both size and color are optional.
retail_price:
integer
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.
cost_basis:
integer
Target price (field name: cost_basis) should be the lowest price (excluding shipping) at which you are willing to sell a product.
minimum_bid_amount:
integer
The starting price of a product in auction.
scheduling_fee_bid:
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.
max_daily_schedules:
integer
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:
integer
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](https://tophatter.com/sellers/shipping_rates).
shipping_origin:
string
The country the product ships from.
fulfillment_partner:
string
The 3PL or warehouse partner you're using to fulfill orders for this product. Example: `noram`.
weight:
integer
The weight (in ounces) of the package when you ship this item. Used to help determine shipping costs in certain scenarios.
days_to_fulfill:
integer
The number of days (after purchase) that it will take you to process & fulfill the order by shipping the item.
expedited_shipping_price:
integer
The shipping price of the product when someone in the US purchases one and chooses expedited shipping.
expedited_days_to_deliver:
integer
The number of days you expect the shipment to be in transit to the buyer when the buyer chooses expedited shipping.
buy_one_get_one_available:
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.
primary_image:
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.
extra_images:
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

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "Tip", "body": "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)." } [/block]