{"_id":"569fbbcbbeb79a17009f8f89","parentDoc":null,"project":"556cd8aec14029190092d292","user":"5625a0ce4dcb400d00ff4473","__v":39,"category":{"_id":"55fdb08c4bebdf17004130d4","project":"556cd8aec14029190092d292","version":"556cd8aec14029190092d295","__v":11,"pages":["55fdb124b652110d00758b70","55fdb2a956d6990d00a6caca","55fdb38856d6990d00a6cacc","55ff6c519e7ccf0d000a1d7f","5613db97acd4343500088079","5616d7b9cf2a1e0d00247971","56196204fa2a6d0d002a1352","5622f2c906481c0d00e5315c","569526b8caa32519009c411e","569fbbcbbeb79a17009f8f89","56aac68aac665d0d00af76b0"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-19T18:59:24.105Z","from_sync":false,"order":4,"slug":"how-to","title":"How To..."},"version":{"_id":"556cd8aec14029190092d295","__v":14,"project":"556cd8aec14029190092d292","createdAt":"2015-06-01T22:11:58.756Z","releaseDate":"2015-06-01T22:11:58.756Z","categories":["556cd8afc14029190092d296","55ca5a55241e790d004f47ea","55dc9fdb4f535537007da1b2","55dc9fdfc755b63700dc843c","55fdb08c4bebdf17004130d4","560ef4c2a36c610d00e7013e","5613db296a092921004c30c2","56156581dc8aea0d002475e8","56169d1ee98f5517005627a8","5622fde7de7dc01700c6dd5f","56cf75f3336aa60b0086a495","5818f3c02093901b00bcf91a","582f7ff88ea0800f0035639a","583f30c110448a2500dd990f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-20T16:54:35.569Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":5,"body":"##1. Get Bump Info\n[block:api-header]\n{\n  \"type\": \"get\",\n  \"title\": \"/api/listings/:listing_id/bump\"\n}\n[/block]\nSee which budget plans are available to purchase for a particular listing, as well as historical bump stats for this listing, if it exists. Here are some [Notes about Bump Stats](https://dev.reverb.com/docs/bump-listings#section-notes-about-bump-stats).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -XGET -H \\\"Content-Type: application/hal+json\\\" -H \\\"Accept: application/hal+json\\\" -H \\\"Authorization: Bearer [oauth_token]\\\" https://api.reverb.com/api/listings/25411/bump\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"stats\\\": {\\n    \\\"bumps_used\\\": 400,\\n    \\\"bumps_budgeted\\\": 1250,\\n    \\\"sales\\\": 1,\\n    \\\"can_be_bumped\\\": true,\\n    \\\"clicks\\\": 281,\\n    \\\"cost\\\": {\\n      \\\"amount\\\": \\\"2.56\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    },\\n    \\\"revenue\\\": {\\n      \\\"amount\\\": \\\"300.00\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    },\\n    \\\"max_cost\\\": {\\n      \\\"amount\\\": \\\"8.00\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    }\\n  },\\n  \\\"budgets\\\": [\\n    {\\n      \\\"description\\\": \\\"1250 bumps for $8.00\\\",\\n      \\\"bumps\\\": 1250,\\n      \\\"max_cost\\\": {\\n        \\\"amount\\\": \\\"8.00\\\",\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"symbol\\\": \\\"$\\\"\\n      },\\n      \\\"_links\\\": {\\n        \\\"buy\\\": {\\n          \\\"href\\\": \\\"/api/listings/25411/bump/tier-2\\\"\\n        }\\n      }\\n    },\\n    {\\n      \\\"description\\\": \\\"3500 bumps for $16.00\\\",\\n      \\\"bumps\\\": 3500,\\n      \\\"max_cost\\\": {\\n        \\\"amount\\\": \\\"16.00\\\",\\n        \\\"currency\\\": \\\"USD\\\",\\n        \\\"symbol\\\": \\\"$\\\"\\n      },\\n      \\\"_links\\\": {\\n        \\\"buy\\\": {\\n          \\\"href\\\": \\\"/api/listings/25411/bump/tier-2-bulk\\\"\\n        }\\n      }\\n    }\\n  ],\\n  \\\"_links\\\": {\\n    \\\"self\\\": {\\n      \\\"href\\\": \\\"/api/listings/25411/bumps\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Notes about Bump Stats\n+ `stats` =>  will be omitted if the listing has never been bumped.\n+ `sales` => how many times this item has sold. An listing can be sold many times under the same bump budget if it has inventory.\n+ `cost` => the current total cost invested in bumping this listing. Bumps are only changed when the listing sells\n+ `can_be_bumped` => `true` when the listing is still live or can be re-stocked\n\nThe listing for the stats below has been sold once; it still has inventory, so it can be bumped; and the total cost investment for bumping this listing is $5.62 USD, as a result of its 1 sale.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// sample bump stats object\\n{ \\\"stats\\\": {\\n    \\\"bumps_used\\\": 400,\\n    \\\"bumps_budgeted\\\": 1250,\\n    \\\"sales\\\": 1,\\n    \\\"can_be_bumped\\\": true,\\n    \\\"clicks\\\": 281,\\n    \\\"cost\\\": {\\n      \\\"amount\\\": \\\"2.56\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    },\\n    \\\"revenue\\\": {\\n      \\\"amount\\\": \\\"300.00\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    },\\n    \\\"max_cost\\\": {\\n      \\\"amount\\\": \\\"8.00\\\",\\n      \\\"currency\\\": \\\"USD\\\",\\n      \\\"symbol\\\": \\\"$\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##2. Bump A Listing\n[block:api-header]\n{\n  \"type\": \"post\",\n  \"title\": \"api/listings/:listing_id/bump/:budget_name\"\n}\n[/block]\nIn order to know which budget plans are available for a particular listing, you may need to [get bump info](https://dev.reverb.com/docs/bump-listings#section-1-get-bump-info) first.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -XPOST -H \\\"Content-Type: application/hal+json\\\" -H \\\"Accept: application/hal+json\\\" -H \\\"Authorization: Bearer [oauth_token]\\\" https://api.reverb.com/api/listings/25411/bump/tier-2\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nA success response will simply be an empty body with status 200.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"[What is Bump?](https://reverb.com/page/bump)\n[Bump Info for a Listing](https://dev.reverb.com/docs/bump-listings#section-1-get-bump-info)\n[Bump A Listing](https://dev.reverb.com/docs/bump-listings#section-2-bump-a-listing)\n[Notes about Bump Stats](https://dev.reverb.com/docs/bump-listings#section-notes-about-bump-stats)","slug":"bump-listings","type":"basic","title":"Manage Bumps"}

Manage Bumps

[What is Bump?](https://reverb.com/page/bump) [Bump Info for a Listing](https://dev.reverb.com/docs/bump-listings#section-1-get-bump-info) [Bump A Listing](https://dev.reverb.com/docs/bump-listings#section-2-bump-a-listing) [Notes about Bump Stats](https://dev.reverb.com/docs/bump-listings#section-notes-about-bump-stats)

##1. Get Bump Info [block:api-header] { "type": "get", "title": "/api/listings/:listing_id/bump" } [/block] See which budget plans are available to purchase for a particular listing, as well as historical bump stats for this listing, if it exists. Here are some [Notes about Bump Stats](https://dev.reverb.com/docs/bump-listings#section-notes-about-bump-stats). [block:code] { "codes": [ { "code": "curl -XGET -H \"Content-Type: application/hal+json\" -H \"Accept: application/hal+json\" -H \"Authorization: Bearer [oauth_token]\" https://api.reverb.com/api/listings/25411/bump", "language": "curl" } ] } [/block] [block:code] { "codes": [ { "code": "{\n \"stats\": {\n \"bumps_used\": 400,\n \"bumps_budgeted\": 1250,\n \"sales\": 1,\n \"can_be_bumped\": true,\n \"clicks\": 281,\n \"cost\": {\n \"amount\": \"2.56\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"revenue\": {\n \"amount\": \"300.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"max_cost\": {\n \"amount\": \"8.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n }\n },\n \"budgets\": [\n {\n \"description\": \"1250 bumps for $8.00\",\n \"bumps\": 1250,\n \"max_cost\": {\n \"amount\": \"8.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"_links\": {\n \"buy\": {\n \"href\": \"/api/listings/25411/bump/tier-2\"\n }\n }\n },\n {\n \"description\": \"3500 bumps for $16.00\",\n \"bumps\": 3500,\n \"max_cost\": {\n \"amount\": \"16.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"_links\": {\n \"buy\": {\n \"href\": \"/api/listings/25411/bump/tier-2-bulk\"\n }\n }\n }\n ],\n \"_links\": {\n \"self\": {\n \"href\": \"/api/listings/25411/bumps\"\n }\n }\n}", "language": "json" } ] } [/block] ###Notes about Bump Stats + `stats` => will be omitted if the listing has never been bumped. + `sales` => how many times this item has sold. An listing can be sold many times under the same bump budget if it has inventory. + `cost` => the current total cost invested in bumping this listing. Bumps are only changed when the listing sells + `can_be_bumped` => `true` when the listing is still live or can be re-stocked The listing for the stats below has been sold once; it still has inventory, so it can be bumped; and the total cost investment for bumping this listing is $5.62 USD, as a result of its 1 sale. [block:code] { "codes": [ { "code": "// sample bump stats object\n{ \"stats\": {\n \"bumps_used\": 400,\n \"bumps_budgeted\": 1250,\n \"sales\": 1,\n \"can_be_bumped\": true,\n \"clicks\": 281,\n \"cost\": {\n \"amount\": \"2.56\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"revenue\": {\n \"amount\": \"300.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n },\n \"max_cost\": {\n \"amount\": \"8.00\",\n \"currency\": \"USD\",\n \"symbol\": \"$\"\n }\n }\n}", "language": "json" } ] } [/block] ##2. Bump A Listing [block:api-header] { "type": "post", "title": "api/listings/:listing_id/bump/:budget_name" } [/block] In order to know which budget plans are available for a particular listing, you may need to [get bump info](https://dev.reverb.com/docs/bump-listings#section-1-get-bump-info) first. [block:code] { "codes": [ { "code": "curl -XPOST -H \"Content-Type: application/hal+json\" -H \"Accept: application/hal+json\" -H \"Authorization: Bearer [oauth_token]\" https://api.reverb.com/api/listings/25411/bump/tier-2", "language": "curl" } ] } [/block] A success response will simply be an empty body with status 200. [block:code] { "codes": [ { "code": "{}", "language": "json" } ] } [/block]