Skip to content

Instantly share code, notes, and snippets.

@syahrasi
Created October 21, 2016 05:28
Show Gist options
  • Save syahrasi/44c094e113f5e5c52535f044b032bde0 to your computer and use it in GitHub Desktop.
Save syahrasi/44c094e113f5e5c52535f044b032bde0 to your computer and use it in GitHub Desktop.
Dokumentasi API

Dokumentasi API dan contoh

0. Push Product (Add force as optional parameter )

HTTP Request

PATCH https://api.bukalapak.com/v2/products/:id/push.json

Parameters

Parameters Description
id required id dari produk yang ingin dipush (base36)
force optional Jika bernilai "1", akan menggunakan saldo BukaDompet jika Paket Push tidak mencukupi untuk melakukan push. Jika bernilai "0", tidak akan menggunakan saldo BukaDompet jika Paket Push tidak mencukupi untuk melakukan push.

Result

Parameters Description
status OK Jika produk berhasil di-push. ERROR Jika tidak berhasil di-push
can_push Bernilai true jika user bersangkutan masih dapat melakukan push, dan false jika sebaliknya
remaining_push Sisa paket push yang masih tersedia
push_price Harga untuk melakukan satu kali push
deposit Saldo Bukadompet user
message Pesan response dari server

Example

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/products/xxx/push.json -X PATCH -d '{"force": "0"}' -H "Content-Type: application/json"
{
	"status":"OK",
	"can_push":true,
	"remaining_push":0,
	"deposit":0,
	"push_price":500,
	"message":"Barang telah berhasil di-push"
}

1. Bulk Push

HTTP Request

PATCH https://api.bukalapak.com/v2/products/bulk_push.json

Parameters

Parameters Description
products_id required id dari produk-produk yang ingin dipush (base36) berupa array
force optional Jika bernilai "1", akan menggunakan saldo BukaDompet jika Paket Push tidak mencukupi untuk melakukan push. Jika bernilai "0", tidak akan menggunakan saldo BukaDompet jika Paket Push tidak mencukupi untuk melakukan push.

Result

Parameters Description
status OK Jika ada satu/lebih produk yang berhasil di-push. ERROR Jika tidak ada produk yang berhasil di-push
can_push Bernilai true jika user bersangkutan masih dapat melakukan push, dan false jika sebaliknya
remaining_push Sisa paket push yang masih tersedia
message Pesan response dari server
push_price Harga untuk melakukan satu kali push
deposit Saldo Bukadompet user
success Array of id produk yang berhasil di-push
fail Array of id produk yang gagal di-push

Example

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/products/bulk_push.json 
	-X PATCH 
	-d '{"products_id":["s","u","t","a","b","c"], "force":"0"}' 
	-H "Content-Type: application/json"
{
	"status":"OK",
	"can_push":true,
	"remaining_push":0,
	"message":"Barang berhasil di-push semuanya",
	"deposit":0,
	"push_price":500,
	"success":["s","u","t","a","b","c"],
	"fail":[]
}

2. Bulk Set Unavailable

HTTP Request

PATCH https://api.bukalapak.com/v2/products/bulk_set_unavailable.json

Parameters

Parameters Description
products_id required id dari produk-produk yang ingin di-set unavailable (base36) berupa array

Result

Parameters Description
status OK Jika ada satu/lebih produk yang berhasil di-set unavailable. ERROR Jika tidak ada produk yang berhasil di-set unavailable
message Pesan response dari server
success Array of id produk yang berhasil di-set unavailable
fail Array of id produk yang gagal di-set unavailable

Example

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/products/bulk_set_unavailable.json -X PATCH -d '{"products_id":["s","u","t","a","b","c"]}' -H "Content-Type: application/json"
{
	"status":"OK",
	"message":"Barang berhasil di-set unavailable semuanya",
	"success":["s","u","t","a","b","c"],
	"fail":[]
}

3. Bulk Set Available

HTTP Request

PATCH https://api.bukalapak.com/v2/products/bulk_set_available.json

Parameters

Parameters Description
products_id required id dari produk-produk yang ingin di-set available (base36) berupa array

Result

Parameters Description
status OK Jika ada satu/lebih produk yang berhasil di-set available. ERROR Jika tidak ada produk yang berhasil di-set available
message Pesan response dari server
success Array of id produk yang berhasil di-set available
fail Array of id produk yang gagal di-set available

Example

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/products/bulk_set_available.json -X PATCH -d '{"products_id":["s","u","t","a","b","c"]}' -H "Content-Type: application/json"
{
	"status":"OK",
	"message":"Barang berhasil di-set available semuanya",
	"success":["s","u","t","a","b","c"],
	"fail":[]
}

4. Bulk Bookmark (Set Favorite)

HTTP Request

PATCH https://api.bukalapak.com/v2/favorites/bulk_add.json

Parameters

Parameters Description
products_id required id dari produk-produk yang ingin di-set favorite (base36) berupa array

Result

Parameters Description
status OK Jika ada satu/lebih produk yang berhasil di-set favorite. ERROR Jika tidak ada produk yang berhasil di-set favorite
message Pesan response dari server
success Array of id produk yang berhasil di-set favorite
fail Array of id produk yang gagal di-set favorite

Example

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/favorites/bulk_add.json -X POST -d '{"products_id":["s","u","t","a","b","c"]}' -H "Content-Type: application/json"

Example

{
	"status":"OK",
	"message":"Barang berhasil di-set favorite semuanya",
	"success":["s","u","t","a","b","c"],
	"fail":[]
}

5. Bulk Unbookmark (Set Unfavorite)

HTTP Request

DELETE https://api.bukalapak.com/v2/favorites/bulk_remove.json

Parameters

Parameters Description
products_id required id dari produk-produk yang ingin di-unset favorite (base36) berupa array

Result

Parameters Description
status OK Jika ada satu/lebih produk yang berhasil di-unset favorite. ERROR Jika tidak ada produk yang berhasil di-unset favorite
message Pesan response dari server
success Array of id produk yang berhasil di-unset favorite
fail Array of id produk yang gagal di-unset favorite

Request

curl -u 7:znn36aVeGrtJ2K9Vev6 https://api.bukalapak.com/v2/favorites/bulk_remove.json -X DELETE -d '{"products_id":["s","u","t","a","b","c"]}' -H "Content-Type: application/json"

Response

{
	"status":"OK",
	"message":"Barang berhasil di-unset favorite semuanya",
	"success":["s","u","t","a","b","c"],
	"fail":[]
}

#5049

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment