Skip to main content

Api Contract Komship (1.0.0)

Download OpenAPI specification:Download

This is an Api Contract for Komship project. use Token and application id to consumes endpoint. Role id partner 4

Authentication

Bearer

Security Scheme Type API Key
Header parameter name: Authorization

Auth

Everything about Auth

Login User

Request Body schema: application/json
username_email
string
password
string
login_from
string
fcm_token
string

Responses

Request samples

Content type
application/json
{
  • "username_email": "tatausaha",
  • "password": "12345678a",
  • "login_from": "website",
  • "fcm_token": "fMFJVmT_vCk:APA91bEwLh3_5dGKDFJI9M4ISZrqD9sOuN_mtYKxj85ZyaLaxo1sBIi9Iq8X5ZUieX5GyGDfkl_woikKVfJCp5j-U7MxNWDE5GlNg8E3IpnsP7GQARlsbcMsLmiM9eMD5xXYTSGXUUKS"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Log out user

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "logout successful"
}

Send link to forgot password

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Forgot passwword link has been sent to your email"
}

Update Password

query Parameters
email
required
string

get email from deep link

password
required
string

New password, 8 character minimum

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Password changed successfully"
}

Change password for authenticate user

Authorizations:
query Parameters
old_password
required
string

old password

new_password
required
string

New password, 8 character minimum

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Password changed successfully"
}

refresh-token

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Refresh Token successful",
  • "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxIiwianRpIjoiMGQyMzE4NTg0YWNmYTU4MGQxYjM1ZWM1NzczNTFlYThjYzY2ZTA4MjNhODdkMWZiODJlYjVlYWQxYTUxNzA1M2RhMjVmYTk0MGI2NzExMDEiLCJpYXQiOjE2MjczNjc3MjMsIm5iZiI6MTYyNzM2NzcyMywiZXhwIjoxNjU4OTAzNzIzLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.Swq2EdjNWL7JrRZFu1Gh9x5ZHwo7jmCioZz4Z19IQB2rTIGUDyhkds276ZzPHh-pDwkrD2uEWhceOuXrKnlOwtvJOu3Kf3VymsabIKqJpb8e4dq76FWPbUD6k-WexL7QKQan9gH1LwoQey2nMKFi5hd7_3A9sFLRrQerqh3qugWdD7RqqYS3vYY9M3VqHf108w5iQa_GHkRx2KRv0PxRVRqofkTCBBf-Oc-kcvLkau8N6BVojkYDJ8Cl8uG5XcS0F1RjbNy6SuiuTyqq1BqaZmcasi87zwJEeuJSgdqBfnNch608impEBu9q_ON1kMIgK9LZvqL8_Uk1vP5qosUq39VgJj8qbFDpCKsKus6fjO78G-zeYbZ32D-s03QwPr9FkwoZXg_HaiyTDvsbTcgH63wU-Q7ycor8IgSKPsfkJN1OytohleJMWYOObiN-IKqKGbXnf85DnJrhZuOZB9tQdoq4fIXYx68LQgmiLSVemXUbHMtRmXbYWwAIFy3QexPRGtHxK8wCzqEH-whXh66RKBy31gf1Fu9wxHHEb95U_UfYYynbbDxapwurJHzgxUswdBWDNguNoAJZslZfwVMguAmgtylFvNYzIlEWkENTk5fcTNOJsmVWDYuO-QJyWwCStB7_a7jcPFHLqcs7pwu9cvV-X1__x0BgRD6E9VBfYQg"
}

Register new user

query Parameters
full_name
required
string

full name

email
required
string

email active

password
required
string <password>

Password, 8 character minimum

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Register success."
}

Profile

User Profile

Get user by user_id

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Rekeningku

Menu Rekeningku & Pengaturan Rekening Web

List Bank Account

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Detail Bank Account

Authorizations:
path Parameters
bank_account_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Store Bank Account

Authorizations:
Request Body schema: application/json
bank_name
required
string
account_name
required
string
account_no
required
integer
note
string

Responses

Request samples

Content type
application/json
{
  • "bank_name": "BRI",
  • "account_name": "Chandra Sama",
  • "account_no": 12187837763176,
  • "note": "pngin nambah aja"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Bank Account stored successfully"
}

Store Bank Account

Authorizations:
Request Body schema: application/json
bank_name
required
string
account_name
required
string
account_no
required
integer
note
string

Responses

Request samples

Content type
application/json
{
  • "bank_name": "BRI",
  • "account_name": "Chandra Sama",
  • "account_no": 12187837763176,
  • "note": "pngin nambah aja"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Bank Account stored successfully"
}

Store Bank Account v3

Authorizations:
Request Body schema: application/json
bank_name
required
string
bank_code
required
string
account_name
required
string
account_no
required
integer
note
string

Responses

Request samples

Content type
application/json
{
  • "bank_name": "Bank Central Asia",
  • "bank_code": "BCA",
  • "account_name": "Chandra Beda",
  • "account_no": 405671231672,
  • "note": "pngin nambah aja"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 201,
  • "message": "Bank Account stored successfully"
}

Update Bank Account

Rules: every user only have 1 is_default:1

Authorizations:
path Parameters
bank_account_id
required
integer
Request Body schema: application/json
bank_name
required
string
account_name
required
string
account_no
required
integer
note
string

Responses

Request samples

Content type
application/json
{
  • "bank_name": "BRI",
  • "account_name": "Chandra Sama",
  • "account_no": 12187837763176,
  • "note": "pngin nambah aja"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Bank Account updated successfully"
}

Delete Bank Account

Rules: can't delete is_default data. Next feature => check if data already used on transactions.

Authorizations:
path Parameters
bank_account_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Bank Account deleted successfully."
}

Check Bank Available

Untuk menggunakan API ini menggunakan URL Komtim untuk menjalankannya

Request Body schema: application/json
bank_name
required
string
account_name
required
string
account_no
required
integer
user_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "bank_name": "MANDIRI",
  • "account_name": "My Bank",
  • "account_no": 1800002124512,
  • "user_id": 3262
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "not the same bank, with that input"
}

Product-web

Menu Product-web

List product

Authorizations:
query Parameters
name
string
status
integer

