# ONDELIVERY



# API PICKUP OR CASHLESS

##### Update notes

2024-07-29: Update error payload for 200 (OK): Some mandatory fields are empty

##### Endpoint

<table border="1" id="bkmrk-endpoint-method-auth" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 37.4553%;"></col><col style="width: 29.2937%;"></col><col style="width: 33.3745%;"></col></colgroup><tbody><tr><td>**Endpoint**</td><td>**Method**  
</td><td>**Authentication**</td></tr><tr><td>http://apiv2.jne.co.id:10102/pickupcashless</td><td>POST</td><td>- no (test environment)

</td></tr></tbody></table>

##### Authentication

<table border="1" id="bkmrk-endpoint-method-serv" style="border-collapse: collapse; width: 100%; height: 59.757px;"><colgroup><col style="width: 29.5467%;"></col><col style="width: 45.5054%;"></col><col style="width: 24.9617%;"></col></colgroup><tbody><tr style="height: 29.8785px;"><td style="height: 29.8785px;">**Type**  
</td><td style="height: 29.8785px;">**Token source**  
</td><td style="height: 29.8785px;">**Server**  
</td></tr><tr style="height: 29.8785px;"><td style="height: 29.8785px;"> </td><td style="height: 29.8785px;"> </td><td style="height: 29.8785px;"> </td></tr></tbody></table>

##### Header

<table border="1" id="bkmrk-parameter-value-%C2%A0" style="border-collapse: collapse; width: 100%; height: 59.757px;"><colgroup><col style="width: 64.5241%;"></col><col style="width: 35.4759%;"></col></colgroup><tbody><tr style="height: 29.8785px;"><td style="height: 29.8785px;">**Parameter**  
</td><td style="height: 29.8785px;">**Value**  
</td></tr><tr style="height: 29.8785px;"><td>Content-Type  
</td><td>application/x-www-form-urlencoded  
</td></tr><tr><td>Accept  
</td><td>application/json</td></tr></tbody></table>

<p class="callout info">payload type: x-www-form-urlencoded</p>

##### Body request

```json
{
  "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" 
}
```

