List of Methods for Public Customers

NOTE : ALL METHOD NAMES ARE CASE SENSITIVE


getProvince


Description: Get Provinces of RPX Office located.

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<PROVINCE>BALI</PROVINCE>
</DATA>
<DATA>
	<PROVINCE>BANTEN</PROVINCE>
</DATA>
<DATA>
	<PROVINCE>BENGKULU</PROVINCE>
</DATA>
<DATA>
	<PROVINCE>DKI JAKARTA</PROVINCE>
</DATA>
<DATA>
	<PROVINCE>JAWA BARAT</PROVINCE>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
PROVINCE String 50 Province Name

getRPXOffice


Description: Get RPX Office Data at in a Province.

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
province String 50 PROVINCE from service "getProvince"
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
    <DATA>
    	<CITY_NAME>Jakarta Selatan</CITY_NAME>
    	<ADDRESS>WSC-RPX Center Lt 1, Jl. Ciputat Raya No 99</ADDRESS>
    	<TEL>Phone : 021-75901800</TEL>
    	<FAX>Fax : not found</FAX>
    	<LAT>-6.28039</LAT>
    	<LONG>106.771745</LONG>
    </DATA>
    <DATA>
    	<CITY_NAME>Jakarta Selatan</CITY_NAME>
    	<ADDRESS>WSC-Jl. Aditiyawarman No 67, Kebayoran Baru</ADDRESS>
    	<TEL>Phone : 021-7221131</TEL>
    	<FAX>Fax : 021-7221207</FAX>
    	<LAT>>-6.28039</LAT>
    	<LONG>106.771745</LONG>
    </DATA>
</RPX>

Output fields

Field Name Type Size Description
CITY_NAME String 50 City name
ADDRESS String 250 Address
TEL String 50 Telephone number
FAX String 50 Fax number
LAT String 50 Latitude coordinate
LONG String 50 Longitude coordinate

getService


Description: Get Service Type for Shipping

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<SERVICE>NDP-Next Day Package</SERVICE>
</DATA>
<DATA>
	<SERVICE>ECP-Economy Package</SERVICE>
</DATA>
<DATA>
	<SERVICE>MDP-MidDay Package</SERVICE>
</DATA>
<DATA>
	<SERVICE>HCP-HandCarry Package</SERVICE>
</DATA>
<DATA>
	<SERVICE>SDP-SameDay Package</SERVICE>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
SERVICE String 50 3 chars service code + 47 chars description

getOrigin


Description: Get Origin City for Shipping

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<ORIGIN>BPN-Balikpapan</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>TKG-Bandar Lampung</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BDO-Bandung</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BJB-Banjarbaru</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BDJ-Banjarmasin</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BAN-Bantul</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BTH-Batam</ORIGIN>
</DATA>
<DATA>
	<ORIGIN>BSI-BEKASI</ORIGIN>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
ORIGIN String 50 3 chars origin code + 47 chars description

getDestination


Description: Get Destination City for Shipping

Input / Payload parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<DESTINATION>APR-Abepura</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>AMK-Air Molek</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>ALK-Alak</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>AMB-Ambarawa</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>AMQ-Ambon</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>AMR-Amurang</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>ABR-Aur Birugo</DESTINATION>
</DATA>
<DATA>
	<DESTINATION>BUG-Badung</DESTINATION>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
DESTINATION String 50 3 chars destination code + 47 chars description

getRates


Description:
To get RPX Domestic Publish Rates from certain Origin to certain Destination.
This feature is less accurate, because there are posssibility that in certain large city area, it will have more than a single rates. We recommend you to use the getRatesPostalcode instead, where the Rates’s search is based on the postal code.

Input / Payload parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
origin String 3 The 3 character code of origin shipper city (read "getOrigin")
destination String 3 The 3 character code of recipient city (read "getDestination")
service_type String 3 The 3 character code of selected Shipment SERVICE TYPE (read "getService") (OPTIONAL)
weight Numeric 3 weight of package (in Kg)
disc Numeric 3 percentage of the discount to be calculated (in number only without % sign) (OPTIONAL)
format String 5 XML for output XML or JSON for output JSON
dimension Numeric 3 package's volumetric value. ( length cm x width cm x height cm / 6000 )

Output Data

