RajaOngkir API Documentation

https://rajaongkir.com/dokumentasi
Admin
RajaOngkir provides a RESTful API for developers to integrate shipping cost data and related...
Tokens:4,449
Snippets:7
Trust Score:8.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### RajaOngkir City API

Source: https://rajaongkir.com/dokumentasi/starter

Retrieves a list of cities and regencies in Indonesia. This endpoint allows fetching city data, optionally filtered by province ID or city ID. It requires an API key for authentication.

```APIDOC
City API Documentation:

Method: GET
URL: https://api.rajaongkir.com/starter/city

Parameters:
  - key (String, Required): Your RajaOngkir API Key.
  - android-key (String, Optional): Identifier for Android applications.
  - ios-key (String, Optional): Identifier for iOS applications.
  - id (String, Optional): The ID of the city/regency to retrieve.
  - province (String, Optional): The ID of the province to filter cities by.

Notes:
  - If both 'id' and 'province' are omitted, all cities/regencies are returned.
  - 'android-key' is required if Android referrer is enabled.
  - 'ios-key' is required if iOS referrer is enabled.

Response Structure (Success):
  - key: String (API Key)
  - status: Object
    - code: Integer (Status code, e.g., 200)
    - description: String (Description of the status)
  - results: Array of City Objects
    - id: String (City/Regency ID)
    - city_id: String (City/Regency ID, redundant with id)
    - province_id: String (Province ID the city belongs to)
    - province: String (Name of the province)
    - type: String (Type of area, e.g., "Kota" or "Kabupaten")
    - city_name: String (Name of the city/regency)
    - postal_code: String (Postal code for the city/regency)

Example Response Snippet:
{
  "key": "YOUR_API_KEY",
  "status": {
    "code": 200,
    "description": "OK"
  },
  "results": [
    {
      "id": "1",
      "city_id": "1",
      "province_id": "1",
      "province": "Bali",
      "type": "Kota",
      "city_name": "Denpasar",
      "postal_code": "80221"
    },
    ...
  ]
}
```

--------------------------------

### RajaOngkir Currency API

Source: https://rajaongkir.com/dokumentasi/pro

Retrieves current currency exchange rates, specifically the value of Indonesian Rupiah against the US Dollar. Requires an API key for authentication. The response includes the exchange rate, update timestamp, and data source information.

```APIDOC
Currency API Documentation:

Method: GET
URL: https://pro.rajaongkir.com/api/currency

Parameters:
  key (String, Required): Your RajaOngkir API Key.
  android-key (String, Optional): Identifier for Android application.
  ios-key (String, Optional): Identifier for iOS application.

Notes:
  - 'android-key' is required if using for Android app referrers.
  - 'ios-key' is required if using for iOS app referers.

Response Structure (Success):
  code (Int): HTTP status code.
  description (String): Description of the status code.
  value (Integer): Exchange rate of Rupiah to US Dollar.
  last_update (String): Timestamp of the last rate update.
  source_name (String): Name of the data source.
  source_link (String): URL of the data source.

Example Request:
GET https://pro.rajaongkir.com/api/currency?key=YOUR_API_KEY
```

--------------------------------

### RajaOngkir Cost API Summary

Source: https://rajaongkir.com/dokumentasi/pro

This method is used to determine shipping rates (ongkos kirim) between specified locations (origin and destination) for a given weight.

```APIDOC
RajaOngkir Cost Endpoint Summary:
  Method: "cost"
  Purpose: To find shipping tariffs based on origin, destination, weight, and courier.
  Details: Requires origin, destination, weight, and courier information to calculate shipping costs.
```

--------------------------------

### RajaOngkir City API

Source: https://rajaongkir.com/dokumentasi/pro

Retrieves a list of cities or regencies in Indonesia. Parameters can filter results by province or specific city ID. If no ID or province is provided, all cities are returned.

```APIDOC
RajaOngkir City Endpoint:
  GET https://pro.rajaongkir.com/api/city

  Parameters:
    key (String, Required): Your RajaOngkir API Key.
    android-key (String, Optional): Identifier for Android applications.
    ios-key (String, Optional): Identifier for iOS applications.
    id (String, Optional): Filter by specific city/regency ID.
    province (String, Optional): Filter by province ID.

  Notes:
    - If 'id' and 'province' are omitted, all cities/regencies are returned.
    - 'android-key' is required if Android app referencing is enabled.
    - 'ios-key' is required if iOS app referencing is enabled.

  Response Structure (Success):
    id (String): City/regency ID.
    code (Int): Status code (e.g., 200).
    description (String): Status description.
    province_id (String): ID of the province.
    city_id (String): City/regency ID.
    province (String): Name of the province.
    type (String): Type of administrative region ('Kota' or 'Kabupaten').
    city_name (String): Name of the city/regency.
    postal_code (String): Postal code for the city/regency.
```

--------------------------------

### RajaOngkir Waybill Tracking API

Source: https://rajaongkir.com/dokumentasi/pro

Tracks the status of shipments using a waybill number and courier code. This API allows users to check the delivery progress of packages. It requires an API key, the waybill number, and the courier's code. The response provides detailed tracking information including status, timestamps, and shipment details.