1=publish,0=draft

stock-from
integer
stock-to
integer
sold-from
integer
sold-to
integer
limits
integer
offset
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Detail product

Authorizations:
path Parameters
product_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Store product

Authorizations:
path Parameters
status
required
integer
Request Body schema: application/json
product_name
string
sku
string
description
string
weight
integer
weight_pbv
integer
length
integer
width
integer
height
integer
price
integer
stock
integer
flavours
string
variant_option
string
option
string

Responses

Request samples

Content type
application/json
{
  • "product_name": "Jilbab",
  • "sku": "JBB-01",
  • "description": "",
  • "weight": 100,
  • "weight_pbv": 100,
  • "length": 100,
  • "width": 100,
  • "height": 100,
  • "price": 0,
  • "stock": 0,
  • "flavours": "",
  • "variant_option": "",
  • "option": ""
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "product stored successfully."
}

Upload Product Image

Authorizations:
Request Body schema: multipart/form-data
product_id
integer
image_path
string <binary>

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

Update Upload Product Image

Authorizations:
Request Body schema: multipart/form-data
product_id
integer
image_path
string <binary>

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

Update product

Authorizations:
path Parameters
product_id
required
integer
Request Body schema: application/json
product_name
string
sku
string
description
string
weight
integer
weight_pbv
integer
length
integer
width
integer
height
integer
price
integer
stock
integer
flavours
string
variant_option
string
option
string

Responses

Request samples

Content type
application/json
{
  • "product_name": "Jilbab",
  • "sku": "JBB-01",
  • "description": "",
  • "weight": 100,
  • "weight_pbv": 100,
  • "length": 100,
  • "width": 100,
  • "height": 100,
  • "price": 0,
  • "stock": 0,
  • "flavours": "",
  • "variant_option": "",
  • "option": ""
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "product updated successfully."
}

Delete product

Authorizations:
path Parameters
product_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "product deleted successfully."
}

Check product name

Authorizations:
query Parameters
product_name
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "product not found"
}

List Filter Product

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Check product SKU

Authorizations:
query Parameters
product_sku
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "product sku not found"
}

Product-Mobile

Menu Product-Mobile

Update Multiple stock

Request Body schema: application/json
any (UpdateMultipleStock)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully update stock"
}

Address

Menu Address-web

List Address

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

List Provinces

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Detail Address

Authorizations:
path Parameters
address_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Store Address

Authorizations:
Request Body schema: application/json
address_name
required
string
zip_code
required
integer
address_detail
required
string
pic
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address_name": "string",
  • "zip_code": 0,
  • "address_detail": "string",
  • "pic": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Address stored successfully"
}

Update Address

Rules: every user only have 1 is_default:1

Authorizations:
path Parameters
address_id
required
integer
Request Body schema: application/json
address_name
required
string
zip_code
required
integer
address_detail
required
string
pic
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address_name": "string",
  • "zip_code": 0,
  • "address_detail": "string",
  • "pic": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Address updated successfully"
}

Delete Address

Rules: can't delete is_default data. Next feature => check if data already used on transactions.

Authorizations:
path Parameters
address_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Address deleted successfully."
}

Cart

Cart

List Cart

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Store Cart

Authorizations:
Request Body schema: application/json
product_id
integer
product_name
string
variant_id
integer
variant_name
string
product_price
number <double>
qty
integer
subtotal
number <double>

Responses

Request samples

Content type
application/json
{
  • "product_id": 0,
  • "product_name": "string",
  • "variant_id": 0,
  • "variant_name": "string",
  • "product_price": 0,
  • "qty": 0,
  • "subtotal": 0
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "item stored successfully."
}

Store Cart

Authorizations:
Request Body schema: application/json
Array
product_id
integer
product_name
string
variant_id
integer
variant_name
string
product_price
number <double>
qty
integer
subtotal
number <double>

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "items stored successfully.",
  • "data": {
    }
}

Update Item qty

Authorizations:
path Parameters
cart_id
required
integer
Request Body schema: application/x-www-form-urlencoded
qty
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "item updated successfully."
}

Delete Item

Authorizations:
Request Body schema: application/x-www-form-urlencoded
Array
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "items deleted successfully."
}

Delete Item in cart by user_id

Authorizations:
path Parameters
user_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "items deleted successfully."
}

Orderku

Menu Orderku

List Partner By user login

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

List Orderku by partner_id

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
start_date
string <date>

optional

end_date
string <date>

optional

customer_name
string

optional

payment_method
string
Enum: "COD" "BANK TRANSFER"

optional | leave it blank for all

is_komship
integer
Enum: 1 0

optional | leave it blank for all

is_retur
integer
Enum: 1 0

optional | leave it blank for default | 1 = Retur Dalam Perjalanan , 2 = Retur Diterima

order_status
integer
Enum: 0 1 2 3 4

optional | leave it blank for all | 0 = Diajukan 1 = Dikirim 2 = Diterima 3 = Retur 4 = Batal

order_id
integer

optional | leave it blank for all

partner_address_id
integer

optional | leave it blank for all

offset
integer

optional | leave it blank for all

limit
integer

optional | leave it blank for all

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

List Orderku by partner_id

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
start_date
string <date>

optional

end_date
string <date>

optional

customer_name
string

optional

payment_method
string
Enum: "COD" "BANK TRANSFER"

optional | leave it blank for all

is_komship
integer
Enum: 1 0

optional | leave it blank for all

order_status
integer
Enum: 0 1 2 3 4

optional | leave it blank for all | 0 = Diajukan 1 = Dikirim 2 = Diterima 3 = Retur 4 = Batal

order_id
integer

optional | leave it blank for all

partner_address_id
integer

optional | leave it blank for all

offset
integer

optional | leave it blank for all

limit
integer

optional | leave it blank for all

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

List Orderku by partner_id

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
start_date
string <date>

optional

end_date
string <date>

optional

customer_name
string

optional

payment_method
string
Enum: "COD" "BANK TRANSFER"

optional | leave it blank for all

is_komship
integer
Enum: 1 0

optional | leave it blank for all

order_status
integer
Enum: 0 1 2 3 4