Field Name Description
SERVICE_TYPE_ID RPX service id
SERVICE RPX service full description
FREIGHT_CHARGE Rates value per kilogram
TOT_CHARGE Total Rates Value of weight mentioned in weight parameter (full rates)
PRICE Total Rates Value of weight mentioned in weight parameter (after discounted)
DISCOUNT discount percentage mentioned in discount parameter
ETF fastest possible estimated days of delivery
ETD maximum standard estimated days of delivery
CHARGEABLE_WEIGHT weight value stated in payload request
DIM_DIVISION Standard for volumetric divider based on RPX Service (can be 6000 or 4000)

Example of XML payload.
origin=JAK. destination=BDO. and the rest of parameters were set as blank (empty).

user = demo
password = demo
origin = JAK
destination = BDO
service_type =
weight = 1
disc = 
format =
dimension =

Example of XML Output if service_type is not defined
Set service_type = empty and weight parameter = 1. all available services and its rates will be included in the response.

<RPX>
<TITLE>Rates From Jakarta (JAK) TO Bandung (BDO), Weight 1 Kg</TITLE>
<DATA>
	<SERVICE_TYPE_ID>RGP</SERVICE_TYPE_ID>
	<SERVICE>Regular Package (RGP)</SERVICE>
	<FREIGHT_CHARGE>10000</FREIGHT_CHARGE>
	<TOT_CHARGE>10000</TOT_CHARGE>
	<PRICE>10000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>6000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>NDP</SERVICE_TYPE_ID>
	<SERVICE>Next Day Package (NDP)</SERVICE>
	<FREIGHT_CHARGE>20000</FREIGHT_CHARGE>
	<TOT_CHARGE>20000</TOT_CHARGE>
	<PRICE>20000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>6000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>SDP</SERVICE_TYPE_ID>
	<SERVICE>SameDay Package (SDP)</SERVICE>
	<FREIGHT_CHARGE>351000</FREIGHT_CHARGE>
	<TOT_CHARGE>351000</TOT_CHARGE>
	<PRICE>351000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>20000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>MDP</SERVICE_TYPE_ID>
	<SERVICE>MidDay Package (MDP)</SERVICE>
	<FREIGHT_CHARGE>31000</FREIGHT_CHARGE>
	<TOT_CHARGE>31000</TOT_CHARGE>
	<PRICE>31000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>6000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>ECP</SERVICE_TYPE_ID>
	<SERVICE>Economy Delivery (ECP)</SERVICE>
	<FREIGHT_CHARGE>65000</FREIGHT_CHARGE>
	<TOT_CHARGE>65000</TOT_CHARGE>
	<PRICE>65000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>10</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>4000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>HWP</SERVICE_TYPE_ID>
	<SERVICE>Heavy Weight Delivery (HWP)</SERVICE>
	<FREIGHT_CHARGE>80000</FREIGHT_CHARGE>
	<TOT_CHARGE>80000</TOT_CHARGE>
	<PRICE>80000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>20</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>4000</DIM_DIVISION>
</DATA>
</RPX>

Example of XML response if service_type is defined
Set service_type paramater with one of the RPX service and weight parameter = 1. Only this service information (if available) will be included in the response.

<RPX>
<TITLE>Rates From Jakarta (JAK) TO Bandung (BDO), Weight 1 Kg</TITLE>
<DATA>
	<SERVICE_TYPE_ID>RGP</SERVICE_TYPE_ID>
	<SERVICE>Regular Package (RGP)</SERVICE>
	<FREIGHT_CHARGE>12376</FREIGHT_CHARGE>
	<TOT_CHARGE>12376</TOT_CHARGE>
	<PRICE>12376</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>N/A</ETF>
	<ETD>N/A</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>6000</DIM_DIVISION>
</DATA>
</RPX>

getRatesPostalCode


