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 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: Get RPX Domestic Rates from Origin to Destination with a Specific Weight and Discount

Input 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) from service "getOrigin"
destination String 3 The 3 character code of DESTINATION (recipient city) from service "getDestination"
service_type String 3 The 3 character code of selected Shipment SERVICE TYPE from service "getService" (OPTIONAL)
weight Numeric 3 3 digit of the weight of package (in Kg)
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

Example XML return.

WITHOUT SERVICE TYPE

<RPX>
     <TITLE>Rates From Jakarta (JAK) TO Denpasar (DPS), Weight 1 Kg,
      Discount 0 %</TITLE>
     <DATA>
	  <SERVICE>Regular Package (RGP)</SERVICE>
	  <PRICE>19200</PRICE>
	  <ETF>1</ETF>
	  <ETD>2</ETD>
     </DATA>
     <DATA>
	  <SERVICE>Next Day Package (NDP)</SERVICE>
	  <PRICE>22750</PRICE>
	  <ETF>2</ETF>
	  <ETD>3</ETD>
     </DATA>
     <NOTIF1>This rate is based on standard drop off shipment rate and
     with cash payment, apply only at RPX counter.</NOTIF1>
     <NOTIF2>Harga ini berdasarkan tarif standar pengiriman barang di
     konter (drop off) and dengan pembayaran tunai, berlaku hanya di
     RPX konter.</NOTIF2>
</RPX>

WITH SERVICE TYPE (example : RGP)

<RPX>
     <TITLE>Rates From Jakarta (JAK) TO Denpasar (DPS), Weight 1 Kg,
      Discount 0 %</TITLE>
     <DATA>
	  <SERVICE>Regular Package (RGP)</SERVICE>
	  <PRICE>19200</PRICE>
	  <ETF>1</ETF>
	  <ETD>2</ETD>
     </DATA>
     <NOTIF1>This rate is based on standard drop off shipment rate and
     with cash payment, apply only at RPX counter.</NOTIF1>
     <NOTIF2>Harga ini berdasarkan tarif standar pengiriman barang di
     konter (drop off) and dengan pembayaran tunai, berlaku hanya di
     RPX konter.</NOTIF2>
</RPX>

Output fields

Field Name Type Size Description
TITLE String 100 Title
DATA – SERVICE String 100 Service Type
DATA – PRICE String 20 Price of Service Type depend on weight & disc
DATA – ETF String 3 Fastest (shortest) Estimated Delivery Time in Day(s)
DATA – ETD String 3 Maximum (longest) Estimated Delivery Time in Day(s)
NOTIF1 String 255 Description of Notification 1
NOTIF2 String 255 Description of Notification 2

getRatesPostalCode

Description: Get RPX Domestic Rates from Origin Postal Code to Destination Postal Code with a Specific Weight and Discount

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)

Example XML return.

WITHOUT MENTIONING SERVICE TYPE AND ACCOUNT NUMBER. Showing All Available Service Rates of one Requested Route with Publish Rates.
Example :
Requesting all available service rates from this route :
Origin postcode : 12310 (Pondok Pinang Kebayoran Lama Jakarta Selatan)
Destination postcode : 80228 (Sanur Denpasar Bali).
12310 will be detected as part of city id : JAK, while 80228 will be detected as part of city id : DPS.
The Response will be :

<RPX> 
	<TITLE>Rates From Jakarta (JAK) TO Denpasar (DPS), 
	Weight 1 Kg</TITLE> 
	<DATA> 
	<SERVICE>SameDay Package (SDP)</SERVICE> 
	<PRICE>421000</PRICE> 
	<ETF>N/A</ETF> 
	<ETD>Available</ETD> 
	</DATA> 
	<DATA> 
	<SERVICE>MidDay Package (MDP)</SERVICE> 
	<PRICE>39000</PRICE> 
	<ETF>1</ETF> 
	<ETD>1 Days</ETD> 
	</DATA> 
	<DATA> 
	<SERVICE>Ecommerce Package (ERP)</SERVICE> 
	<PRICE>16400</PRICE> 
	<ETF>2</ETF> 
	<ETD>4 Days</ETD> 
	</DATA> 
	<NOTIF1>REP service only applicable for drop-off shipment 
	at RPX counter</NOTIF1> 
	<NOTIF2>IMP service only applicable for drop-off shipment at Indomaret 
	counter (Jabodetabek)</NOTIF2> 
</RPX>

WITH MENTIONING ONE PARTICULAR SERVICE TYPE AND WITHOUT MENTIONING ACCOUNT NUMBER. When available, the rates will be shown with Publish Rates.
Example :
Requesting availability of MDP service rates from this route :
Origin postcode : 12310 (Pondok Pinang Kebayoran Lama Jakarta Selatan)
Destination postcode : 80228 (Sanur Denpasar Bali).
12310 will be detected as part of city id : JAK, while 80228 will be detected as part of city id : DPS.
The Response will goes like this :

<RPX> 
	<TITLE>Rates From Jakarta (JAK) TO Denpasar (DPS), Weight 1 Kg</TITLE> 
	<DATA> 
	<SERVICE>MidDay Package (MDP)</SERVICE> 
	<PRICE>39000</PRICE> 
	<ETF>1</ETF> 
	<ETD>1</ETD> 
	</DATA> 
	<NOTIF1>REP service only applicable for drop-off shipment at RPX counter</NOTIF1> 
	<NOTIF2>IMP service only applicable for drop-off shipment at Indomaret counter 
	Jabodetabek)</NOTIF2> 
</RPX>

WITH MENTIONING ONE PARTICULAR SERVICE TYPE AND ACCOUNT NUMBER. When available, the rates will be shown based on Customer Discount Rates.
Example :
Requesting availability of MDP service rates from this route :
Origin postcode : 12310 (Pondok Pinang Kebayoran Lama Jakarta Selatan)
Destination postcode : 80228 (Sanur Denpasar Bali)
Account Number: Fill with Customer Account Number (If Customer has discount, the rates will be shown based on Customer Discount Rates.
12310 will be detected as part of city id : JAK, while 80228 will be detected as part of city id : DPS.
The Response will goes like this :

<RPX> 
	<TITLE>Rates From Jakarta (JAK) TO Denpasar (DPS), Weight 1 Kg, Discount 25 %</TITLE> 
	<DATA> 
	<SERVICE>MidDay Package (MDP)</SERVICE> 
	<PRICE>29250</PRICE> 
	<ETF>1</ETF> 
	<ETD>1</ETD> 
	</DATA> 
	<NOTIF1>REP service only applicable for drop-off shipment at RPX counter</NOTIF1> 
	<NOTIF2>IMP service only applicable for drop-off shipment at Indomaret counter 
	(Jabodetabek)</NOTIF2> 
</RPX>

NOTE : If requested Route is not available, the Price will indicated by 0 or n/A.
Output fields

Field Name Type Size Description
TITLE String 100 Title
DATA – SERVICE String 100 Service Type
DATA – PRICE String 20 Price of Service Type depend on weight & disc
DATA – ETF String 3 Fastest (shortest) Estimated Delivery Time in Day(s)
DATA – ETD String 3 Maximum (longest) Estimated Delivery Time in Day(s)
NOTIF1 String 255 Description of Notification 1
NOTIF2 String 255 Description of Notification 2

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