optional | leave it blank for all | 0 = Diajukan 1 = Dikirim 2 = Diterima 3 = Retur 4 = Batal

order_id
integer

optional | leave it blank for all

partner_address_id
integer

optional | leave it blank for all

offset
integer

optional | leave it blank for all

limit
integer

optional | leave it blank for all

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Orderku analytics

Authorizations:
path Parameters
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Orderku detail

Authorizations:
path Parameters
partner_id
required
integer
order_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

List product By partner

Authorizations:
path Parameters
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Get Data Variant detail

Authorizations:
path Parameters
product_id
required
integer
query Parameters
variant
required
string

format [variant1, variant2]. example 'Merah, S'

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Orderku detail

Authorizations:
query Parameters
q
required
string

Nomor Order atau Nomor Resi

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Get Data destination

limit 10

Authorizations:
query Parameters
search
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Get Data origin

limit 10

Authorizations:
query Parameters
search
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Get Data customer

limit 10

Authorizations:
query Parameters
search
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Get Data customer

limit 10

Authorizations:
query Parameters
limits
required
string
search
required
string
sort_spent
required
string

ASC/DESC

sort_pcs
required
string

ASC/DESC

total_order
required
string
product_name
required
string
spentFrom
required
string
spentTo
required
string
pcsFrom
required
string
pcsTo
required
string
orderFrom
required
string
orderTo
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

calculate cost

Authorizations:
query Parameters
tariff_code
required
string
discount
required
string
shipping
required
string
Enum: "JNE" "JNT" "POS" "SICEPAT"
payment_method
required
string
Enum: "COD" "BANK TRANSFER"

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

calculate cost shipping

Authorizations:
query Parameters
discount
integer
receiver_destination
required
integer
additional_cost
required
integer
grandtotal
integer
partner_address_id
required
integer
subtotal
integer
weight
integer
partner_id
required
integer
cart
required
integer
payment_method
required
string
Enum: "COD" "BANK TRANSFER"

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Store Orderku

Authorizations:
path Parameters
partner_id
required
integer
Request Body schema: application/json
date
string <date>
tariff_code
integer
zip_code
string
subdistrict_name
string
district_name
string
city_name
string
custom_label_id
integer
tracking_sales_id
integer
is_komship
integer
partner_address_id
integer
customer_id
integer
customer_destination_id
integer
customer_name
string
customer_phone
string
is_whatsapp
integer
detail_address
string
order_notes
string
shipping
any
shipping_type
string
payment_method
any
bank
string
bank_account_name
string
bank_account_no
string
subtotal
number <double>
grandtotal
number <double>
old_grandtotal
number <double>
shipping_cost
number <double>
service_fee
number <double>
aditional_cost
number <double>
discount
number <double>
shipping_cashback
number <double>
net_profit
number <double>
cart
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "tariff_code": 0,
  • "zip_code": "string",
  • "subdistrict_name": "string",
  • "district_name": "string",
  • "city_name": "string",
  • "custom_label_id": 0,
  • "tracking_sales_id": 0,
  • "is_komship": 0,
  • "partner_address_id": 0,
  • "customer_id": 0,
  • "customer_destination_id": 0,
  • "customer_name": "string",
  • "customer_phone": "string",
  • "is_whatsapp": 0,
  • "detail_address": "string",
  • "order_notes": "string",
  • "shipping": null,
  • "shipping_type": "string",
  • "payment_method": null,
  • "bank": "string",
  • "bank_account_name": "string",
  • "bank_account_no": "string",
  • "subtotal": 0,
  • "grandtotal": 0,
  • "old_grandtotal": 0,
  • "shipping_cost": 0,
  • "service_fee": 0,
  • "aditional_cost": 0,
  • "discount": 0,
  • "shipping_cashback": 0,
  • "net_profit": 0,
  • "cart": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

Store OrderkuV2

Authorizations:
path Parameters
partner_id
required
integer
Request Body schema: application/json
date
string <date>
tariff_code
integer
subdistrict_name
string
district_name
string
city_name
string
is_komship
integer
customer_id
integer
customer_name
string
customer_phone
string
customer_destination_id
integer
tracking_sales_id
integer
detail_address
string
shipping
any
shipping_type
string
payment_method
any
bank
string
bank_account_name
string
bank_account_no
string
subtotal
number <double>
grandtotal
number <double>
shipping_cost
number <double>
service_fee
number <double>
discount
number <double>
shipping_cashback
number <double>
net_profit
number <double>
cart
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "tariff_code": 0,
  • "subdistrict_name": "string",
  • "district_name": "string",
  • "city_name": "string",
  • "is_komship": 0,
  • "customer_id": 0,
  • "customer_name": "string",
  • "customer_phone": "string",
  • "customer_destination_id": 0,
  • "tracking_sales_id": 0,
  • "detail_address": "string",
  • "shipping": null,
  • "shipping_type": "string",
  • "payment_method": null,
  • "bank": "string",
  • "bank_account_name": "string",
  • "bank_account_no": "string",
  • "subtotal": 0,
  • "grandtotal": 0,
  • "shipping_cost": 0,
  • "service_fee": 0,
  • "discount": 0,
  • "shipping_cashback": 0,
  • "net_profit": 0,
  • "cart": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

StoreOrderMass

Authorizations:
Request Body schema: application/json
options
string
data
Array of any[ items ]

Responses

Request samples

Content type
application/json
{
  • "options": "submit",
  • "data": ""
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

Check airway_bill

Authorizations:
path Parameters
no_resi
required
string
order_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Check airway_bill

Authorizations:
path Parameters
awb
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Update airway_bill

Authorizations:
path Parameters
partner_id
required
integer
order_id
required
integer
Request Body schema: multipart/form-data
airway_bill
required
string

no_resi

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "order updated successfully."
}

delete orderku

Authorizations:
path Parameters
partner_id
required
integer
order_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "order deleted successfully."
}

delete orderku

Authorizations:
path Parameters
partner_id
required
integer
order_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "order deleted successfully."
}

Metrics Retur Order tab | On Process

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
start_date
string <date>

optional

end_date
string <date>

optional

customer_name
string

optional

