If you're looking to integrate payout information with your existing eCommerce, inventory, or financial system, you can pull down payouts from the Reverb API and make equivalent entries for bookkeeping in your application.
Your app pulls payouts from Reverb on a timer. You can set up a cron job to do this nightly, or run a manual script to do so.
First, we'll fetch the payouts for a given date range. Note that the dates are in ISO8601 format.
curl -XGET -H "Authorization: Bearer [oauth_token]" -H "Content-Type: application/hal+json" https://api.reverb.com/api/my/payouts?created_start_date=2017-10-15T12:00-00:00&created_end_date=2017-10-30T12:00-00:00&per_page=5The response will contain a list of payout objects, which represent a group of transactions that was sent to your bank account. You will have one payout each time we send money to your bank account or reverb bucks.
{
"total": 8,
"current_page": 1,
"per_page": 5,
"total_pages": 2,
"_links": {
"next": {
"href": "https://api.reverb.com/api/my/payouts?created_end_date=2017-10-30T12%3A00-00%3A00&created_start_date=2017-10-15T12%3A00-00%3A00&page=2&per_page=5"
}
},
"payouts": [
{
"total": {
"amount": "11.88",
"amount_cents": 1188,
"currency": "USD",
"symbol": "$",
"display": "$11.88"
},
"created_at": "2017-10-27T11:56:08-05:00",
"updated_at": "2017-10-30T10:46:59-05:00",
"_links": {
"line_items": {
"href": "https://api.reverb.com/api/my/payouts/54/line_items"
}
}
},
{
"total": {
"amount": "57.07",
"amount_cents": 5707,
"currency": "USD",
"symbol": "$",
"display": "$57.07"
},
"created_at": "2017-10-26T11:39:23-05:00",
"updated_at": "2017-10-30T10:46:59-05:00",
"_links": {
"line_items": {
"href": "https://api.reverb.com/api/my/payouts/52/line_items"
}
}
},
{
"total": {
"amount": "193.40",
"amount_cents": 19340,
"currency": "USD",
"symbol": "$",
"display": "$193.40"
},
"created_at": "2017-10-25T11:51:13-05:00",
"updated_at": "2017-10-30T10:46:59-05:00",
"_links": {
"line_items": {
"href": "https://api.reverb.com/api/my/payouts/51/line_items"
}
}
},
{
"total": {
"amount": "602.86",
"amount_cents": 60286,
"currency": "USD",
"symbol": "$",
"display": "$602.86"
},
"created_at": "2017-10-24T11:57:20-05:00",
"updated_at": "2017-10-30T10:46:59-05:00",
"_links": {
"line_items": {
"href": "https://api.reverb.com/api/my/payouts/48/line_items"
}
}
},
{
"total": {
"amount": "324.96",
"amount_cents": 32496,
"currency": "USD",
"symbol": "$",
"display": "$324.96"
},
"created_at": "2017-10-20T11:03:55-05:00",
"updated_at": "2017-10-30T10:46:59-05:00",
"_links": {
"line_items": {
"href": "https://api.reverb.com/api/my/payouts/47/line_items"
}
}
}
]
}By themselves, payouts do not give you much. To peek into each line item for the payout, follow the line item links.
curl -XGET -H "Authorization: Bearer [oauth_token]" -H "Content-Type: application/hal+json" https://api.reverb.com/api/my/payouts/54/line_items?per_page=5The response will contain a list of payout line item objects, which represent a the line item for each order in that payout.
{
"total": 7,
"current_page": 1,
"per_page": 5,
"total_pages": 2,
"_links": {
"next": {
"href": "https://api.reverb.com/api/my/payouts/54/line_items?page=2&per_page=5"
}
},
"payout_line_items": [
{
"order_id": 4945,
"payout_currency": "USD",
"sale_date": "2017-10-27T15:20:24-05:00",
"sale_price": {
"amount": "15.83",
"amount_cents": 1583,
"currency": "USD",
"symbol": "$",
"display": "$15.83"
},
"sale_currency": "USD",
"processing_fee": {
"amount": "0.68",
"amount_cents": 68,
"currency": "USD",
"symbol": "$",
"display": "$0.68"
},
"selling_fee": {
"amount": "0.50",
"amount_cents": 50,
"currency": "USD",
"symbol": "$",
"display": "$0.50"
},
"affirm_promotion_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"bump_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"shipping_label_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"applied_bucks": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"subtotal": {
"amount": "14.65",
"amount_cents": 1465,
"currency": "USD",
"symbol": "$",
"display": "$14.65"
},
"payout_currency_exchange_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total": {
"amount": "14.65",
"amount_cents": 1465,
"currency": "USD",
"symbol": "$",
"display": "$14.65"
},
"total_payout": {
"amount": "14.65",
"amount_cents": 1465,
"currency": "USD",
"symbol": "$",
"display": "$14.65"
},
"description": "Mi-T-Mist Mouthpiece Cleaner Economy Size"
},
{
"order_id": 4944,
"payout_currency": "USD",
"sale_date": "2017-10-27T15:20:24-05:00",
"sale_price": {
"amount": "16.24",
"amount_cents": 1624,
"currency": "USD",
"symbol": "$",
"display": "$16.24"
},
"sale_currency": "USD",
"processing_fee": {
"amount": "0.69",
"amount_cents": 69,
"currency": "USD",
"symbol": "$",
"display": "$0.69"
},
"selling_fee": {
"amount": "0.50",
"amount_cents": 50,
"currency": "USD",
"symbol": "$",
"display": "$0.50"
},
"affirm_promotion_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"bump_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"shipping_label_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"applied_bucks": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"subtotal": {
"amount": "15.05",
"amount_cents": 1505,
"currency": "USD",
"symbol": "$",
"display": "$15.05"
},
"payout_currency_exchange_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total": {
"amount": "15.05",
"amount_cents": 1505,
"currency": "USD",
"symbol": "$",
"display": "$15.05"
},
"total_payout": {
"amount": "15.05",
"amount_cents": 1505,
"currency": "USD",
"symbol": "$",
"display": "$15.05"
},
"description": "EXP11 Coated 80/20 Bronze Light Acoustic Guitar Strings Level 1"
},
{
"order_id": 4943,
"payout_currency": "USD",
"sale_date": "2017-10-27T13:51:57-05:00",
"sale_price": {
"amount": "16.46",
"amount_cents": 1646,
"currency": "USD",
"symbol": "$",
"display": "$16.46"
},
"sale_currency": "USD",
"processing_fee": {
"amount": "0.69",
"amount_cents": 69,
"currency": "USD",
"symbol": "$",
"display": "$0.69"
},
"selling_fee": {
"amount": "0.50",
"amount_cents": 50,
"currency": "USD",
"symbol": "$",
"display": "$0.50"
},
"affirm_promotion_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"bump_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"shipping_label_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"applied_bucks": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"subtotal": {
"amount": "15.27",
"amount_cents": 1527,
"currency": "USD",
"symbol": "$",
"display": "$15.27"
},
"payout_currency_exchange_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total": {
"amount": "15.27",
"amount_cents": 1527,
"currency": "USD",
"symbol": "$",
"display": "$15.27"
},
"total_payout": {
"amount": "15.27",
"amount_cents": 1527,
"currency": "USD",
"symbol": "$",
"display": "$15.27"
},
"description": "EXP11 Coated 80/20 Bronze Light Acoustic Guitar Strings Level 1"
},
{
"order_id": 4935,
"payout_currency": "USD",
"sale_date": "2017-10-27T11:58:36-05:00",
"sale_price": {
"amount": "-15.24",
"amount_cents": -1524,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"sale_currency": "USD",
"processing_fee": {
"amount": "-0.66",
"amount_cents": -66,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"selling_fee": {
"amount": "-0.50",
"amount_cents": -50,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"affirm_promotion_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"bump_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"shipping_label_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"applied_bucks": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"subtotal": {
"amount": "-14.08",
"amount_cents": -1408,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"payout_currency_exchange_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total": {
"amount": "-14.08",
"amount_cents": -1408,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total_payout": {
"amount": "-14.08",
"amount_cents": -1408,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"description": "Mi-T-Mist Mouthpiece Cleaner Economy Size"
},
{
"order_id": 4932,
"payout_currency": "USD",
"sale_date": "2017-10-27T11:40:29-05:00",
"sale_price": {
"amount": "-30.48",
"amount_cents": -3048,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"sale_currency": "USD",
"processing_fee": {
"amount": "-1.07",
"amount_cents": -107,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"selling_fee": {
"amount": "-0.50",
"amount_cents": -50,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"affirm_promotion_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"bump_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"shipping_label_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"applied_bucks": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"subtotal": {
"amount": "-28.91",
"amount_cents": -2891,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"payout_currency_exchange_fee": {
"amount": "0.00",
"amount_cents": 0,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total": {
"amount": "-28.91",
"amount_cents": -2891,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"total_payout": {
"amount": "-28.91",
"amount_cents": -2891,
"currency": "USD",
"symbol": "$",
"display": "FREE"
},
"description": "Mi-T-Mist Mouthpiece Cleaner Economy Size"
}
]
}