Skip to content

transactions.md

Latest commit

 

History

History
339 lines (299 loc) · 9.97 KB

transactions.md

File metadata and controls

339 lines (299 loc) · 9.97 KB

« Home

Bukalapak Transactions API

Bukalapak Transactions API

List Transactions

Get transactions owned by current user.

You can optionally set If-None-Match header or Etag header. If request Etag match, server will send 304 Not Modified response without body.

Server will set Etag header to every request to this resource.

  • Use GET http method.
Resource URL
Parameters
  • page (optional). Page number, default to 0.
  • per_page (optional). Number of transactions per_page, default to 10.
Example Request
curl -u 67287:lXymG93y83m6RHzZV5FY "https://api.bukalapak.com/v1/transactions.json?page=2"
Example Response
{
  "status":"OK",
  "transactions":[{
    "id":51947,
    "state":"paid",
    "unread": false,
    "transaction_id":"131203161947",
    "amount":20000,"quantity":1,
    "shipping_fee":8000,
    "total_amount":28000,
    "products":[{
      "id":1069174,
      "category":"Buku",
      "category_id":60,
      "category_structure":["Hobi & Hiburan","Buku"],
      "name":"Buku Palsu",
      "city":"Jakarta Barat",
      "province":"DKI Jakarta",
      "price":20000,"weight":"1000",
      "images":["http://www.local.host:3000/system/images/2/6/0/0/3/5/9/large/Screenshot_-_111113_-_15_47_03.png?1384836182"],
      "small_images":["http://www.local.host:3000/system/images/2/6/0/0/3/5/9/small/Screenshot_-_111113_-_15_47_03.png?1384836182"],
      "url":"http://www.local.host:3000/p/hobi-hiburan/buku/mwza-jual-buku-palsu",
      "desc":"asdasd",
      "condition":"new",
      "nego":false,
      "seller_name":"Liem Lie Wie",
      "payment_ready":true,
      "stock":49999,
      "specs":{"type":null},
      "state_description":[]
    }],
    "consignee":{
      "name":"Testing Account",
      "address":"adasd",
      "city":"Tangerang",
      "province":"Banten",
      "post_code":"12312"
    },
    "buyer":{
      "id":204254,
      "name":"Testing Account",
      "username":"testingaccount"
    },
    "seller":{
      "id":52357,
      "name":"Liem Lie Wie",
      "username":"ebenhaezernet"
    },
    "actions":["deliver","reject"],
    "created_at":"2013-12-03T16:15:40+07:00"
  }]
  ,"message":null
}

Get Transaction

Get transaction details owned by current user.

You can optionally set If-None-Match header or Etag header. If request Etag match, server will send 304 Not Modified response without body.

Server will set Etag header to every request to this resource.

  • Use GET http method.
Resource URL
Parameters
  • id (required). Identifier for transaction being read.
Example Request
curl -u 67287:lXymG93y83m6RHzZV5FY "https://api.bukalapak.com/v1/transactions/7870.json"
Example Response
{
  "status":"OK",
  "transactions":{
    "id":51947,
    "state":"paid",
    "unread": false,
    "transaction_id":"131203161947",
    "amount":20000,"quantity":1,
    "shipping_fee":8000,
    "total_amount":28000,
    "products":[{
      "id":1069174,
      "category":"Buku",
      "category_id":60,
      "category_structure":["Hobi & Hiburan","Buku"],
      "name":"Buku Palsu",
      "city":"Jakarta Barat",
      "province":"DKI Jakarta",
      "price":20000,"weight":"1000",
      "images":["http://www.local.host:3000/system/images/2/6/0/0/3/5/9/large/Screenshot_-_111113_-_15_47_03.png?1384836182"],
      "small_images":["http://www.local.host:3000/system/images/2/6/0/0/3/5/9/small/Screenshot_-_111113_-_15_47_03.png?1384836182"],
      "url":"http://www.local.host:3000/p/hobi-hiburan/buku/mwza-jual-buku-palsu",
      "desc":"asdasd",
      "condition":"new",
      "nego":false,
      "seller_name":"Liem Lie Wie",
      "payment_ready":true,
      "stock":49999,
      "specs":{"type":null},
      "state_description":[]
    }],
    "consignee":{
      "name":"Testing Account",
      "address":"adasd",
      "city":"Tangerang",
      "province":"Banten",
      "post_code":"12312"
    },
    "buyer":{
      "id":204254,
      "name":"Testing Account",
      "username":"testingaccount"
    },
    "seller":{
      "id":52357,
      "name":"Liem Lie Wie",
      "username":"ebenhaezernet"
    },
    "actions":["deliver","reject"],
    "created_at":"2013-12-03T16:15:40+07:00"
  }
  ,"message":null
}