payment_method
string
Enum: "COD" "BANK TRANSFER"

optional | leave it blank for all

is_komship
integer
Enum: 1 0

optional | leave it blank for all

order_status
integer
Enum: 0 1 2 3 4

optional | leave it blank for all | 0 = Diajukan 1 = Dikirim 2 = Diterima 3 = Retur 4 = Batal

order_id
integer

optional | leave it blank for all

partner_address_id
integer

optional | leave it blank for all

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Metrics Retur Order tab

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
start_date
required
string <date>
end_date
required
string <date>

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Generate Print Label By Order ID

Authorizations:
Request Body schema: application/json
page
required
string
print_date
string
order_id
integer

Responses

Request samples

Content type
application/json
{
  • "page": "page_6",
  • "print_date": "2023-02-02",
  • "order_id": 277876
}

Response samples

Content type
application/json
{}

Generate Print Label By Order ID

Authorizations:
Request Body schema: application/json
page
required
string
print_date
string
order_id
integer

Responses

Request samples

Content type
application/json
{
  • "page": "page_6",
  • "print_date": "2023-02-02",
  • "order_id": 277876
}

Response samples

Content type
application/json
{}

Pickup

Menu Pickup Order

History Pickup

Authorizations:
query Parameters
page
required
integer
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

History Pickup

Authorizations:
query Parameters
page
required
integer
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

History Pickup

Authorizations:
query Parameters
page
required
integer
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Detail History Pickup

Authorizations:
path Parameters
pickup_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Detail History Pickup Order

Authorizations:
path Parameters
pickup_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Detail Pickup Order V2

Authorizations:
path Parameters
pickup_id
required
integer
query Parameters
shipping_name
string
is_print
integer

Responses

Response samples

Content type
application/json
{}

Store Pickup

Authorizations:
path Parameters
partner_id
required
integer
Request Body schema: application/json
pickup_date
string <date>
partner_name
integer
pickup_time
string <time>
pic
string
pic_phone
string
vehicle
string
address_id
integer
address_detail
string
orders
integer
token
string

Responses

Request samples

Content type
application/json
{
  • "pickup_date": "2019-08-24",
  • "partner_name": 0,
  • "pickup_time": "14:15:22Z",
  • "pic": "string",
  • "pic_phone": "string",
  • "vehicle": "string",
  • "address_id": 0,
  • "address_detail": "string",
  • "orders": 5627,
  • "token": "token123"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

Store Pickup

Authorizations:
path Parameters
partner_id
required
integer
Request Body schema: application/json
pickup_date
string <date>
partner_name
integer
pickup_time
string <time>
pic
string
pic_phone
string
vehicle
string
address_id
integer
address_detail
string
order
integer
token
string

Responses

Request samples

Content type
application/json
{
  • "pickup_date": "2019-08-24",
  • "partner_name": 0,
  • "pickup_time": "14:15:22Z",
  • "pic": "string",
  • "pic_phone": "string",
  • "vehicle": "string",
  • "address_id": 0,
  • "address_detail": "string",
  • "order": 5627,
  • "token": "token123"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

Detail Pickup List Order

Authorizations:
path Parameters
request_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

PIN

Everything about PIN

Check if user already set pin

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Check is token match

Authorizations:
Request Body schema: application/x-www-form-urlencoded
pin
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Set PIN

Authorizations:
Request Body schema: application/x-www-form-urlencoded
pin
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "PIN stored successfully."
}

Set PIN

Authorizations:
Request Body schema: application/x-www-form-urlencoded
pin
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "PIN stored successfully."
}

send otp to email

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Email Sent, Check your Inbox.",
  • "data": {
    }
}

Auth otp

Authorizations:
Request Body schema: application/x-www-form-urlencoded
otp
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "OTP is_match",
  • "data": {
    }
}

Partner-Withdrawal

Everything about partner withdrawal

warn partner before withdraw

query Parameters
withdrawal_request_nominal
required
integer

Responses

get withdraw detail

path Parameters
withdrawal_id
required
integer

Responses

get withdraw detail transaction

path Parameters
user_id
required
integer
query Parameters
withdrawal_id
required
integer
page
required
integer
total_per_page
integer

Responses

Admin-Dashboard

Dashboard for admin roles

user growth performance

Authorizations:
query Parameters
start_date
string

yyyy-mm-dd | 2022-08-01

end_date
string

yyyy-mm-dd | 2022-08-30

Responses

chart performance shipping

chart performance shipping

Authorizations:
query Parameters
month
required
string

mm | 01 - 12

shipper
required
string
Enum: "JNE" "JNT" "POS" "SICEPAT"

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

chart performance partner

chart performance partner

Authorizations:
query Parameters
month
required
string

mm | 01 - 12

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

top shipping

top shipping

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

top partner

top partner

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Perkembangan Partner

Perkembangan Partner

Authorizations:
query Parameters
start_date
required
string

Tanggal Awal Filter

end_date
required
string

Tanggal Akhir Filter

limits
required
string

default 50

order_by
required
string

OrderBy berdasarkan first_product|first_pickup|last_pickup|full_name

sort_by
required
string

Diurutkan Berdasakarna ASC/DESC

filter
required
string

Filter

start_date_pickup
required
string

Tanggal Pickup Awal Filter

end_date_pickup
required
string

Tanggal Pickup Akhir Filter

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Perkembangan Partner Juragan

Perkembangan Partner Juragan

Authorizations:
query Parameters
limits
required
integer

Limit data

offset
required
integer

offset data

pickup_date
required
string

2023-01

search
string

searching by name, email, no_hp

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Perkembangan Partner Juragan add notes

Perkembangan Partner Juragan add notes

Authorizations:
Request Body schema: application/json
partner_id
integer
notes
string

Responses

Request samples

Content type
application/json
{
  • "partner_id": 799,
  • "notes": "Partner ini tidak aktif selama satu bulan"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "success input notes."
}

Monitoring Pickup

monitoringPickup

Authorizations:
query Parameters
Search
string

search

sort
string

Sort Data | asc|desc

filter_status
string

Filter Status Default Semua | Belum Dipickup

total_per_page
string

Filter Status Default Semua

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Monitoring Pickup