Description :
To Get RPX Domestic Service Rates based on Indonesia’s standar Postal Code (Origin and Destination).
One Postal code represent a limited area. It usually represent a subdistrict (kecamatan) level area.
This feature is newer than getRates and is more accurate to define Rates value.
In getRates, to fill in the origin and destination paramater you have to check the unique RPX city code of the origin and the destination city first (by using API feature related to this purpose), put them into payload parameter, then push the full request.
By using this getRatesPostalCode you just have to fill in postal code into origin and destination parameter.
In most case, the postal code is part of standard form entry when you need to completing an origin address or the destination address for the package delivery or mailing purpose.
By completing an address with the correct postal code, you avoid the missroute and makes the package to be delivered on time.

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
origin_postal_code String 5 The 5 numeric code of ORIGIN POSTAL CODE
destination_postal_code String 5 The 5 numeric code of DESTINATION POSTAL CODE
service_type String 3 The 3 character code of requested RPX SERVICE TYPE (OPTIONAL)
weight Numeric 3 3 digit of the weight of package (in Kg). Any fraction will be Rounding up
disc Numeric 3 3 digit of the discount applied (between 0 – 100, in percent) (OPTIONAL)
format String 5 XML for output XML or JSON for output JSON
account_number String 9 RPX Account number matched with API id(OPTIONAL)

Output fields
the output will start with a title like this : Rates for Account No. 000000000 From (JAK) TO (DPS), Weight 1 Kg, Discount 0%

Field Name Type Description
SERVICE_TYPE_ID String RPX service id
SERVICE String RPX service description
FREIGHT_CHARGE String Rates value for 1 kg
TOT_CHARGE String Total rates value
PRICE String Total rates value after discounted
DISCOUNT String discount value
ETF String fastest posible days of delivery
ETD String standard days of delivery
CHARGEABLE_WEIGHT String weight value
DIM_DIVISION String divider factor in volumetric (can be 6000 or 4000)

Example of usage :
You know that RPX Sales have been activated some RPX rates (PSR, PSN, PSM, PSS) for your account (123456789). You want to get all available RPX rates under your RPX account for this following route : origin = 12310, destination = 80228.

So you set The Payload / Request :

user = demo
password = demo
origin_postal_code= 12310
destination_postal_code = 80228
service_type =
weight = 1
disc =
format =
account_number = 123456789

The Output / Response will be something like :

<RPX>
<TITLE>Rates for Account No. 800051592 From  (JAK) TO  (DPS), Weight 1 Kg, Discount 0 %</TITLE>
<DATA>
	<SERVICE_TYPE_ID>PSN</SERVICE_TYPE_ID>
	<SERVICE>RPX PAS NextDay  (PSN)</SERVICE>
	<FREIGHT_CHARGE>26000</FREIGHT_CHARGE>
	<TOT_CHARGE>26000</TOT_CHARGE>
	<PRICE>26000</PRICE>
	<DISCOUNT>0</DISCOUNT>
	<ETF>0</ETF>
	<ETD>1</ETD>
	<CHARGEABLE_WEIGHT>1</CHARGEABLE_WEIGHT>
	<DIM_DIVISION>6000</DIM_DIVISION>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>PSM</SERVICE_TYPE_ID>
	<REMARKS>NSA for Requested Delivery Area</REMARKS>
</DATA>
<DATA>
	<SERVICE_TYPE_ID>PSS</SERVICE_TYPE_ID>
	<REMARKS>NSA for Requested Delivery Area</REMARKS>
</DATA>
</RPX>

getTrackingAWB


Description: Get Tracking Data from an AWB

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
awb String 12 AWB number to check
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<TRACKING_ID>TRACKING ID</TRACKING_ID>
	<TRACKING_DESC>TRACKING DESCRIPTION</TRACKING_DESC>
	<LOCATION>LOCATION</LOCATION>
	<TRACKING_DATE>DATE</TRACKING_DATE>
	<TRACKING_TIME>TIME</TRACKING_TIME>
</DATA>
<DATA>
	<TRACKING_ID>PUP</TRACKING_ID>
	<TRACKING_DESC>Picked-up</TRACKING_DESC>
	<LOCATION>Kebun+Jeruk</LOCATION>
	<TRACKING_DATE>Jul+30%2C+2013</TRACKING_DATE>
	<TRACKING_TIME>07%3A00+PM</TRACKING_TIME>
</DATA>
<DATA>
	<TRACKING_ID>SOP</TRACKING_ID>
	<TRACKING_DESC>Departed+RPX+origin+location</TRACKING_DESC>
	<LOCATION>Kebun+Jeruk</LOCATION>
	<TRACKING_DATE>Jul+30%2C+2013</TRACKING_DATE>
	<TRACKING_TIME>11%3A20+PM</TRACKING_TIME>
