{"_id":"5c983fc3285300000ecbcbf7","project":"567f0c06143cc60d00c1fdbe","initVersion":{"_id":"567f0c06143cc60d00c1fdc1","version":"1"},"user":{"_id":"567f0baca74a1c0d003e1fba","username":"","name":"Chris Estreich"},"__v":5,"createdAt":"2019-03-25T02:41:07.830Z","changelog":[{"_id":"5c9856bc688958005728d9a3","update":"http://merchant-api.tophatter.com/docs/product-retrieve","type":"improved"},{"_id":"5c985a9ca6919c001f4b072b","update":"http://merchant-api.tophatter.com/docs/product-create","type":"improved"},{"_id":"5c985a9ca6919c001f4b072a","update":"http://merchant-api.tophatter.com/docs/order-retrieve","type":"improved"},{"_id":"5c985a9ca6919c001f4b0729","update":"http://merchant-api.tophatter.com/docs/product-update","type":"improved"},{"_id":"5c988cacb5a60c00322a82b4","update":"","type":"added"}],"body":"In order to provide a better platform experience for buyers and sellers, TOPHATTER has following updates on the product posting page:\n  * Under \"Buy One Get One\" for $XX promotion feature, we will remove the **Additional Item Price** section, sellers can no longer set BOGO price as it will automatically take the final checkout price. Final checkout price is equal to the buyer's final bid amount with the shipping price both prices total added. \n  * Under \"Accessory\" promotion feature, now sellers can **add product accessory images** (*UI feature will be updated soon*). Sellers can add other product's identifier id to link the product image or upload via CSV/API. \n\nPlease make timely adjustments to your different products, sellers can do it in batches via CSV/API as we updated these 2 features to fully reflect our platform changes.\n\nHappy Selling!\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/28f3393-_2019-03-25_11.57.25.png\",\n        \"屏幕快照 2019-03-25 上午11.57.25.png\",\n        1062,\n        428,\n        \"#dad8d5\"\n      ],\n      \"caption\": \"Before March 22, 2019 Update\"\n    }\n  ]\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/9af769d-_2019-03-25_12.18.16.png\",\n        \"屏幕快照 2019-03-25 下午12.18.16.png\",\n        618,\n        195,\n        \"#d4d6d1\"\n      ],\n      \"caption\": \"After March 22, 2019 Update\"\n    }\n  ]\n}\n[/block]\nAPI changes lie in the Product API:\n  * Added ''quantity\" parameter in BOGO and accessory promotion\n  * We will deprecate \"buy_one_get_one_price\" parameter. It will be replaced with \"buy_one_get_one_available\"\n  * Under \"type_description\": \"accessory\" added \"identifier\" parameter. Sellers can add other product \"identifier\" to get linked as upsells.\n  * Under \"type_description\": \"accessory\" added \"image\" parameter. Sellers can now add image product to upsell accessory\n\nOrder API changes:\n  * Added \"product_quantity\" for upsells quantity\n  * Added \"identifier\" parameter in \"type_description\": \"accessory\"\n  * Added \"image\" parameter in \"type_description\": \"accessory\" \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"identifier\\\": \\\"RH00001\\\",\\n    \\\"internal_id\\\": 11111111,\\n    \\\"category\\\": \\\"Electronics | Audio | Headphones\\\",\\n    \\\"title\\\": \\\"Electronic Wireless Earbuds\\\",\\n    \\\"description\\\": \\\"1. Listening to music/songs \\\\r\\\\n2. Reminder/Voice Prompts\\\\r\\\\n3. Power capacity will show on your cellular phone, you can see the power situation anytime\\\\r\\\\n4. Support up to One to two connections, can be connected to two mobile phones at the same time \\\\r\\\\n5. Bluetooth headset connected to the phone after the shutdown\\\\r\\\\n6. Intelligent compatibility: support all Bluetooth mobile phone, tablet, notebook, singing it, QQ music, movies, etc., universal all mobile phone \\\\r\\\\n\\\\r\\\\n\\\\r\\\\nSpecification: \\\\r\\\\n1. Driver: 15mm \\\\r\\\\n2. Impedance: 32 OHM \\\\r\\\\n3. Bluetooth version: Bluetooth v4.2 + EDR \\\\r\\\\n4. Bluetooth use band: 2.4GHz \\\\r\\\\n5. Power level: CLASS II \\\\r\\\\n6. Output power: 30mW \\\\r\\\\n7. Bluetooth distance: 10 meters barrier \\\\r\\\\n8. Frequency response: 20-20000Hz \\\\r\\\\n9. Operating voltage range: 3.0V-4.2V \\\\r\\\\n10. Mic sensitivity: -42dB \\\\r\\\\n11. With A2DP / AVRCP high quality stereo audio transmission and remote control protocol \\\\r\\\\n12. Powerful noise de-noising circuit (active noise reduction) \\\\r\\\\n13. switch between Chinese and English (boot does not connect Bluetooth state, press the switch 2 times, hear the tone switch successfully) \\\\r\\\\n13. Talk time is about 6 hours \\\\r\\\\n14. music time about 4-5 hours \\\\r\\\\n15. Standby time is about 120 hours \\\\r\\\\n\\\\r\\\\nPackage Includes: \\\\r\\\\n2xmini Bluetooth Headphones(left and right earphones) \\\\r\\\\n1x Charging box \\\\r\\\\n1xUSB Charging Cable \\\\r\\\\n1xUser Manual\\\",\\n    \\\"condition\\\": \\\"New\\\",\\n    \\\"brand\\\": \\\"\\\",\\n    \\\"material\\\": \\\"abs\\\",\\n    \\\"available_quantity\\\": 0,\\n    \\\"variations\\\": [\\n        {\\n            \\\"identifier\\\": \\\"RH00001-Red\\\",\\n            \\\"internal_id\\\": 11111112,\\n            \\\"size\\\": null,\\n            \\\"color\\\": \\\"Red\\\",\\n            \\\"quantity\\\": 5,\\n            \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n            \\\"disabled_at\\\": null,\\n            \\\"deleted_at\\\": null\\n        },\\n        {\\n            \\\"identifier\\\": \\\"RH00001-Black\\\",\\n            \\\"internal_id\\\": 11111113,\\n            \\\"size\\\": null,\\n            \\\"color\\\": \\\"Black\\\",\\n            \\\"quantity\\\": 5,\\n            \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n            \\\"disabled_at\\\": null,\\n            \\\"deleted_at\\\": null\\n        },\\n        {\\n            \\\"identifier\\\": \\\"RH00001-White\\\",\\n            \\\"internal_id\\\": 11111114,\\n            \\\"size\\\": null,\\n            \\\"color\\\": \\\"White\\\",\\n            \\\"quantity\\\": 5,\\n            \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n            \\\"disabled_at\\\": null,\\n            \\\"deleted_at\\\": null\\n        },\\n        {\\n            \\\"identifier\\\": \\\"RH00001-Pink\\\",\\n            \\\"internal_id\\\": 11111115,\\n            \\\"size\\\": null,\\n            \\\"color\\\": \\\"Pink\\\",\\n            \\\"quantity\\\": 5,\\n            \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n            \\\"disabled_at\\\": null,\\n            \\\"deleted_at\\\": null\\n        },\\n        {\\n            \\\"identifier\\\": \\\"RH00001-Gold\\\",\\n            \\\"internal_id\\\": 11111116,\\n            \\\"size\\\": null,\\n            \\\"color\\\": \\\"Gold\\\",\\n            \\\"quantity\\\": 5,\\n            \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n            \\\"disabled_at\\\": null,\\n            \\\"deleted_at\\\": null\\n        }\\n    ],\\n    \\\"retail_price\\\": 999,\\n    \\\"cost_basis\\\": 19,\\n    \\\"minimum_bid_amount\\\": 5,\\n    \\\"max_daily_schedules\\\": null,\\n    \\\"scheduling_fee_bid\\\": 1.1,\\n    \\\"reserve_price\\\": null,\\n    \\\"shipping_price\\\": 5,\\n    \\\"shipping_origin\\\": \\\"China\\\",\\n    \\\"fulfillment_partner\\\": null,\\n    \\\"weight\\\": null,\\n    \\\"days_to_fulfill\\\": 5,\\n    \\\"days_to_deliver\\\": 14,\\n    \\\"expedited_shipping_price\\\": 12,\\n    \\\"expedited_days_to_deliver\\\": 10,\\n    \\\"buy_one_get_one_price\\\": 19,\\n    \\\"buy_one_get_one_available\\\": true,\\n    \\\"upsells\\\": [\\n        {\\n            \\\"type_description\\\": \\\"buy_one_get_one\\\",\\n            \\\"amount\\\": \\\"19.0\\\",\\n            \\\"description\\\": null\\n        },\\n        {\\n            \\\"type_description\\\": \\\"accessory\\\",\\n            \\\"amount\\\": \\\"4.0\\\",\\n            \\\"description\\\": \\\"1*color box\\\",\\n            \\\"identifier\\\": null,\\n            \\\"image\\\": null\\n        }\\n    ],\\n    \\\"primary_image\\\": \\\"https://images.tophatter.com/original1.jpg\\\",\\n    \\\"extra_images\\\": \\\"https://images.tophatter.com/original2.jpg|https://images.tophatter.com/original3.jpg|https://images.tophatter.com/original4.jpg|https://images.tophatter.com/original5.jpg|https://images.tophatter.com/original6.jpg|https://images.tophatter.com/original7.jpg|https://images.tophatter.com/original8.jpg\\\",\\n    \\\"all_images\\\": [...],\\n    \\\"ratings_count\\\": 170,\\n    \\\"ratings_average\\\": 4.1882,\\n    \\\"created_at\\\": \\\"2019-02-23T16:57:03-08:00\\\",\\n    \\\"updated_at\\\": \\\"2019-03-24T21:19:42-07:00\\\",\\n    \\\"disabled_at\\\": null,\\n    \\\"deleted_at\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"product merchant-api\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"order_id\\\": 82664093,\\n    \\\"status\\\": \\\"paid\\\",\\n    \\\"carrier\\\": null,\\n    \\\"tracking_number\\\": null,\\n    \\\"fulfillment_partner\\\": null,\\n    \\\"product_name\\\": \\\"E. Headset Earbuds Ture Wireless Bluetooth Double Earphone Twins Earpieces Stereo Binaural Earphones For All mobile phones\\\",\\n    \\\"product_identifier\\\": “RH00001”,\\n    \\\"product_internal_id\\\": fake-id (1111111),\\n    \\\"variation_identifier\\\": \\\"RH00001-Gold\\\",\\n    \\\"variation_internal_id\\\": fake-id (11111116),\\n    \\\"annotation\\\": null,\\n    \\\"customer_id\\\": 1034347337,\\n    \\\"customer_name\\\": “John Doe”,\\n    \\\"address1\\\": \\\"123 Main Street\\\",\\n    \\\"address2\\\": \\\"\\\",\\n    \\\"city\\\": “Los Altos”,\\n    \\\"state\\\": “CA”,\\n    \\\"postal_code\\\": “94022\\\",\\n    \\\"country\\\": \\\"USA\\\",\\n    \\\"available_refunds\\\": {\\n        \\\"buyer_fee\\\": fake-buyer-fee (12.0),\\n        \\\"lot_upsell_fee\\\": fake-upsell-fee (23.0)\\n    },\\n    \\\"refund_amount\\\": 0,\\n    \\\"disbursement_amount\\\": \\\"fake-disbursement-amount (28.88)”,\\n    \\\"seller_fees_amount\\\": fake-seller-fee-amount (6.12),\\n    \\\"seller_fees\\\": [\\n        {\\n            \\\"type\\\": \\\"scheduling_fee\\\",\\n            \\\"amount\\\": fake-scheduling-fee (1.3)\\n        },\\n        {\\n            \\\"type\\\": \\\"commission_fee\\\",\\n            \\\"amount\\\": fake-commission-fee (3.5)\\n        },\\n        {\\n            \\\"type\\\": \\\"processing_fee\\\",\\n            \\\"amount\\\": fake-processing-fee (1.32)\\n        }\\n    ],\\n    \\\"upsells\\\": [\\n        {\\n            \\\"type_description\\\": \\\"buy_one_get_one\\\",\\n            \\\"amount\\\": \\\"19.0\\\", //soon-to-be-deprecated\\n            \\\"description\\\": null\\n        },\\n        {\\n            \\\"type_description\\\": \\\"accessory\\\",\\n            \\\"amount\\\": \\\"4.0\\\",\\n            \\\"description\\\": \\\"1*color box\\\",\\n            \\\"identifier\\\": null,\\n            \\\"image\\\": null\\n        }\\n    ],\\n    \\\"product_quantity\\\": 2,\\n    \\\"refunded_at\\\": null,\\n    \\\"paid_at\\\": \\\"2019-03-18T17:23:01-07:00\\\",\\n    \\\"created_at\\\": \\\"2019-03-18T17:17:29-07:00\\\",\\n    \\\"updated_at\\\": \\\"2019-03-19T03:40:40-07:00\\\",\\n    \\\"canceled_at\\\": null\\n}\",\n      \"language\": \"json\",\n      \"name\": \"order merchant-api\"\n    }\n  ]\n}\n[/block]","slug":"upsells-update","title":"Upsells update"}