monitoringPickup

Authorizations:
query Parameters
limits
integer
offset
integer
search
string

Hello ges ini search bisa search cnote dan nama

filter_shipping
string

One of these= JNE, SICEPAT, IDEXPRESS, SAP or Include all, separated by ",".

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

total ticket

total ticket

Authorizations:
query Parameters
expedition
string

JNE|SICEPAT|IDEXPRESS

start_date
required
string

2022-10-01

end_date
required
string

2022-10-30

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

total ticket

metrics reliability

Authorizations:
query Parameters
start_date
required
string

2022-10-01

end_date
required
string

2022-10-30

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Admin-Withdrawal

Withdrawal for admin roles

withdrawal-list

Data withdrawal

Authorizations:
query Parameters
search
string

where like email, fullname, bank_no | leave it blank for all

status
string
Enum: "requested" "canceled" "on_review" "completed" "rejected"

leave it blank for all

start_date
string
end_date
string
total_per_page
string

limit per page (pagination)

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

withdrawal-detail

Detail withdrawal

Authorizations:
path Parameters
withdrawal_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

withdrawal-update

Detail withdrawal

Authorizations:
path Parameters
withdrawal_id
required
integer
query Parameters
status
required
string
Enum: "canceled" "on_review" "completed" "rejected"
Request Body schema: multipart/form-data
notes
string <text>

used on button review

transfer_proof
string <binary>

used on button tranfer manual

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Withdrawal successfully updated.",
  • "data": { }
}

withdrawal-update-v2

Detail withdrawal

Authorizations:
path Parameters
withdrawal_id
required
integer
query Parameters
status
required
string
Enum: "canceled" "on_review" "completed" "rejected"
Request Body schema: multipart/form-data
notes
string <text>

used on button review

transfer_proof
string <binary>

used on button tranfer manual

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Withdrawal successfully updated.",
  • "data": { }
}

checking withdrawal detail for admin

path Parameters
withdrawal_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

checking withdrawal detail transaction history of partner for admin

path Parameters
user_id
required
integer
query Parameters
page
integer
total_per_page
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "partner_id": 201,
  • "data": {
    }
}

Admin-Pendapatan

Pendapatan for admin roles

Pendapatan

Pendapatan

Authorizations:
query Parameters
start_date
required
string <date>
end_date
required
string <date>
shipping
required
string
Enum: "JNE" "JNT" "POS" "SICEPAT"
payment_method
string
Enum: "COD" "BANK TRANSFER"

leave it blank for all transactions

sort
string
Enum: "ASC" "DESC"

leave it blank for no sort

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Admin-MonitoringFakeUser

Monotiring user with problem percentage higher than 50%

get all user problem with problem over 50 percent

query Parameters
limits
integer
offset
integer
name_email
string
filter
integer

1=fake, 2=hold, 3=unhold

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "success fetching data.",
  • "data": [
    ]
}

Card Risk Review

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

get all user problem with problem over 50 percent

Request Body schema: application/json
partner_id
integer
status
integer

Responses

Request samples

Content type
application/json
{
  • "partner_id": 201,
  • "status": "1=fake, 2=hold, 3=unhold"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": ""
}

Partner-Dashboard

Dashboard for partner roles

Summary Balance

Authorizations:
query Parameters
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get summary balance",
  • "data": {
    }
}

Summary Earned Cashback

Authorizations:
query Parameters
partner_id
integer

leave blank to get default from bearer

start_date
string
end_date
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get summary cashback",
  • "data": {
    }
}

Summary Order

Authorizations:
query Parameters
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get order balance",
  • "data": {
    }
}

Top Admin Order

Authorizations:
query Parameters
partner_id
required
integer
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get top admin order",
  • "data": [
    ]
}

Top customer Loyal

Authorizations:
query Parameters
partner_id
required
integer
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get customer loyal",
  • "data": [
    ]
}

Chart performa customer service

Authorizations:
query Parameters
partner_id
required
integer
start_date
required
string <date>
end_date
required
string <date>

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success get chart customer-service",
  • "data": {
    }
}

bestSellerProduct

Authorizations:
query Parameters
start_date
required
string <date>
end_date
required
string <date>
limit
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Succes get best seller products",
  • "data": [
    ]
}

Admin-Shipment

Admin Setting Shipment

Get Data island

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Admin shipment

Admin shipment

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Admin shipment detail

Admin shipment detail

Authorizations:
path Parameters
shipping_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Admin shipment store

Admin shipment store

Authorizations:
Request Body schema: application/json
object (shipment-post)

Responses

Request samples

Content type
application/json
{
  • "shipping_name": "JNE",
  • "service_name": "REG",
  • "cashback_from": 2.8,
  • "service_fee_from": 2.5,
  • "service_fee_to": 25,
  • "cashback_to": 25,
  • "max_pickup_time": "15:00",
  • "vehicles": [
    ],
  • "criterias": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Shipment stored successfully"
}

Admin shipment update

Admin shipment update

Authorizations:
path Parameters
shipping_id
required
integer
Request Body schema: application/json
object (shipment-post)

Responses

Request samples

Content type
application/json
{
  • "shipping_name": "JNE",
  • "service_name": "REG",
  • "cashback_from": 2.8,
  • "service_fee_from": 2.5,
  • "service_fee_to": 25,
  • "cashback_to": 25,
  • "max_pickup_time": "15:00",
  • "vehicles": [
    ],
  • "criterias": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Shipment updated successfully"
}

Get Data destination which not available for cod service

limit 10

Authorizations:
query Parameters
district_name
string
zip_code
string
city_name
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Import data from excel/csv format

limit 10

Authorizations:
Request Body schema: multipart/form-data
files
required
string <binary>

Allowed file .csv, .xls, .xlsx

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "File imported to temporary successfully"
}

Store Imported data to no-cod

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "Data stored successfully"
}

delete no-cod by zip_code

Authorizations:
path Parameters
zip_code
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "Data deleted successfully"
}

delete tmp import

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "Data deleted successfully"
}

Partner-Shipment

Partner Setting Shipment

Partner shipment

Partner shipment

Authorizations:
query Parameters
is_komship
integer
Enum: 1 0

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Partner shipment update