```APIDOC
Waybill Tracking API Documentation:

Method: POST
URL: https://pro.rajaongkir.com/api/waybill

Parameters:
  key (String, Required): Your RajaOngkir API Key.
  android-key (String, Optional): Identifier for Android application.
  ios-key (String, Optional): Identifier for iOS application.
  waybill (String, Required): The waybill number for tracking.
  courier (String, Required): The courier code (e.g., 'pos', 'wahana', 'jnt', 'sicepat', 'jne').

Notes:
  - 'android-key' is required if using for Android app referers.
  - 'ios-key' is required if using for iOS app referers.

Response Structure (Success):
  waybill (String): The input waybill number.
  courier (String): The input courier code.
  code (Int): HTTP status code.
  description (String): Description of the status code.
  delivered (Boolean): True if delivered, false otherwise.
  courier_code (String): Actual courier code.
  courier_name (String): Name of the courier.
  waybill_number (String): Waybill number.
  service_code (String): Shipping service code.
  waybill_date (Date): Date of shipment.
  shipper_name (String): Name of the shipper.
  receiver_name (String): Name of the receiver.
  origin (String): Origin city of the shipment.
  destination (String): Destination city of the shipment.
  waybill_time (Time): Time of shipment.
  weight (Number): Weight of the shipment.
  shipper_address1 (String): Shipper's address line 1.
  shipper_address2 (String): Shipper's address line 2.
  shipper_address3 (String): Shipper's address line 3.
  shipper_city (String): Shipper's city.
  receiver_address1 (String): Receiver's address line 1.
  receiver_address2 (String): Receiver's address line 2.
  receiver_address3 (String): Receiver's address line 3.
  receiver_city (String): Receiver's city.
  status (String): Current status of the shipment (e.g., 'DELIVERED', 'ON PROCESS').
  pod_receiver (String): Name of the receiver upon delivery.
  pod_date (Date): Date of proof of delivery.
  pod_time (Time): Time of proof of delivery.
  manifest (Array or null): Array of shipment history or null.
    manifest_code (String): Code for manifest entry.
    manifest_description (String): Description for manifest entry.
    manifest_date (Date): Date for manifest entry.
    manifest_time (String): Time for manifest entry.
    city_name (String): City related to the manifest entry.

Example Request:
POST https://pro.rajaongkir.com/api/waybill
Content-Type: application/x-www-form-urlencoded

key=YOUR_API_KEY&waybill=123456789&courier=jne
```

--------------------------------

### RajaOngkir Province API

Source: https://rajaongkir.com/dokumentasi/starter

Retrieves a list of provinces in Indonesia. This API endpoint allows fetching province data, optionally filtered by a specific province ID. It requires an API key for authentication.

```APIDOC
Province API Documentation:

Method: GET
URL: https://api.rajaongkir.com/starter/province

Parameters:
  - key (String, Required): Your RajaOngkir API Key.
  - android-key (String, Optional): Identifier for Android applications.
  - ios-key (String, Optional): Identifier for iOS applications.
  - id (String, Optional): The ID of the province to retrieve. If omitted, all provinces are returned.

Notes:
  - 'android-key' is required if Android referrer is enabled.
  - 'ios-key' is required if iOS referrer is enabled.

Response Structure (Success):
  - key: String (API Key)
  - status: Object
    - code: Integer (Status code, e.g., 200)
    - description: String (Description of the status)
  - results: Array of Province Objects
    - id: String (Province ID)
    - province_id: String (Province ID, redundant with id)
    - province_name: String (Name of the province)

Example Response Snippet:
{
  "key": "YOUR_API_KEY",
  "status": {
    "code": 200,
    "description": "OK"
  },
  "results": [
    {
      "id": "1",
      "province_id": "1",
      "province_name": "Bali"
    },
    ...
  ]
}
```

--------------------------------

### RajaOngkir Subdistrict API

Source: https://rajaongkir.com/dokumentasi/pro

Fetches a list of subdistricts (kecamatan) within Indonesia. Results can be filtered by city/regency ID or a specific subdistrict ID.

```APIDOC
RajaOngkir Subdistrict Endpoint:
  GET https://pro.rajaongkir.com/api/subdistrict

  Parameters:
    key (String, Required): Your RajaOngkir API Key.
    android-key (String, Optional): Identifier for Android applications.
    ios-key (String, Optional): Identifier for iOS applications.
    city (String, Required): ID of the city/regency to list subdistricts for.
    id (String, Optional): Filter by specific subdistrict ID.

  Notes:
    - If 'id' is omitted, all subdistricts for the specified 'city' are returned.
    - If 'id' is provided, details for that specific subdistrict are returned.
    - 'android-key' is required if Android app referencing is enabled.
    - 'ios-key' is required if iOS app referencing is enabled.

  Response Structure (Success):
    city (String): City/regency ID.
    code (Int): Status code (e.g., 200).
    description (String): Status description.
    subdistrict_id (String): Subdistrict ID.
    province_id (String): ID of the province.
    province (String): Name of the province.
    city_id (String): City/regency ID.
    city (String): Name of the city/regency.
    type (String): Type of administrative region ('Kota' or 'Kabupaten').
    subdistrict_name (String): Name of the subdistrict.
```
Tokens:
Raw