Confirm Shipping

Confirm Shipping for Transaction

  • Use POST http method.
  • Requires authentication
Resource URL
Parameters

None

POST request data
  • payment_shipping (required). Attributes of transaction shipping confirmation in JSON. Attributes constructed by following fields:
    • transaction_id (required). Transaction ID
    • shipping_code (required). Shipping receipt code
    • new_courier (optional). Used if courier used other than JNE, TIKI, or POS
Example Request
curl -u 67287:lXymG93y83m6RHzZV5FY -d '{ "payment_shipping": { "transaction_id":"7870", "shipping_code":"1568772840123" } }' https://api.bukalapak.com/v1/transactions/confirm_shipping.json -H "Content-Type: application/json" -X POST
Example Response

Failed example

{
  "status":"ERROR",
  "id":null,
  "message": "Belum ada konfirmasi pembayaran atau konfirmasi pengiriman barang sudah dilakukan"
}

Successfull example

{
  "status":"OK",
  "id":"1315",
  "message": "Konfirmasi pengiriman barang berhasil"
}

Reject Transaction

Reject Transaction

  • Use PUT http method.
  • Requires authentication
Resource URL
Parameters

None

PUT request data
  • id (required). Transaction ID.
  • payment_rejection[reason] (required). Reason for rejecting transaction. Allowed values (case sensitive):
    • Stok Habis
    • Harga barang/biaya kirim tidak sesuai
    • Ada kesibukan lain yang sifatnya mendadak
    • Permintaan pembeli tidak dapat dilayani
Example Request
curl -u 204254:Sy7PRGGr4foUk22uzjMu -X PUT "https://api.bukalapak.com/v1/transactions/reject.json" --data "id=51943&payment_rejection[reason]=Stok habis"
Example Response

Failed example

{
  "status":"OK",
  "message":"Failed to reject"
}

Successfull example

{
  "status":"OK",
  "message":"Successfully rejected"
}

Send Feedback

Send Feeback to seller/buyer after transaction.

  • Use POST http method.
  • Requires authentication
Resource URL
Parameters

None

POST request data
  • feedback (required). Attributes of feedback. Attributes constructed by following fields:
    • body (required). Text containing feedback for current transaction
    • positive (required). Boolean value indicating seller's satisfaction toward buyer of current transaction. Possible values are true or false
Example Request
curl -u 67287:lXymG93y83m6RHzZV5FY -d '{ "feedback": { "body":"Puas dengan pembeli ini. Tidak rewel dan fast response.", "positive":"true"  } }' https://api.bukalapak.com/v1/transactions/7907/feedbacks.json -H "Content-Type: application/json" -X POST
Example Response

Failed example

{
  "status": "ERROR",
  "message": "Transaksi tidak terdaftar atau feedback sudah diberikan",
  "feedback": {}
}

Successfull example

{
  "status": "OK",
  "message": null,
  "feedback": {
    "id": 22033,
    "transaction_id": 7907,
    "sender_id": 62817,
    "sender_name": "Sayur Kangkung",
    "user_id": 31432,
    "user_name": "Khairul",
    "body": "Mantap gan",
    "positive": true,
    "created_at":"2012-10-11T17:55:34+07:00",
    "updated_at":"2012-10-11T17:55:34+07:00"
  }
}

Dictionary

  • state State of transactions. Possible values are as listed
    • pending initial state
    • addressed transaction shipping address filled
    • payment_chosen payment method have been chosen
    • confirm_payment transaction has been paid by buyer but not verified yet by Bukalapak
    • paid transaction has been paid and payment has been verified Bukalapak
    • delivered order has been shipped by seller but not received by buyer yet
    • received order has been received by buyer
    • remitted transaction has been finished and seller has been paid by Bukalapak
    • rejected transaction has been rejected by seller
    • cancelled transaction has been canceled
    • expired transaction expired
    • refunded transaction has been refunded
  • actions Actions that can be performed by current user. Possible values are
  • unread Possible values are true and false. User required to take action as in actions if this field set to true.