Partner shipment update

Authorizations:
path Parameters
shipping_id
required
integer
Request Body schema: application/json
object (partner-shipment)

Responses

Request samples

Content type
application/json
{
  • "shipping_name": "JNE",
  • "is_komship": 0,
  • "partner_id": 201,
  • "is_active": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Shipment updated successfully"
}

Komboard

Komerce Keyboard

Get Data Orderku by awb

limit 10

Authorizations:
query Parameters
search
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Bulk Check airway_bill

Authorizations:
Request Body schema: application/json
any

Responses

Request samples

Content type
application/json
"4808012000000159, 4808012000000157, 4808012000000158"

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Partner Feature

All about Partner Feature

Get Customer Reputation

query Parameters
customer_phone
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Setting Customer Reputation

query Parameters
is_customer_reputation
required
integer

Active 1, Nonactive 0

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Succesfuly setting feature customer reputation"
}

Setting Tracking Sales

Seeting Tracking Sales

Request Body schema: application/json
is_tracking_sale
integer

Responses

Request samples

Content type
application/json
{
  • "is_tracking_sale": 1
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Update Feature Tracking Sales!"
}

Store Tracking Sales

Store Tracking Sales

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Admin Satu"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Store Tracking Sales!"
}

Update Tracking Sales

Update Tracking Sales

path Parameters
tracking_sales_id
required
integer
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Admin Satu"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Update Tracking Sales!"
}

Delete Tracking Sales

Delete Tracking Sales

path Parameters
tracking_sales_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Delete Tracking Sales!"
}

List Tracking Sales

List Tracking Sales

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully get list tracking sales",
  • "data": [
    ]
}

Activate whatsapp notification free

Activate whatsapp notification free

Request Body schema: multipart/form-data
is_nofitication_whatsapp
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Activation"
}

notification whatsapp fee

notification whatsapp fee

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

check whatsapp

check whatsapp

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully get data whatsapp premium",
  • "data": {
    }
}

renew whatsapp fee

renew whatsapp fee

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

list whatsapp server

list whatsapp server

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

notification whatsapp fee Dashboard

notification whatsapp fee Dashboard

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

notification whatsapp custom message

notification whatsapp custom message

Request Body schema: multipart/form-data
is_template
required
string
message
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "Successfully Custom Template Mesasge!"
}

notification whatsapp logout

notification whatsapp logout

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success Logout Whatsapp!"
}

renew whatsapp subscription

renew whatsapp subscription

Request Body schema: multipart/form-data
is_renew
required
integer
subscription_fees
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success Renew Whatsapp Subscription!"
}

Activate whatsapp notification free

Activate whatsapp notification Premium

Request Body schema: multipart/form-data
is_subscribe
required
integer
subscription_fees
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Activation",
  • "data": {
    }
}

whatsapp notification get qrcode

whatsapp notofication qrcode

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

whatsapp on or off template whatsapp

on or off template whatsapp

Request Body schema: multipart/form-data
type_notification
required
integer
status
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "Success on custom message whatsapp premium!"
}

demo send notification whatsapp

demo send notification whatsapp

Request Body schema: multipart/form-data
message
required
string
no_whatsapp
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": "message successfully sent"
}

Add Number Whatsapp

Add Number Whatsapp

Request Body schema: multipart/form-data
phone_number
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully add number!"
}

Check Number whatsapp

check number whatsapp

query Parameters
phone_number
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "successfully check number exist!",
  • "data": {
    }
}

Ticketing Partner

All about Ticketing Partner

Create Ticket Partner With Support CDN

Authorizations:
Request Body schema: multipart/form-data
no_resi
string
partner_name
string
ticket_type
string
description
string
file[]
string <binary>

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

Upload File Ticket Partner Chat With Support CDN

Authorizations:
Request Body schema: multipart/form-data
ticket_id
string
message
string
file[]
string <binary>

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

/api/v2/ticket-partner/detail/{id}

Authorizations:
path Parameters
id
required
integer

Responses

Tiketing Admin

All about Tickets Admin

Get claim retur information

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success fetch data.",
  • "data": {
    }
}

Customer

All about Customer

Get Growth Customer

All about Growth contact

query Parameters
filter
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Export Growth Contact

All about Growth contact

Responses

Response samples

Content type
application/json
"base64"

Get List Customers

All about Growth contact

query Parameters
search
string
sort_spent
string

ASC/DESC

sort_pcs
string

ASC/DESC

total_order
string
product_name
string
spentFrom
string
spentTo
string
pcsFrom
string
pcsTo
string
orderFrom
string
orderTo
string
province_name
string

Responses

Response samples

Content type
application/json
{}

Gamifaction

All about Gamifaction

Get Gamifaction List

All about Gamifaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

start Gamifacton

All about Gamifaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Start Gamifaction"
}

Claim Gamifaction

All about Gamifaction

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully complete gamification!"
}

Partner-Transaction

All about Partner Transaction

Claim Gamifaction

All about Partner Transaction

query Parameters
partner_id
required
string
start_date
string
end_date
string
page
string
limits
string
search
string
filter
string

0=semua, 1=orderan cod diterima,2=ongkir noncod,3=ongkir noncod batal, 4=tarik saldo, 5=topup saldo, 6=retur cod, 7=claim retur diterima, 8=ganti rugi paket hilang,9=ganti rugi paket rusak,10=belanja talent 11=pengembalian dana komtim. example=1,2,3,4,5

Responses

Response samples

Content type
application/json
{}

PrintTransactionBalance

All about Partner Transaction

query Parameters
start_date
required
string
end_date
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Export data transaction balance!",
  • "data": "base64"
}

Send-OTP-Whatsapp

All about Send OTP Whatsapp

Send OTP Whatsapp

All about Send OTP Whatsapp

Request Body schema: application/json
no_hp
required
integer

Responses

Request samples

Content type
application/json
{
  • "no_hp": 85229931237
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully sent otp to whatsapp!",
  • "data": {
    }
}

Check OTP Whatsapp

All about Check OTP Whatsapp

Request Body schema: application/json
otp
required
integer

Responses

Request samples