Upsells update


In order to provide a better platform experience for buyers and sellers, TOPHATTER has following updates on the product posting page: * Under "Buy One Get One" for $XX promotion feature, we will remove the **Additional Item Price** section, sellers can no longer set BOGO price as it will automatically take the final checkout price. Final checkout price is equal to the buyer's final bid amount with the shipping price both prices total added. * Under "Accessory" promotion feature, now sellers can **add product accessory images** (*UI feature will be updated soon*). Sellers can add other product's identifier id to link the product image or upload via CSV/API. Please make timely adjustments to your different products, sellers can do it in batches via CSV/API as we updated these 2 features to fully reflect our platform changes. Happy Selling! [block:image] { "images": [ { "image": [ "https://files.readme.io/28f3393-_2019-03-25_11.57.25.png", "屏幕快照 2019-03-25 上午11.57.25.png", 1062, 428, "#dad8d5" ], "caption": "Before March 22, 2019 Update" } ] } [/block] [block:image] { "images": [ { "image": [ "https://files.readme.io/9af769d-_2019-03-25_12.18.16.png", "屏幕快照 2019-03-25 下午12.18.16.png", 618, 195, "#d4d6d1" ], "caption": "After March 22, 2019 Update" } ] } [/block] API changes lie in the Product API: * Added ''quantity" parameter in BOGO and accessory promotion * We will deprecate "buy_one_get_one_price" parameter. It will be replaced with "buy_one_get_one_available" * Under "type_description": "accessory" added "identifier" parameter. Sellers can add other product "identifier" to get linked as upsells. * Under "type_description": "accessory" added "image" parameter. Sellers can now add image product to upsell accessory Order API changes: * Added "product_quantity" for upsells quantity * Added "identifier" parameter in "type_description": "accessory" * Added "image" parameter in "type_description": "accessory" [block:code] { "codes": [ { "code": "{\n \"identifier\": \"RH00001\",\n \"internal_id\": 11111111,\n \"category\": \"Electronics | Audio | Headphones\",\n \"title\": \"Electronic Wireless Earbuds\",\n \"description\": \"1. Listening to music/songs \\r\\n2. Reminder/Voice Prompts\\r\\n3. Power capacity will show on your cellular phone, you can see the power situation anytime\\r\\n4. Support up to One to two connections, can be connected to two mobile phones at the same time \\r\\n5. Bluetooth headset connected to the phone after the shutdown\\r\\n6. Intelligent compatibility: support all Bluetooth mobile phone, tablet, notebook, singing it, QQ music, movies, etc., universal all mobile phone \\r\\n\\r\\n\\r\\nSpecification: \\r\\n1. Driver: 15mm \\r\\n2. Impedance: 32 OHM \\r\\n3. Bluetooth version: Bluetooth v4.2 + EDR \\r\\n4. Bluetooth use band: 2.4GHz \\r\\n5. Power level: CLASS II \\r\\n6. Output power: 30mW \\r\\n7. Bluetooth distance: 10 meters barrier \\r\\n8. Frequency response: 20-20000Hz \\r\\n9. Operating voltage range: 3.0V-4.2V \\r\\n10. Mic sensitivity: -42dB \\r\\n11. With A2DP / AVRCP high quality stereo audio transmission and remote control protocol \\r\\n12. Powerful noise de-noising circuit (active noise reduction) \\r\\n13. switch between Chinese and English (boot does not connect Bluetooth state, press the switch 2 times, hear the tone switch successfully) \\r\\n13. Talk time is about 6 hours \\r\\n14. music time about 4-5 hours \\r\\n15. Standby time is about 120 hours \\r\\n\\r\\nPackage Includes: \\r\\n2xmini Bluetooth Headphones(left and right earphones) \\r\\n1x Charging box \\r\\n1xUSB Charging Cable \\r\\n1xUser Manual\",\n \"condition\": \"New\",\n \"brand\": \"\",\n \"material\": \"abs\",\n \"available_quantity\": 0,\n \"variations\": [\n {\n \"identifier\": \"RH00001-Red\",\n \"internal_id\": 11111112,\n \"size\": null,\n \"color\": \"Red\",\n \"quantity\": 5,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n },\n {\n \"identifier\": \"RH00001-Black\",\n \"internal_id\": 11111113,\n \"size\": null,\n \"color\": \"Black\",\n \"quantity\": 5,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n },\n {\n \"identifier\": \"RH00001-White\",\n \"internal_id\": 11111114,\n \"size\": null,\n \"color\": \"White\",\n \"quantity\": 5,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n },\n {\n \"identifier\": \"RH00001-Pink\",\n \"internal_id\": 11111115,\n \"size\": null,\n \"color\": \"Pink\",\n \"quantity\": 5,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n },\n {\n \"identifier\": \"RH00001-Gold\",\n \"internal_id\": 11111116,\n \"size\": null,\n \"color\": \"Gold\",\n \"quantity\": 5,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n }\n ],\n \"retail_price\": 999,\n \"cost_basis\": 19,\n \"minimum_bid_amount\": 5,\n \"max_daily_schedules\": null,\n \"scheduling_fee_bid\": 1.1,\n \"reserve_price\": null,\n \"shipping_price\": 5,\n \"shipping_origin\": \"China\",\n \"fulfillment_partner\": null,\n \"weight\": null,\n \"days_to_fulfill\": 5,\n \"days_to_deliver\": 14,\n \"expedited_shipping_price\": 12,\n \"expedited_days_to_deliver\": 10,\n \"buy_one_get_one_price\": 19,\n \"buy_one_get_one_available\": true,\n \"upsells\": [\n {\n \"type_description\": \"buy_one_get_one\",\n \"amount\": \"19.0\",\n \"description\": null\n },\n {\n \"type_description\": \"accessory\",\n \"amount\": \"4.0\",\n \"description\": \"1*color box\",\n \"identifier\": null,\n \"image\": null\n }\n ],\n \"primary_image\": \"https://images.tophatter.com/original1.jpg\",\n \"extra_images\": \"https://images.tophatter.com/original2.jpg|https://images.tophatter.com/original3.jpg|https://images.tophatter.com/original4.jpg|https://images.tophatter.com/original5.jpg|https://images.tophatter.com/original6.jpg|https://images.tophatter.com/original7.jpg|https://images.tophatter.com/original8.jpg\",\n \"all_images\": [...],\n \"ratings_count\": 170,\n \"ratings_average\": 4.1882,\n \"created_at\": \"2019-02-23T16:57:03-08:00\",\n \"updated_at\": \"2019-03-24T21:19:42-07:00\",\n \"disabled_at\": null,\n \"deleted_at\": null\n}", "language": "json", "name": "product merchant-api" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"order_id\": 82664093,\n \"status\": \"paid\",\n \"carrier\": null,\n \"tracking_number\": null,\n \"fulfillment_partner\": null,\n \"product_name\": \"E. Headset Earbuds Ture Wireless Bluetooth Double Earphone Twins Earpieces Stereo Binaural Earphones For All mobile phones\",\n \"product_identifier\": “RH00001”,\n \"product_internal_id\": fake-id (1111111),\n \"variation_identifier\": \"RH00001-Gold\",\n \"variation_internal_id\": fake-id (11111116),\n \"annotation\": null,\n \"customer_id\": 1034347337,\n \"customer_name\": “John Doe”,\n \"address1\": \"123 Main Street\",\n \"address2\": \"\",\n \"city\": “Los Altos”,\n \"state\": “CA”,\n \"postal_code\": “94022\",\n \"country\": \"USA\",\n \"available_refunds\": {\n \"buyer_fee\": fake-buyer-fee (12.0),\n \"lot_upsell_fee\": fake-upsell-fee (23.0)\n },\n \"refund_amount\": 0,\n \"disbursement_amount\": \"fake-disbursement-amount (28.88)”,\n \"seller_fees_amount\": fake-seller-fee-amount (6.12),\n \"seller_fees\": [\n {\n \"type\": \"scheduling_fee\",\n \"amount\": fake-scheduling-fee (1.3)\n },\n {\n \"type\": \"commission_fee\",\n \"amount\": fake-commission-fee (3.5)\n },\n {\n \"type\": \"processing_fee\",\n \"amount\": fake-processing-fee (1.32)\n }\n ],\n \"upsells\": [\n {\n \"type_description\": \"buy_one_get_one\",\n \"amount\": \"19.0\", //soon-to-be-deprecated\n \"description\": null\n },\n {\n \"type_description\": \"accessory\",\n \"amount\": \"4.0\",\n \"description\": \"1*color box\",\n \"identifier\": null,\n \"image\": null\n }\n ],\n \"product_quantity\": 2,\n \"refunded_at\": null,\n \"paid_at\": \"2019-03-18T17:23:01-07:00\",\n \"created_at\": \"2019-03-18T17:17:29-07:00\",\n \"updated_at\": \"2019-03-19T03:40:40-07:00\",\n \"canceled_at\": null\n}", "language": "json", "name": "order merchant-api" } ] } [/block]
improved
http://merchant-api.tophatter.com/docs/product-retrieve
improved
http://merchant-api.tophatter.com/docs/product-create
improved
http://merchant-api.tophatter.com/docs/order-retrieve
improved
http://merchant-api.tophatter.com/docs/product-update