</DATA>
<DATA>
	<TRACKING_ID>SIP</TRACKING_ID>
	<TRACKING_DESC>Arrived+at+transit+location</TRACKING_DESC>
	<LOCATION>EXPRESS+DISTRIBUTION+CENTRE</LOCATION>
	<TRACKING_DATE>Jul+31%2C+2013</TRACKING_DATE>
	<TRACKING_TIME>12%3A05+AM</TRACKING_TIME>
</DATA>
<DATA>
	<TRACKING_ID>VAN</TRACKING_ID>
	<TRACKING_DESC>On+RPX+Vehicle+For+Delivery</TRACKING_DESC>
	<LOCATION>Pekanbaru</LOCATION>
	<TRACKING_DATE>Jul+31%2C+2013</TRACKING_DATE>
	<TRACKING_TIME>07%3A41+PM</TRACKING_TIME>
</DATA>
<DATA>
	<TRACKING_ID>POD</TRACKING_ID>
	<TRACKING_DESC>Package+received+by+consignee</TRACKING_DESC>
	<LOCATION>Pekanbaru</LOCATION>
	<TRACKING_DATE>Jul+31%2C+2013</TRACKING_DATE>
	<TRACKING_TIME>08%3A04+PM</TRACKING_TIME>
</DATA>

<DELIVERY_TO>BP++HENDRA+%2FRAIS+</DELIVERY_TO>
<RECEIVED_BY>MARTINUS+</RECEIVED_BY>
<DELIVERY_LOC>Rumbai</DELIVERY_LOC>
<DELIVERY_DATE>Jul+31%2C+2013</DELIVERY_DATE>
<DELIVERY_TIME>08%3A04+PM</DELIVERY_TIME>

<IMAGE_SIGNATURE>http://www.rpxholding.com/pdaimages/100057368051_20130731_sign.jpg</IMAGE_SIGNATURE>
<IMAGE_FOTO>http://www.rpxholding.com/pdaimages/100057368051_20130731_fotoign.jpg</IMAGE_FOTO>
</RPX>

Output fields

Field Name Type Size Description
TRACKING_ID String 5 Tracking code
TRACKING_DESC String 50 Tracking code description
LOCATION String 50 AWB location
TRACKING_DATE String 10 Tracking date (YYYY-MM-DD)
TRACKING_TIME String 8 Tracking time (HH:mm:ss)
DELIVERY_TO String 50 Consignee
RECEIVED_BY String 50 Actual received by
DELIVERY_LOC String 50 Location of package receiver
DELIVERY_DATE String 10 Receive date (YYYY-MM-DD)
DELIVERY_TIME String 8 Receive Time (HH:mm:ss)
IMAGE_SIGNATURE String 255 URL for receiver's signature
IMAGE_FOTO String 255 URL for receiver's photo

getClearanceAWB


Description: Get Clearance Data from an AWB

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
awb String 12 AWB number to check
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA1>
	<SHIPPER_NAME>JASON</SHIPPER_NAME>
	<SHIPPER_COMPANY>UNIFORM+CLOTHING+SOLUTIONS</SHIPPER_COMPANY>
	<SHIPPER_ADDRESS>UNIT+2+TURNER+WAYTRINITY</SHIPPER_ADDRESS>
	<SHIPPER_CITY>WAKEFIELD</SHIPPER_CITY>
	<CONSIGNEE_NAME>ATTN%3A+NUKI</CONSIGNEE_NAME>
	<CONSIGNEE_COMPANY>PT+NITYA+NANDHA</CONSIGNEE_COMPANY>
	<CONSIGNEE_ADDRESS>KP+CIMANGGUNG+RT+02%2F01</CONSIGNEE_ADDRESS>
	<CONSIGNEE_CITY>BOGOR</CONSIGNEE_CITY>
	<ARRIVAL_DATE></ARRIVAL_DATE>
	<TOT_PACKAGE>1</TOT_PACKAGE>
	<TOT_WEIGHT>50.00</TOT_WEIGHT>
	<TOT_VALUE>281.69</TOT_VALUE>
	<DESC>CLOTHING+SAMPLES+FABRIC+FABRIC+</DESC>
</DATA1>

