API PICKUP OR CASHLESS
Update notes
2024-07-29: Update error payload for 200 (OK): Some mandatory fields are empty
Endpoint
| Endpoint | Method |
Authentication |
| http://apiv2.jne.co.id:10102/pickupcashless | POST |
|
Authentication
| Type |
Token source |
Server |
Header
| Parameter |
Value |
| Content-Type |
application/x-www-form-urlencoded |
| Accept |
application/json |
payload type: x-www-form-urlencoded
Body request
{
"username": "TESTAPI",
"api_key": "25c898a9faea1a100859ecd9ef674548",
"PICKUP_NAME": "ARYA",
"PICKUP_DATE": "10-10-2019",
"PICKUP_TIME": "23:30",
"PICKUP_PIC": "TEAS",
"PICKUP_PIC_PHONE": "+6289100000002",
"PICKUP_ADDRESS": "JAKARTA",
"PICKUP_DISTRICT": "JAKARTA",
"PICKUP_CITY": "JAKARTA",
"PICKUP_SERVICE": "REG",
"PICKUP_VEHICLE": "MOTOR",
"BRANCH": "CGK000",
"CUST_ID": "10950700",
"ORDER_ID": "8810102030983216",
"SHIPPER_NAME": "ALI",
"SHIPPER_ADDR1": "JL. D.I PANJAITAN NO 43",
"SHIPPER_ADDR2": "JELUTUNG",
"SHIPPER_ADDR3": "JELUTUNG",
"SHIPPER_CITY": "JAMBI",
"SHIPPER_ZIP": "12345",
"SHIPPER_REGION": "JAMBI",
"SHIPPER_COUNTRY": "INDONESIA",
"SHIPPER_CONTACT": "ALI",
"SHIPPER_PHONE": "+6281234567890",
"RECEIVER_NAME": "ANA",
"RECEIVER_ADDR1": "JL SUTERA FERONIA PARK 7 ",
"RECEIVER_ADDR2": "NO 28",
"RECEIVER_ADDR3": "TANGERANG SELATAN",
"RECEIVER_CITY": "TANGERANG SELATAN",
"RECEIVER_ZIP": "54321",
"RECEIVER_REGION": "BANTEN",
"RECEIVER_COUNTRY": "INDONESIA",
"RECEIVER_CONTACT": "ANA",
"RECEIVER_PHONE": "+6285778906781",
"ORIGIN_CODE": "CGK10000",
"DESTINATION_CODE": "BDO10000",
"SERVICE_CODE": "REG",
"WEIGHT": "1",
"QTY": "1",
"GOODS_DESC": "BARANG PECAH",
"GOODS_AMOUNT": "30000",
"INSURANCE_FLAG": "0",
"SPECIAL_INS": "TEST",
"MERCHANT_ID": "TEST",
"LAT": "1",
"LON": "1",
"TYPE": "DROP",
"COD_FLAG": "NO",
"COD_AMOUNT": "37000",
"AWB": "1234567890"
}
| PARAMETER | MANDATORY | TIPE DATA | DESCRIPTION | NOTES |
|---|---|---|---|---|
| username | YOUR USERNAME | |||
| api_key | YOUR API KEY | |||
| PICKUP_NAME | Y | VARCHAR2 (50 Byte) | Fill it with the seller pickup name | |
| PICKUP_DATE | Y | DATE | Fill it with the pickup date (Format DD-MM-YYYY) | |
| PICKUP_TIME | Y | VARCHAR2 (30 Byte) | Fill it with the pickup time (Format H24:MM) | |
| PICKUP_PIC | Y | VARCHAR2 (30 Byte) | Fill it with the Contact name of pickup seller | |
| PICKUP_PIC_PHONE | Y | VARCHAR2 (30 Byte) | Fill it with the phone number of pickup seller | |
| PICKUP_ADDRESS | Y | VARCHAR2 (300 Byte) | Fill it with the Address name of pickup seller | |
| PICKUP_DISTRICT | Y | VARCHAR2 (30 Byte) | Fill it with the District name of pickup seller | |
| PICKUP_CITY | Y | VARCHAR2 (30 Byte) | Fill it with the City name of pickup seller | |
| PICKUP_SERVICE | Y | VARCHAR2 (30 Byte) | Fill it with the Service name of pickup (Value : Domestic or Intracity or All) | |
| PICKUP_VEHICLE | Y | VARCHAR2 (100 Byte) | Fill it with the Vehicle name of pickup (Value : Motor, Mobil or Truck) | |
| BRANCH | Y | VARCHAR2 (6 Byte) | Fill it with the Branch of pickup seller (for testing u can fill with CGK000) | |
| CUST_ID | Y | VARCHAR2 (10 Byte) | Fill it with cust id in JNE | |
| ORDER_ID | Y | VARCHAR2 (20 Byte) | Fill it with the unique number in every order or goods. | |
| SHIPPER_NAME | Y | VARCHAR(30 BYTE) | Value of this Parameter is Name of the Shipper | |
| SHIPPER_ADDR1 | Y | VARCHAR(85 BYTE) | Value of this Parameter is Address 1 of Shipper | |
| SHIPPER_ADDR2 | Y | VARCHAR(85 BYTE) | Value of this Parameter is Address 2 of Shipper | |
| SHIPPER_ADDR3 | VARCHAR(85 BYTE) | Value of this Parameter is Address 3 of Shipper | ||
| SHIPPER_CITY | Y | VARCHAR(20 BYTE) | Value of this Parameter is City of Shipper | |
| SHIPPER_ZIP | Y | VARCHAR(5 BYTE) | Value of this Parameter is zip of Shipper | |
| SHIPPER_REGION | Y | VARCHAR(20 BYTE) | Value of this Parameter is Region of Shipper | |
| SHIPPER_COUNTRY | VARCHAR(20 BYTE) | Value of this Parameter is Country of Shipper | ||
| SHIPPER_CONTACT | Y | VARCHAR(20 BYTE) | Value of this Parameter is Contact Name of Shipper | |
| SHIPPER_PHONE | Y | VARCHAR(50 BYTE) | Value of this Parameter is Phone Number of Shipper | |
| RECEIVER_NAME | Y | VARCHAR(30 BYTE) | Value of this Parameter is Name of Receiver | |
| RECEIVER_ADDR1 | Y | VARCHAR(85 BYTE) | Value of this Parameter is Address 1 of Receiver | |
| RECEIVER_ADDR2 | Y | VARCHAR(85 BYTE) | Value of this Parameter is Address 2 of Receiver | |
| RECEIVER_ADDR3 | VARCHAR(85 BYTE) | Value of this Parameter is Address 3 of Receiver | ||
| RECEIVER_CITY | Y | VARCHAR(20 BYTE) | Value of this Parameter is City of Receiver | |
| RECEIVER_ZIP | Y | VARCHAR(5 BYTE) | Value of this Parameter is Zip Code of Receiver | |
| RECEIVER_REGION | Y | VARCHAR(20 BYTE) | Value of this Parameter is Region of Receiver | |
| RECEIVER_COUNTRY | VARCHAR(20 BYTE) | Value of this Parameter is Country of Receiver | ||
| RECEIVER_CONTACT | Y | VARCHAR(20 BYTE) | Value of this Parameter is Contact Name of Receiver | |
| RECEIVER_PHONE | Y | VARCHAR(50 BYTE) | Value of this Parameter is Phone of Customer | |
| ORIGIN_CODE | Y | VARCHAR(10 BYTE) | Value of this Parameter is Origin Code | |
| DESTINATION_CODE | Y | VARCHAR(10 Byte) | Value of this Parameter is Destination Code | |
| SERVICE_CODE | Y | VARCHAR(10 BYTE) | Value of service code or name | |
| WEIGHT | Y | NUMBER(10,3) | Value of this Parameter is Weight of the goods | |
| QTY | Y | NUMBER(10,3) | Value of this Parameter is Qty of the goods | |
| GOODS_DESC | Y | VARCHAR(60 BYTE) | Value of this Parameter is the goods | |
| GOODS_AMOUNT | Y | NUMBER | Value of this Parameter is Amount of the goods | |
| INSURANCE_FLAG | Y | VARCHAR(1 BYTE) | Value of this Parameter is Flag of insurance, (Fill ?Y? if it?s insurance and fill ?N? if not.) | |
| SPECIAL_INS | Y | VARCHAR(60 Byte) | Value of this Parameter special instruction | |
| MERCHANT_ID | Y | VARCHAR(100 Byte) | Fill With the Merchant or seller id | |
| LAT | Varchar(60 Byte) | Fill with Lat | ||
| LON | Varchar(60 Byte) | Fill with Lon | ||
| TYPE | Y | Varchar(10 Byte) | Fill with DROP or PICKUP | |
| COD_FLAG | Varchar (3 byte ) | Fill with `YES? if the order is COD and fill with `NO? if the order is not COD | ||
| COD_AMOUNT | Number | Fill with cod amount | ||
| AWB | Varchar (16 Byte) | Fill with our airwaybill number | ||
| TAX_VALUE | (khusus kiriman batam) | Number | Fill with tax amount | |
| ITEM_TYPE | (khusus kiriman batam) | VARCHAR2 (10 Byte) | Value of this parameter is item type | 1 = Eks-impor/barang dagangan, 2 = Lokal, 3 = Transit, 4 = Retur, 5 = Personal |
| HS_CODE | (khusus kiriman batam) | VARCHAR2 (300 Byte) | Value of this parameter is hs code, qty and the goods value.the Format (Goods Value;qty;hs_code) (and using comma delimitter if more than one hs code) and maximum is five hscode for one transaction | Example : 1000000;1;4204,2000000;2;4905,3000000;3;4988 |
| NPWP | (khusus kiriman batam) | VARCHAR2 (90 Byte) | Fill with npwp number | |
| RETURN_NAME | VARCHAR2 (30 Byte) | Filled with Return name | ||
| RETURN_ADDR1 | VARCHAR2 (30 Byte) | Filled with Return address | ||
| RETURN_ADDR2 | VARCHAR2 (30 Byte) | Filled with Return address | ||
| RETURN_ADDR3 | VARCHAR2 (30 Byte) | Filled with Return address | ||
| RETURN_CITY | VARCHAR2 (20 Byte) | Filled with Return city | ||
| RETURN_ZIP | VARCHAR2 (5 Byte) | Filled with Return zip | ||
| RETURN_REGION | VARCHAR2 (20 Byte) | Filled with Return region | ||
| RETURN_COUNTRY | VARCHAR2 (20 Byte) | Filled with Return country | ||
| RETURN_CONTACT | VARCHAR2 (20 Byte) | Filled with Return contact | ||
| RETURN_PHONE | VARCHAR2 (15 Byte) | Filled with Return phone | ||
| RETURN_BRANCH | VARCHAR2 (6 Byte) | Filled with Return branch |
Result example
200 (OK)
{
"detail": [
{
"status": "success",
"cnote_no": "0109401600067399"
}
]
}
Error example
200 (OK): Duplicate order id
{
"detail": [
{
"reason": "Order id already exist, please try another one",
"status": "Error",
"cnote": "1234567890"
}
]
}
200 (OK): Some mandatory fields are empty
{
"status": false,
"error": "Content not confirm our security Policy."
}
200 (OK): Incorrect username/API key
{
"error": "Username Or API KEY Not Found.",
"status": false
}
No Comments