Content type
application/json
{
  • "otp": 321345
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "the otp entered is the same"
}

Feature

All about Feature

Return Insight V2

Feature Return Insight

query Parameters
destination_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Admin-Metrics Financial

all about matrics financial

get all data CPR

query Parameters
start_date
required
string
end_date
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

update data CPR

Request Body schema: multipart/form-data
id
required
integer
cost
required
integer

Responses

get all data metrics kunci

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Notification

All Aabout Notification

NOTIFICATION LIST

Responses

Notification

Read Notification

Authorizations:
path Parameters
notification_id
required
integer

Responses

Otp-Email

All Aabout Otp Email

Notification

Otp Check Email

Authorizations:
query Parameters
otp
integer

Responses

Notification

update phone number Otp

Authorizations:
query Parameters
phone_number
integer

Responses

Notification

update email Otp

Authorizations:
query Parameters
email
integer

Responses

Notification

Check Activity

Authorizations:
query Parameters
activity
string
email
string

Responses

Notification

Send Otp Email

Authorizations:
query Parameters
activity
string
email
string

Responses

Warehouse

All Aabout Warehouse

Warehouse

Data Warehouse PIckup

Authorizations:

Responses

Monitoring Mitra

All about monitoring in mitras side

Monitoring Pickup mitra

monitoringPickup

Authorizations:
query Parameters
limits
integer
offset
integer
search
string

Hello ges ini search bisa search cnote dan nama

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Partner Badge

All about partner badge

Get partner Badge

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success fetch data.",
  • "data": {}
}

Partner Mobile

All about partner mobile

calculate cost shipping

Authorizations:
query Parameters
shipper_destination
required
integer
receiver_destination
required
integer
weight
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {}
}

Dashboard Partner

All about dashboard partner

dashboardPartnerTrackingSales

dashboardPartnerTrackingSales

Authorizations:
query Parameters
filter
string

1/2 tidak kirim filter = lifetime

Responses

settingDashboardPartnerTrackingSales

settingDashboardPartnerTrackingSales

Authorizations:
query Parameters
is_dashboard
required
string

1/2 untuk on off

Responses

settingqIsShippingCost

settinggIsShippingCost

Authorizations:
query Parameters
is_shipping_cost
required
string

0/1 untuk on off

Responses

Landingpage

All about landingpage

Get Data destination

limit 20

query Parameters
search
required
string
is_no_subdist
string

1 = true, 0 = false. Not required

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Notification Bar

All about Notification Bar

adminlistNotificationBar

adminlistNotificationBar

Authorizations:
query Parameters
status
integer

1 = Aktif , 0 = Nonaktif, Blank for All

Responses

partnerlistNotificationBar

partnerlistNotificationBar

Authorizations:

Responses

storeNotificationBar

storeNotificationBar

Authorizations:
Request Body schema: application/json
id
integer
title
string
desc
string
color
string
link
string
status
string
service_type
string
action
string

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "title": "Hallo Gaes",
  • "desc": "lOREM IPSUM IS DOLOR AMET",
  • "color": "#FFFF",
  • "link": "youtube.com",
  • "status": "1",
  • "service_type": "",
  • "action": "submit"
}

Partner Claim Retur

All about Notification Bar

StoreClaimReturPartner

store claim retur partner

path Parameters
ticket_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfuly store Claim Retur",
  • "data": ""
}

UploadImageClaimReturPartner

upload image claim retur partner

Request Body schema: multipart/form-data
file
required
string <binary>
claim_retur_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Claim Retur!",
  • "data": ""
}

DeleteImageClaimReturPartner

delete image claim retur partner

path Parameters
image_temp_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Success Delete Claim Retur Image"
}

UpdateClaimReturPartner

update image claim retur partner

path Parameters
ticket_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Claim Retur!!"
}

Order Massal

All about Order Massal

Calculate Order Massal

All about Order Massal

query Parameters
zip_code
required
string
address
required
string
weight
required
string
payment_method
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Kritik Saran

All about kritik dan saran

Update Read Inbox Partners

Update data read inbox partners

Authorizations:
Request Body schema: application/json

feedback value accept only 1,2,3,4,5

feedback_value
integer

accept only (1,2,3,4,5)

feedback_comment
string

Responses

Request samples

Content type
application/json
{
  • "feedback_value": 1,
  • "feedback_comment": "yok semangat lagi yok"
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Store Feedback",
  • "data": "string"
}

Utils

Check registered number on whatsapp

use dev.whatsapp-service.komerce.my.id

Authorizations:
query Parameters
nohp
required
integer

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": {
    }
}

Send a messages to a number on whatsapp

use dev.whatsapp-service.komerce.my.id

Authorizations:
query Parameters
nohp
required
integer
message
required
integer

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "data": { }
}

Orderku - Kompacked

Store OrderkuV3

Authorizations:
path Parameters
partner_id
required
integer
Request Body schema: application/json
date
string <date>
tariff_code
integer
subdistrict_name
string
district_name
string
city_name
string
is_komship
integer
is_kompack
integer
warehouse_id
integer
customer_id
integer
customer_name
string
customer_phone
string
customer_destination_id
integer
tracking_sales_id
integer
detail_address
string
partner_address_id
integer
shipping
any
shipping_type
string
payment_method
any
bank
string
bank_account_name
string
bank_account_no
string
subtotal
number <double>
grandtotal
number <double>
shipping_cost
number <double>
service_fee
number <double>
discount
number <double>
shipping_cashback
number <double>
net_profit
number <double>
order_notes
string
cart
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "date": "2019-08-24",
  • "tariff_code": 0,
  • "subdistrict_name": "string",
  • "district_name": "string",
  • "city_name": "string",
  • "is_komship": 0,
  • "is_kompack": 0,
  • "warehouse_id": 0,
  • "customer_id": 0,
  • "customer_name": "string",
  • "customer_phone": "string",
  • "customer_destination_id": 0,
  • "tracking_sales_id": 0,
  • "detail_address": "string",
  • "partner_address_id": 0,
  • "shipping": null,
  • "shipping_type": "string",
  • "payment_method": null,
  • "bank": "string",
  • "bank_account_name": "string",
  • "bank_account_no": "string",
  • "subtotal": 0,
  • "grandtotal": 0,
  • "shipping_cost": 0,
  • "service_fee": 0,
  • "discount": 0,
  • "shipping_cashback": 0,
  • "net_profit": 0,
  • "order_notes": "string",
  • "cart": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Order stored successfully"
}