<DATA2>
<LINE>
	<CLEARANCE_DESC>CLEARANCE ACTIVITY</CLEARANCE_DESC>
	<CLEARANCE_DATE>DATE</CLEARANCE_DATE>
	<CLEARANCE_TIME>TIME</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC></CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+01%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>02%3A49+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC></CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+01%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>05%3A11+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC>Pre+Selection</CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+01%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>05%3A11+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC></CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+02%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>06%3A11+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC></CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+03%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>04%3A07+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC></CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+04%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>05%3A05+AM</CLEARANCE_TIME>
</LINE>
<LINE>
	<CLEARANCE_DESC>RPX+has+completed+BC+2.3+Form</CLEARANCE_DESC>
	<CLEARANCE_DATE>Sep+04%2C+2013</CLEARANCE_DATE>
	<CLEARANCE_TIME>06%3A25+AM</CLEARANCE_TIME>
</LINE>
</DATA2>
</RPX>

Output fields

Field Name Type Size Description
SHIPPER_NAME String 100 Shipper Name
SHIPPER_COMPANY String 100 Shipper Company
SHIPPER_ADDRESS String 100 Shipper Address
SHIPPER_CITY String 100 Shipper City
CONSIGNEE_NAME String 100 Consignee Name
CONSIGNEE_COMPANY String 100 Consignee Company
CONSIGNEE_ADDRESS String 100 Consignee Address
CONSIGNEE_CITY String 100 Consignee City
ARRIVAL_DATE String 10 Arrival Date (MMM DD YYYY)
TOT_PACKAGE String 20 Total Package
TOT_WEIGHT String 20 Total Weight
TOT_VALUE String 20 Total Value
DESC String 100 Description of Goods
CLEARANCE_DESC String 100 Clearance Description
CLEARANCE_DATE String 10 Clearance Date (MMM DD YYYY)
CLEARANCE_TIME String 10 Clearance Time (HH:MM AM/PM)

getRouteOrigin


Description: Get Route for Origin City and Origin Billing City based on Postal Code

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
postal_code String 10 Postal Code
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<ORIGIN>JKT</ORIGIN>
	<ORIGIN_BILL_CITY>JAK</ORIGIN_BILL_CITY>
	<ORIGIN_CITY_NAME>Jakarta</ORIGIN_CITY_NAME>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
ORIGIN String 3 3 chars Origin City
ORIGIN_BILL_CITY String 3 3 chars Origin Billing City
ORIGIN_CITY_NAME String 50 Origin City Name

getRouteDestination


Description: Get Route for Destination City and Destination Billing City based on Postal Code

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
postal_code String 10 Postal Code
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<DESTINATION>HLP</DESTINATION>
	<DESTINATION_BILL_CITY>BRG</DESTINATION_BILL_CITY>
	<DESTINATION_CITY_NAME>Bogor</DESTINATION_CITY_NAME>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
DESTINATION String 3 3 chars Destination City
DESTINATION_BILL_CITY String 3 3 chars Destination Billing City
DESTINATION_CITY_NAME String 50 Destination City Name

getCity


Description: Get List of City for Destination Shipping

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<CITY_ID>APR</CITY_ID>
	<CITY_NAME>Abepura</CITY_NAME>
	<STATION_ID>DJJ</STATION_ID>
</DATA>
<DATA>
	<CITY_ID>AKA</CITY_ID>
	<CITY_NAME>Aek Kanopan</CITY_NAME>
	<STATION_ID>MES</STATION_ID>
</DATA>
<DATA>
	<CITY_ID>ANA</CITY_ID>
	<CITY_NAME>Aek Nabara</CITY_NAME>
	<STATION_ID>MES</STATION_ID>
</DATA>
<DATA>
	<CITY_ID>MSU</CITY_ID>
	<CITY_NAME>Air Mesu</CITY_NAME>
	<STATION_ID>PGK</STATION_ID>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
CITY_ID String 3 3 chars Destination City
CITY_NAME String 50 City Name
STATION_ID String 4 Station ID

getPostalCode


Description: Get List of Postal Code (“city_id” input is Optional, Taken from Service “getCity”)

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
city_id String 3 City ID from service "getCity" (OPTIONAL)
format String 5 XML for output XML or JSON for output JSON
cod_area String 1 Fill with 'Y' to get COD area. Fill with "N' to get non COD area. If empty it shows both COD and non COD area
service_type String 3 Fill Service Type from "getService". If Empty it shows All Postal Code

Example XML return.