<table border="1" id="bkmrk-parameter-mandatory-" style="border-collapse: collapse; width: 100%;"><colgroup><col style="width: 20.0247%;"></col><col style="width: 20.0247%;"></col><col style="width: 20.0247%;"></col><col style="width: 20.0247%;"></col><col style="width: 20.0247%;"></col></colgroup><tbody><tr><th>**PARAMETER**</th><th>**MANDATORY**</th><th>**TIPE DATA**</th><th>**DESCRIPTION**</th><th>**NOTES**</th></tr><tr><td>**username**</td><td> </td><td> </td><td>YOUR USERNAME</td><td> </td></tr><tr><td>**api\_key**</td><td> </td><td> </td><td>YOUR API KEY</td><td> </td></tr><tr><td>PICKUP\_NAME</td><td>Y</td><td>VARCHAR2 (50 Byte)</td><td>Fill it with the seller pickup name</td><td> </td></tr><tr><td>PICKUP\_DATE</td><td>Y</td><td>DATE</td><td>Fill it with the pickup date (Format DD-MM-YYYY)</td><td> </td></tr><tr><td>**PICKUP\_TIME**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the pickup time (Format H24:MM)</td><td> </td></tr><tr><td>**PICKUP\_PIC**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the Contact name of pickup seller</td><td> </td></tr><tr><td>**PICKUP\_PIC\_PHONE**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the phone number of pickup seller</td><td> </td></tr><tr><td>**PICKUP\_ADDRESS**</td><td>Y</td><td>VARCHAR2 (300 Byte)</td><td>Fill it with the Address name of pickup seller</td><td> </td></tr><tr><td>**PICKUP\_DISTRICT**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the District name of pickup seller</td><td> </td></tr><tr><td>**PICKUP\_CITY**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the City name of pickup seller</td><td> </td></tr><tr><td>**PICKUP\_SERVICE**</td><td>Y</td><td>VARCHAR2 (30 Byte)</td><td>Fill it with the Service name of pickup (Value : **Domestic** or **Intracity** or **All**)</td><td> </td></tr><tr><td>**PICKUP\_VEHICLE**</td><td>Y</td><td>VARCHAR2 (100 Byte)</td><td>Fill it with the Vehicle name of pickup (Value : **Motor,** **Mobil or Truck**)</td><td> </td></tr><tr><td>**BRANCH**</td><td>Y</td><td>VARCHAR2 (6 Byte)</td><td>Fill it with the Branch of pickup seller (for testing u can fill with **CGK000**)</td><td> </td></tr><tr><td>CUST\_ID</td><td>Y</td><td>VARCHAR2 (10 Byte)</td><td>Fill it with cust id in JNE</td><td> </td></tr><tr><td>**ORDER\_ID**</td><td>Y</td><td>VARCHAR2 (20 Byte)</td><td>Fill it with the unique number in every order or goods.</td><td> </td></tr><tr><td>**SHIPPER\_NAME**</td><td>Y</td><td>VARCHAR(30 BYTE)</td><td>Value of this Parameter is Name of the Shipper</td><td> </td></tr><tr><td>**SHIPPER\_ADDR1**</td><td>Y</td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 1 of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_ADDR2**</td><td>Y</td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 2 of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_ADDR3**</td><td> </td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 3 of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_CITY**</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is City of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_ZIP**</td><td>Y</td><td>VARCHAR(5 BYTE)</td><td>Value of this Parameter is zip of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_REGION**</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Region of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_COUNTRY**</td><td> </td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Country of Shipper</td><td> </td></tr><tr><td>SHIPPER\_CONTACT</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Contact Name of Shipper</td><td> </td></tr><tr><td>**SHIPPER\_PHONE**</td><td>Y</td><td>VARCHAR(50 BYTE)</td><td>Value of this Parameter is Phone Number of Shipper</td><td> </td></tr><tr><td>**RECEIVER\_NAME**</td><td>Y</td><td>VARCHAR(30 BYTE)</td><td>Value of this Parameter is Name of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_ADDR1**</td><td>Y</td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 1 of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_ADDR2**</td><td>Y</td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 2 of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_ADDR3**</td><td> </td><td>VARCHAR(85 BYTE)</td><td>Value of this Parameter is Address 3 of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_CITY**</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is City of Receiver</td><td> </td></tr><tr><td>RECEIVER\_ZIP</td><td>Y</td><td>VARCHAR(5 BYTE)</td><td>Value of this Parameter is Zip Code of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_REGION**</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Region of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_COUNTRY**</td><td> </td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Country of Receiver</td><td> </td></tr><tr><td>RECEIVER\_CONTACT</td><td>Y</td><td>VARCHAR(20 BYTE)</td><td>Value of this Parameter is Contact Name of Receiver</td><td> </td></tr><tr><td>**RECEIVER\_PHONE**</td><td>Y</td><td>VARCHAR(50 BYTE)</td><td>Value of this Parameter is Phone of Customer</td><td> </td></tr><tr><td>**ORIGIN\_CODE**</td><td>Y</td><td>VARCHAR(10 BYTE)</td><td>Value of this Parameter is Origin Code</td><td> </td></tr><tr><td>**DESTINATION\_CODE**</td><td>Y</td><td>VARCHAR(10 Byte)</td><td>Value of this Parameter is Destination Code</td><td> </td></tr><tr><td>**SERVICE\_CODE**</td><td>Y</td><td>VARCHAR(10 BYTE)</td><td>Value of service code or name</td><td> </td></tr><tr><td>**WEIGHT**</td><td>Y</td><td>NUMBER(10,3)</td><td>Value of this Parameter is Weight of the goods</td><td> </td></tr><tr><td>**QTY**</td><td>Y</td><td>NUMBER(10,3)</td><td>Value of this Parameter is Qty of the goods</td><td> </td></tr><tr><td>**GOODS\_DESC**</td><td>Y</td><td>VARCHAR(60 BYTE)</td><td>Value of this Parameter is the goods</td><td> </td></tr><tr><td>**GOODS\_AMOUNT**</td><td>Y</td><td>NUMBER</td><td>Value of this Parameter is Amount of the goods</td><td> </td></tr><tr><td>INSURANCE\_FLAG</td><td>Y</td><td>VARCHAR(1 BYTE)</td><td>Value of this Parameter is Flag of insurance, (Fill ?Y? if it?s insurance and fill ?N? if not.)</td><td> </td></tr><tr><td>SPECIAL\_INS</td><td>Y</td><td>VARCHAR(60 Byte)</td><td>Value of this Parameter special instruction</td><td> </td></tr><tr><td>**MERCHANT\_ID**</td><td>Y</td><td>VARCHAR(100 Byte)</td><td>Fill With the Merchant or seller id</td><td> </td></tr><tr><td>**LAT**</td><td> </td><td>Varchar(60 Byte)</td><td>Fill with Lat</td><td> </td></tr><tr><td>**LON**</td><td> </td><td>Varchar(60 Byte)</td><td>Fill with Lon</td><td> </td></tr><tr><td>**TYPE**</td><td>Y</td><td>Varchar(10 Byte)</td><td>Fill with DROP or PICKUP</td><td> </td></tr><tr><td>COD\_FLAG</td><td> </td><td>Varchar (3 byte )</td><td>Fill with `YES? if the order is COD and fill with `NO? if the order is not COD</td><td> </td></tr><tr><td>COD\_AMOUNT</td><td> </td><td>Number</td><td>Fill with cod amount</td><td> </td></tr><tr><td>**AWB**</td><td> </td><td>Varchar (16 Byte)</td><td>Fill with our airwaybill number</td><td> </td></tr><tr><td>TAX\_VALUE</td><td>(khusus kiriman batam)</td><td>Number</td><td>Fill with tax amount</td><td> </td></tr><tr><td>ITEM\_TYPE</td><td>(khusus kiriman batam)</td><td>VARCHAR2 (10 Byte)</td><td>Value of this parameter is item type</td><td>1 = Eks-impor/barang dagangan, 2 = Lokal, 3 = Transit, 4 = Retur, 5 = Personal</td></tr><tr><td>HS\_CODE</td><td>(khusus kiriman batam)</td><td>VARCHAR2 (300 Byte)</td><td>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</td><td>Example : 1000000;1;4204,2000000;2;4905,3000000;3;4988</td></tr><tr><td>NPWP</td><td>(khusus kiriman batam)</td><td>VARCHAR2 (90 Byte)</td><td>Fill with npwp number</td><td> </td></tr><tr><td>RETURN\_NAME</td><td> </td><td>VARCHAR2 (30 Byte)</td><td>Filled with Return name</td><td> </td></tr><tr><td>RETURN\_ADDR1</td><td> </td><td>VARCHAR2 (30 Byte)</td><td>Filled with Return address</td><td> </td></tr><tr><td>RETURN\_ADDR2</td><td> </td><td>VARCHAR2 (30 Byte)</td><td>Filled with Return address</td><td> </td></tr><tr><td>RETURN\_ADDR3</td><td> </td><td>VARCHAR2 (30 Byte)</td><td>Filled with Return address</td><td> </td></tr><tr><td>RETURN\_CITY</td><td> </td><td>VARCHAR2 (20 Byte)</td><td>Filled with Return city</td><td> </td></tr><tr><td>RETURN\_ZIP</td><td> </td><td>VARCHAR2 (5 Byte)</td><td>Filled with Return zip</td><td> </td></tr><tr><td>RETURN\_REGION</td><td> </td><td>VARCHAR2 (20 Byte)</td><td>Filled with Return region</td><td> </td></tr><tr><td>RETURN\_COUNTRY</td><td> </td><td>VARCHAR2 (20 Byte)</td><td>Filled with Return country</td><td> </td></tr><tr><td>RETURN\_CONTACT</td><td> </td><td>VARCHAR2 (20 Byte)</td><td>Filled with Return contact</td><td> </td></tr><tr><td>RETURN\_PHONE</td><td> </td><td>VARCHAR2 (15 Byte)</td><td>Filled with Return phone</td><td> </td></tr><tr><td>RETURN\_BRANCH</td><td> </td><td>VARCHAR2 (6 Byte)</td><td>Filled with Return branch</td><td>  
</td></tr></tbody></table>

<details id="bkmrk-result-example-body-"><summary>Result example</summary>

<p class="callout info">200 (OK)</p>

```json
{
    "detail": [
        {
            "status": "success",
            "cnote_no": "0109401600067399"
        }
    ]
}
```

</details><details id="bkmrk-error-example-body-r"><summary>Error example</summary>

<p class="callout danger">200 (OK): Duplicate order id</p>

```json
{
    "detail": [
        {
            "reason": "Order id already exist, please try another one",
            "status": "Error",
            "cnote": "1234567890"
        }
    ]
}
```

<p class="callout danger"> 200 (OK): Some mandatory fields are empty</p>

```json
{
    "status": false,
    "error": "Content not confirm our security Policy."
}
```

<p class="callout danger">200 (OK): Incorrect username/API key</p>

```json
{
    "error": "Username Or API KEY Not Found.",
    "status": false
}
```

</details>