options address on store order v3

Ada 2 jenis warheouse_type, ["Private Warehouse", "Mitra Kompack"], jika yang dipilih adalah Mitra Kompack, kirim warehouse_id sebagai parameter di PARTNER-PRODUCT

Authorizations:
query Parameters
partner_id
required
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

options address on store order v3

Ada 2 jenis warheouse_type, ["Private Warehouse", "Mitra Kompack"], jika yang dipilih adalah Mitra Kompack, kirim warehouse_id sebagai parameter di PARTNER-PRODUCT

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
warehouse_type
required
string

decide product origin , it is from mitra warehouse or private warehouse (all). Value : Mitra Kompack / Private Warehouse

warehouse_id
integer

its a conditional requirity, if warehouse_type is "Mitra Kompack" its become required

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

options address on store order v3

Ada 2 jenis warheouse_type, ["Private Warehouse", "Mitra Kompack"], jika yang dipilih adalah Mitra Kompack, kirim warehouse_id sebagai parameter di PARTNER-PRODUCT

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
search
string

search product name, jika search kosong maka hanya akan menampilkan 5 product terupdate saja

warehouse_type
required
string

decide product origin , it is from mitra warehouse or private warehouse (all). Value : Mitra Kompack / Private Warehouse

warehouse_id
integer

its a conditional requirity, if warehouse_type is "Mitra Kompack" its become required

limit
integer
offset
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Ticketing Admin

Get Ticket List

All about Tickets Admin

query Parameters
start_date
string
end_date
string
search_key
string

customer_name / no_resi / no_ticket

search
string
ticket_status
integer

0 / 1

sort_customer
string

DESC / ASC

sort_type_ticket
string

DESC / ASC

sort_ticket_status
string

DESC / ASC

sort_ticket_created
string

DESC / ASC

sort_ticket_updated
string

DESC / ASC

Responses

Response samples

Content type
application/json
{}

Admin Analityc - Retur Insight

Export Excel Retur Insight

Export Excel Retur Insight Admin

path Parameters
type
required
string

jne / idexpress/ sicepat

query Parameters
year
required
string
month
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200
}

Ticketing Mitra

Get Ticket List

All about Tickets Mitra

query Parameters
search
string
start_date
string
end_date
string
ticket_status
integer

0 / 1

ticket_type
integer
shipping
string
unread
boolean
prioritas
string

Responses

Response samples

Content type
application/json
{}

Get Ticket List package return

All about Tickets Mitra

query Parameters
status
integer
limit
integer
offset
integer
priority
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Create Ticket Mitra With Support CDN

Authorizations:
Request Body schema: multipart/form-data
no_resi
string
partner_name
string
ticket_type
string
description
string
file[]
string <binary>
brand_name
string

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

Upload File Ticket Mitra Chat With Support CDN

Authorizations:
Request Body schema: multipart/form-data
ticket_id
string
message
string
file[]
string <binary>
ticket_status
string

The image file to upload.

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Upload Image Product"
}

Partner - Draft Order

get List draft order

List Draft Order

query Parameters
search
string
start_date
string
end_date
string
address_id
integer
product_id
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

get List draft order detail

get Draft Order

path Parameters
draft_id
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Select Option Addresse draft order

Select Option Addresses Draft Order

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Select Option Product draft order

Select Option Products Draft Order

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Store draft order

Store Draft Order

Request Body schema: application/json
date
string
address_id
integer
customer_name
string
customer_phone
string
destination_id
integer
customer_address
string
cart
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "date": "2022-01-22",
  • "address_id": 22,
  • "customer_name": "Bagus Condro Budi",
  • "customer_phone": "0822377398712",
  • "destination_id": 123,
  • "customer_address": "Bobotsari, asokwopkowkowkwokwo",
  • "cart": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully add draft order"
}

Edit draft order

Edit Draft Order

path Parameters
draft_id
required
integer
Request Body schema: application/json
date
string
address_id
integer
customer_name
string
customer_phone
string
destination_id
integer
customer_address
string
cart
Array of integers[ items ]

Responses

Request samples

Content type
application/json
{
  • "date": "2022-01-22",
  • "address_id": 22,
  • "customer_name": "Bagus Condro Budi",
  • "customer_phone": "0822377398712",
  • "destination_id": 123,
  • "customer_address": "Bobotsari, asokwopkowkowkwokwo",
  • "cart": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully edit draft order"
}

Orderku - Count Card Mobile

Count total Order By Status

Authorizations:
path Parameters
partner_id
required
integer
query Parameters
product_id
integer
search
string
start_date
string
end_date
string
partner_address_id
integer
payment_method
integer

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

OTP-SMS V2

SMS - SEND OTP

query Parameters
phone_number
string
session
string

Page PIN = pin , Page Rekening = rekening

activity
string

Page Rekening = BANK ACCOUNT, else null

Responses

SMS - VERIFY OTP

query Parameters
otp
integer
session
string

Page PIN = pin , Page Rekening = rekening

Responses

Landingpage`

landingpageCalculate

Landingpage Calculate

Authorizations:
query Parameters
shipper_destination
string

17480

receiver_destination
string

4817

weight
string

1

Responses

Komail-Komship

For BE, monthly schedule that will run on jobs

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Mail create success"
}

Fetch Inbox Partners

Fetch data inbox partners

Authorizations:

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": [
    ]
}

Fetch Inbox Partners

Fetch data inbox partners

Authorizations:
path Parameters
inbox_id
required
integer

id of mails from inbox list partners

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "data": {
    }
}

Update Read Inbox Partners

Update data read inbox partners

Authorizations:
path Parameters
inbox_id
required
integer

id of mails from inbox list partners

Responses

Response samples

Content type
application/json
{
  • "status": "success",
  • "code": 200,
  • "message": "Successfully Update Read Mail",
  • "data": "string"
}