<RPX>
<DATA>
	<CITY_ID>MES</CITY_ID>
	<CITY_NAME>MEDAN</CITY_NAME>
	<POSTAL_CODE>20121</POSTAL_CODE>
	<POSTAL_NAME>BABURA KUALA BATUAH</POSTAL_NAME>
	<STATION_ID>MES</STATION_ID>
	<COD_AREA>YES</COD_AREA>
	<PUP_AREA>YES</PUP_AREA>
</DATA>
<DATA>
	<CITY_ID>BDO</CITY_ID>
	<CITY_NAME>BANDUNG</CITY_NAME>
	<POSTAL_CODE>40395</POSTAL_CODE>
	<POSTAL_NAME>CICALENGKA</POSTAL_NAME>
	<STATION_ID>BDO</STATION_ID>
	<COD_AREA>NO</COD_AREA>
	<PUP_AREA>YES</PUP_AREA>
</DATA>
<DATA>
	<CITY_ID>TAN</CITY_ID>
	<CITY_NAME>TANGERANG</CITY_NAME>
	<POSTAL_CODE>15811</POSTAL_CODE>
	<POSTAL_NAME>BENCONGAN LIPPO KARAWACI</POSTAL_NAME>
	<STATION_ID>CGK</STATION_ID>
	<COD_AREA>YES</COD_AREA>
	<PUP_AREA>NO</PUP_AREA>
</DATA>
<DATA>
	<CITY_ID>JAK</CITY_ID>
	<CITY_NAME>JAKARTA</CITY_NAME>
	<POSTAL_CODE>12250</POSTAL_CODE>
	<POSTAL_NAME>ULUJAMI</POSTAL_NAME>
	<STATION_ID>HLP</STATION_ID>
	<COD_AREA>YES</COD_AREA>
	<PUP_AREA>YES</PUP_AREA>
</DATA>
<DATA>
	<CITY_ID>SRG</CITY_ID>
	<CITY_NAME>SEMARANG</CITY_NAME>
	<POSTAL_CODE>50774</POSTAL_CODE>
	<POSTAL_NAME>GETASAN</POSTAL_NAME>
	<STATION_ID>SRG</STATION_ID>
	<COD_AREA>NO</COD_AREA>
	<PUP_AREA>YES</PUP_AREA>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
CITY_ID String 3 City ID
CITY_NAME String 50 City Name
POSTAL_CODE String 10 Postal Code
POSTAL_NAME String 50 Postal Code Area Name
STATION_ID String 3 Station ID
COD_AREA String 3 Cod Area
PUP_AREA String 3 Pickup Area

getAWBbyReference


Description: Get List of AWB by Reference Number

Input parameters

Field Name Type Size Description
user String 20 API Username
password String 20 API Password
reference_no String 50 Reference Number
format String 5 XML for output XML or JSON for output JSON

Example XML return.

<RPX>
<DATA>
	<AWB>100017137113</AWB>
	<LAST_STATUS>Package received by consignee</LAST_STATUS>
	<LOCATION>Cassablanca</LOCATION>
	<TRACKING_DATE>Aug 02, 2006</TRACKING_DATE>
	<TRACKING_TIME>10:39 AM</TRACKING_TIME>
</DATA>
<DATA>
	<AWB>100017966182</AWB>
	<LAST_STATUS>Package received by consignee</LAST_STATUS>
	<LOCATION>Pondok Pinang</LOCATION>
	<TRACKING_DATE>Sep 26, 2006</TRACKING_DATE>
	<TRACKING_TIME>05:00 PM</TRACKING_TIME>
</DATA>
<DATA>
	<AWB>100021777645</AWB>
	<LAST_STATUS>Package received by consignee</LAST_STATUS>
	<LOCATION>Medan</LOCATION>
	<TRACKING_DATE>May 05, 2007</TRACKING_DATE>
	<TRACKING_TIME>12:10 PM</TRACKING_TIME>
</DATA>
</RPX>

Output fields

Field Name Type Size Description
AWB String 12 AirwayBill Number
LAST_STATUS String 100 Last Status of Tracking
LOCATION String 100 Location of Tracking
TRACKING_DATE String 15 Tracking Date (MMM DD, YYYY)
TRACKING_TIME String 100 Tracking Time (HH:MM AM/PM)

<< Previous: Using SOAP – Next: List of Methods for RPX Account Customers >>

Print Friendly, PDF & Email