Table of Contents BOL Application... 1 Imaging Application... 6 Pickup Application... 7 Rating Application (City Name Required)...

Transcription

1 FedEx Freight and FedEx National LTL are proud to offer a comprehensive XML solution that combines previously separate XML transactions into one freight solution. With our newly aligned XML solutions, you can now manage all your regional and long-haul freight shipping from one XML interface, increasing efficiency and offering your business more freight solutions than ever before. XML Capabilities Enhanced XML Solutions XML Support Access to regional and long-haul services within a single XML interface. One solution for scheduling regional and long-haul shipments. Obtain account-specific rates for regional, long-haul and guaranteed shipments. Access to newly integrated Web site applications. Integrated service and rating options. Bill of Lading Images Pickup Requests Rates Transit Times Tracking E-Commerce Technical Support [email protected] Hours: Mon - Fri, 7:00 AM - 7:00 PM CST

2 Table of Contents BOL Application... 1 URL... 1 Parameters... 1 Notes... 3 Response Nodes... 3 Example - XML Script... 4 Example - Successful Response... 4 Example - Error Response... 5 Imaging Application...6 URL... 6 Parameters... 6 Response Nodes... 6 Example - XML Script... 6 Example - Successful Response... 6 Example - Error Response... 6 Pickup Application... 7 URL... 7 Parameters... 7 Notes... 8 Response Nodes... 8 Example - XML Script... 8 Example - Successful Response... 8 Example - Error Response... 9 Rating Application (City Name Required) URL Parameters Notes Response Nodes Example - XML Script Example - Successful Response Example - Error Response Rating Application (City Name NOT Required) URL Parameters Notes Response Nodes Example - XML Script Example - Successful Response Example - Error Response Transit Time Application URL Parameters Response Nodes Example - XML Script Example - Successful Response Example - Error Response City Lookup Application URL... 18

3 Parameters Response Nodes Example - XML Script Example - Successful Response Tracking Application URL Parameters Response Nodes Example - XML Script Example - Successful Response Terms of Use... 23

4 XML BOL Application XML BOL Application FedEx Freight and FedEx National LTL Bill of Ladings (BOL) are available as XML strings by following this set of guidelines which describes the syntax used to request a BOL. This BOL request can be used to submit BOL information, submit a pickup request and request a rate quote. URL: Parameters: The following list of parameters can be passed while sending a BOL request. Fields with * are required fields. Optional fields are not required to be included in URL. Include an optional parameter key only if the value needs to be passed. Please refer to the examples for usage. Parameter Description Required Fields *regkey Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. *payment_type Indicates the debtor of the charges [S (shipper) C (consignee) or B (billto)] *payment_terms Terms of the bill [P (prepaid) C (collect) or 7 (section 7)] *guarantee Indicates the premium guaranteed service for both FedEx Freight and FedEx National LTL [Y/N] *servicing_carrier Company identifier [FXF/FXNL] *shipper_nm Shipper name *shipper_addr1 Shipper address 1 *shipper_city Shipper city *shipper_state Shipper state *shipper_zip Shipper zip code *shipper_ctry Shipper country code [US, CA or MX] *shipper_phn_ctry Shipper phone country code [US, CA or MX] *consignee_nm Consignee name *consignee_addr1 Consignee address 1 *consignee_city Consignee city [US, CA or MX] *consignee_state Consignee state *consignee_zip Consignee zip code *consignee_ctry Consignee country code [US, CA or MX] *consignee_phn_ctry Consignee phone country code *detail_hu_1 Number of handling units See Notes Section N-1 *detail_pk_type_1 Pack type [BDL', 'CTN', 'CRAT', 'DRM', 'LOOSE', 'PAL', 'PLT', or 'OTHER'] See Notes Section N-1 *detail_pcs_1 Number of pieces See Notes Section N-1 *detail_class_1 Freight bill class [Standard FB classification codes] See Notes Section N-1 and N-2 *detail_wt_1 Weight See Notes Section N-1 *detail_desc_1 Description See Notes Section N-1 Optional Misc Fields detail_bol_nbr_1 Bill of lading number detail_po_nbr_1 Purchase order number detail_nmfc_1 NMFC code detail_cubic_ft_1 Cubic feet detail_haz_1 Hazardous material flag [Y/N] customer_nbr Account number special_instr Special instructions pro_nbr Pro number assign_pro [Y/N] for system to assign a pro number. pro_nbr attrib must be XML Solutions v /18/09

5 XML BOL Application Optional Shipper Fields shipper_addr2 Shipper address 2 shipper_addr3 Shipper address 3 shipper_id1 Shipper id 1 shipper_id2 Shipper id 2 shipper_ Shipper shipper_store Shipper store shipper_dept Shipper department shipper_suite Shipper suite shipper_floor Shipper floor shipper_apt Shipper apartment shipper_div Shipper division shipper_phn_area_cd Shipper phone area code shipper_phn_exchng Shipper phone exchange shipper_phn_nbr Shipper phone number shipper_phn_ext Shipper phone extension Optional Consignee Fields consignee_addr2 Consignee address 2 consignee_addr3 Consignee address 3 consignee_id1 Consignee id 1 consignee_id2 Consignee id 2 consignee_ Consignee consignee_store Consignee store consignee_dept Consignee department consignee_suite Consignee suite consignee_floor Consignee floor consignee_apt Consignee apartment consignee_div Consignee division consignee_phn_area_cd Consignee phone area code consignee_phn_exchng Consignee phone exchange consignee_phn_nbr Consignee phone number consignee_phn_ext Consignee phone extension blank and FXF must be the servicing carrier. See Notes Section N-3 Optional Third Party Fields third_party_nm Third party name See Notes Section N-4 third_party_addr1 Third party address 1 third_party_city Third party city third_party_state Third party state third_party_zip Third party zipcode third_party_ctry Third party country code [US, CA or MX] third_party_ Third party third_party_phn_ctry Third party phone country code third_party_phn_area_cd Third party phone area code third_party_phn_exchng Third party phone exchange third_party_phn_nbr Third party phone number third_party_phn_ext Third party phone extension Broker Information broker_nm broker_phn_ctry broker_phn_area_cd broker_phn_exchng broker_phn_nbr broker_phn_ext Broker name Broker phone country code [US, CA or MX] Broker phone area code Broker phone exchange Broker phone number Broker phone extension XML Solutions v /18/09

6 XML BOL Application COD Information cod_remit_nm COD remit name cod_remit_addr1 COD remit address 1 cod_remit_city COD remit city cod_remit_state COD remit state cod_remit_zip COD remit zip cod_remit_ctry COD remit country [US, CA, OR MX] cod_remit_phn_ctry COD remit phone country code [US, CA or MX] cod_remit_phn_area_cd COD remit phone area code cod_remit_phn_exchng COD remit phone exchange cod_remit_phn_nbr COD remit phone number cod_remit_phn_ext COD remit phone extension cod_terms COD payment terms [prepaid or collect] cod_amt COD amount [#.##] cod_payment_type COD payment type [Personal Check=PC, Company Check=CC, Certified Funds=CF Accessorials call_before_delivery residential_pickup residential_delivery limited_access_pickup limited_access_delivery do_not_break_down_pallets top_load_only poison food freezable oversized liftgate_delivery_prepaid liftgate_delivery_collect liftgate_pickup_prepaid liftgate_pickup_collect inside_delivery_collect inside_delivery_prepaid inside_pickup_collect inside_pickup_prepaid do_not_stack Call before delivery [Y/N] Residential pickup [Y/N] Residential delivery [Y/N] Limited access pickup [Y/N] Limited access delivery [Y/N] Do not break down pallets [Y/N] Top load only [Y/N] Poison [Y/N] Food [Y/N] Freezable [Y/N] Oversized [Y/N] Liftgate delivery prepaid [Y/N] Liftgate delivery collect [Y/N] Liftgate pickup prepaid [Y/N] Liftgate pickup collect [Y/N] Inside delivery collect [Y/N] Inside delivery prepaid [Y/N] Inside pickup collect [Y/N] Inside pickup prepaid [Y/N] Do not stack [Y/N] Notes: N-1 At least one complete detail line item (with all 6 required detail parameters) must be completed. You may have up to 50 line items. To add multiple line items, change the ending number on the detail parameters. For example, detail_class_1 is the first line item, detail_class_2 becomes the second line item. N-2 Valid freight classes are: 050, 055, 060, 065, 070, 077, 085, 092, 100, 110, 125,150, 175, 200, 250, 300, 400 and 500 N-3 If you request to have a pre-assigned FedEx Freight pro number, you must have the ability to create a bar code representing this pro number on your Bill of Lading that is given to the driver. If you are unable to create the bar code, then the driver will have to assign a new pro number. N-4 If you are using a Bill To account number, ALL bill to parameters must be used. Response Nodes: XMLBOLResponse cod-amount XMLBOLResponse/shipper/state XMLBOLResponse/bol-rate/net-charges XMLBOLResponse/rate-items/NMFCNumber XML Solutions v /18/09

7 XML BOL Application XMLBOLResponse/shipper/name XMLBOLResponse/shipper/zip XMLBOLResponse/shipper/ -address XMLBOLResponse/shipper/country XMLBOLResponse/shipper/city XMLBOLResponse/shipper/phone XMLBOLResponse/shipper/address XMLBOLResponse/shipper/id1 XMLBOLResponse/shipper/id2 XMLBOLResponse/shipper/company-name XMLBOLResponse/consignee/state XMLBOLResponse/consignee/name XMLBOLResponse/consignee/zip XMLBOLResponse/consignee/ -address XMLBOLResponse/consignee/country XMLBOLResponse/consignee/city XMLBOLResponse/consignee/phone XMLBOLResponse/consignee/address XMLBOLResponse/consignee/id2 XMLBOLResponse/consignee/id1 XMLBOLResponse/consignee/company-name XMLBOLResponse/cod-payment-type XMLBOLResponse/carrier-name XMLBOLResponse/accessorial-list XMLBOLResponse/cod-payment-terms XMLBOLResponse/item-list XMLBOLResponse/item-list/weight XMLBOLResponse/freight-class XMLBOLResponse/package-type XMLBOLResponse/description XMLBOLResponse/pro-number XMLBOLResponse/payment-type XMLBOLResponse/payment-terms XMLBOLResponse/rate-items/commoditydescription XMLBOLResponse/rate-items/rate-per-cwt-amount XMLBOLResponse/rate-items/freight-class XMLBOLResponse/rate-items/weight-amount XMLBOLResponse/rate-items/fuel-surcharge XMLBOLResponse/rate-items/quote-number XMLBOLResponse/charges/chg-name XMLBOLResponse/charges/chg-amt XMLBOLResponse/transit-days XMLBOLResponse/third-party/state XMLBOLResponse/third-party/name XMLBOLResponse/third-party/zip XMLBOLResponse/third-party/ -address XMLBOLResponse/third-party/country XMLBOLResponse/third-party/city XMLBOLResponse/third-party/phone XMLBOLResponse/third-party/address XMLBOLResponse/third-party/id1 XMLBOLResponse/third-party/id2 XMLBOLResponse/third-party/company-name Example - XML Script: &payment_type=S &payment_terms=p&guarantee=n&servicing_carrier=fxf&shipper_nm=john Doe&shipper_addr1=123 Test Dr&shipper_city=Harrison&shipper_state=AR&shipper_zip=72602&shipper_ctry=US&shipper_ph n_ctry=us&consignee_nm=jane Smith&consignee_addr1=321 Easy St&consignee_city=Gulf Shores&consignee_state=AL&consignee_zip=36547&consignee_ctry=US&consignee_phn_ctry= US&detail_hu_1=2&detail_pk_type_1=PLT&detail_pcs_1=12&detail_class_1=050&detail_wt_1=1 500&detail_desc_1=Testing Supplies Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <XMLBOLResponse cod-amount="0.0"> - <shipper> <state>ar</state> <name>john Doe</name> <zip>72602</zip> < -address /> <country>us</country> <city>harrison</city> <phone /> <address>123 Test Dr</address> XML Solutions v /18/09

8 XML BOL Application <id2 /> <id1 /> <company-name>john Doe</company-name> </shipper> - <consignee> <state>al</state> <name>jane Smith</name> <zip>36547</zip> < -address /> <country>us</country> <city>gulf Shores</city> <phone /> <address>321 Easy St</address> <id2 /> <id1 /> <company-name>jane Smith</company-name> </consignee> <carrier-name>fedex Freight</carrier-name> - <item-list xmlns:xsi=" pieces-count="12" weight="1500" hazmat-flag="false" xsi:type="java:com.fedex.fxf.xml.bean.xmlbolresponselineitem"> <freight-class>050</freight-class> <package-type>plt</package-type> <description>testing Supplies</description> </item-list> <pro-number /> <payment-type>s</payment-type> <payment-terms>p</payment-terms> </XMLBOLResponse> Example - Error Response: If the system encounters an error it will return an XML formatted response in a single node < <?xml version="1.0" encoding="utf-8"?> - <BOL_REQUEST> <BOL_RESULTS /> <ERROR_CODE>0</ERROR_CODE> <ERROR_MESSAGES> Customer account number is required. </ERROR_MESSAGES> </BOL_REQUEST> XML Solutions v /18/09

9 XML Imaging Application Imaging Application URL: Parameters: The following list of parameters can be passed while sending an image request. Please refer to the examples for usage. Parameter regkey as_custnbr as_pro as_type as_format Description Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. Indicates the account number Indicates the pro number Indicates the document type [BL or DR] for Bill of Lading or Delivery Receipt Indicates the format [GIF, TIF, or PDF] Response Nodes: If request proceeds normally the server will return an XML document with the following nodes: ImageRequest/ProNumber ImageRequest/ImageType ImageRequest/NumPages ImageRequest/ImageData Example - XML Script: &as_custNbr=xxxxxxxx x&as_type=bl&as_format=pdf&as_pro=aaa &as_custNbr=xxxxxxxx& as_type=dr&as_format=pdf&as_pro= Example - Successful Response: <ImageRequest> <ProNumber>AAA </ProNumber> <ImageType>BL</ImageType> <NumPages>4</NumPages> <ImageData xmlns:dt="urn:schemas-microsoft-com:datatypes" dt:dt="bin.base64">sukqaagaaaasap4abaabaaaaaaaaaaabbaabaaaawayaa AEBBAABAAAAvQgAAAIBAwABAAAAAQAA AAMBAwABAAAABAAAAAYBAwABAAAAAAAAAAoBAwABAAAAAgAAABEBBAAB AAAA5gEAABIBAwABAAAA AAAA7gAAABwBAwABAAAAAQAAACgBAwABAAAAAgAAADIBAgAUAAAA9gAAAD OT1dCT1VORCwgQUxM IDIwMDYgU05PV0JPVU5ELCBBTEwgUklHSFRTIFJFU0VSVkVEAAAAAAAAAAAAAA AAAAAAAAAAAAAA </ImageData> </ImageRequest> Example - Error Response: If an error is encountered it will return an XML formatted response: <request-error> <messages xmlns:xsi=" xsi:type="java:java.lang.string">error validating shipment</messages> </request-error> <request-error> <messages xmlns:xsi=" xsi:type="java:java.lang.string">image not found</messages> </request-error> XML Solutions v /18/09

10 XML Pickup Application Pickup Application URL: Parameters: The following list of parameters can be passed while sending a pickup request. Fields with * are required fields. Optional fields are not required to be included in URL. Include an optional parameter key only if the value needs to be passed. Please refer to the examples for usage. Parameter Description *regkey Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. *servicing_carrier Company identifier [FXF or FXNL] *pkup_requestor_nm Pickup requestor name *pkup_requestor_phn_ctry Pickup requestor phone country code [US or MX] *pkup_requestor_phn_area_cd Pickup requestor phone area code *pkup_requestor_phn_exchng Pickup requestor phone exchange *pkup_requestor_phn_nbr Pickup requestor phone number *pkup_requestor_ Pickup requestor address *pkup_dt Pickup date (yyyy-mm-dd format) *dock_ready_tm Dock ready time *dock_close_tm Dock close time *shipper_nm Shipper name *shipper_addr1 Shipper address 1 *shipper_city Shipper city *shipper_state Shipper state *shipper_zip Shipper zip code *shipper_ctry Shipper country code [US, CA or MX] *shipper_phn_ctry Shipper phone country code [US or MX] *shipper_phn_area_cd Shipper phone area code *shipper_phn_exchng Shipper phone exchange *shipper_phn_nbr Shipper phone number *detail_ctry_1 Country code [US, CA or MX] See Notes Section N-1 *detail_zip_1 Zip code See Notes Section N-1 *detail_hu_1 Number of handling units See Notes Section N-1 *detail_pcs_1 Number of pieces See Notes Section N-1 *detail_class_1 Freight bill class [Standard FB classification codes] See Notes Section N-1 and N-2 *detail_wt_1 Weight See Notes Section N-1 *detail_pk_type_1 Package type [BDL', 'CTN', 'CRAT', 'DRM', 'LOOSE', 'PAL', 'PLT', or 'OTHER'] See Notes Section N-1 customer_nbr Account number special_instr Special instructions shipper_addr2 Shipper address 2 shipper_addr3 Shipper address 3 shipper_ Shipper shipper_phn_ext Shipper phone extension call_before_delivery Call before delivery [Y/N] residential_pickup Residential pickup [Y/N] residential_delivery Residential delivery [Y/N] limited_access_pickup Limited access pickup [Y/N] limited_access_delivery Limited access delivery [Y/N] do_not_break_down_pallets Do not break down pallets [Y/N] top_load_only Top load only [Y/N] poison Poison [Y/N] food Food [Y/N] XML Solutions v /18/09

11 XML Pickup Application freezable oversized liftgate_delivery_prepaid liftgate_delivery_collect liftgate_pickup_prepaid liftgate_pickup_collect inside_delivery_collect inside_delivery_prepaid inside_pickup_collect inside_pickup_prepaid do_not_stack Freezable [Y/N] Oversized [Y/N] Liftgate delivery prepaid [Y/N] Liftgate delivery collect [Y/N] Liftgate pickup prepaid [Y/N] Liftgate pickup collect [Y/N] Inside delivery collect [Y/N] Inside delivery prepaid [Y/N] Inside pickup collect [Y/N] Inside pickup prepaid [Y/N] Do not stack [Y/N] Notes: N-1 At least one complete detail line item (with all 7 required detail parameters) must be completed. You may have up to 50 line items. To add multiple line items, change the ending number on the parameters starting with detail. For example, detail_ctry_1 is the first line item, detail_ctry_2 becomes the second line item. N-2 Valid freight classes are: 050, 055, 060, 065, 070, 077, 085, 092, 100, 110, 125,150, 175, 200, 250, 300, 400 and 500 Response Nodes: If request proceeds normally the server will return an XML document with the following nodes: XMLPickupResponse/destination-information/total-weight XMLPickupResponse/destination-information/total-pieces XMLPickupResponse/destination-information/xsi:type XMLPickupResponse/destination-information/destination-service-center-id XMLPickupResponse/destination-information/destination-service-center-name XMLPickupResponse/destination-information/estimated-delivery-date XMLPickupResponse/shipper-name XMLPickupResponse/carrier-name XMLPickupResponse/origin-service-center-id XMLPickupResponse/confirmation-number XMLPickupResponse/pickup-date XMLPickupResponse/origin-service-center-name Example - XML Script: &servicing_carrie r=fxf&pkup_requestor_nm=john%20doe&pkup_requestor_phn_ctry=us&pkup_requestor_phn _area_cd=870&pkup_requestor_phn_exchng=741&pkup_requestor_phn_nbr=9000&pkup_reque stor_ [email protected]&pkup_dt= &dock_ready_tm=08:00&dock_close_tm=12:00&shipper_nm=Testing&shipper_addr1=123%20 Test%20Drive&shipper_city=Harrison&shipper_state=AR&shipper_zip=72602&shipper_ctry=US& shipper_phn_ctry=us&shipper_phn_area_cd=870&shipper_phn_exchng=741&shipper_phn_nbr= 9000&detail_ctry_1=US&detail_zip_1=36547&detail_hu_1=1&detail_pcs_1=1&detail_class_1=05 0&detail_wt_1=1500&detail_pk_type_1=PLT Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <XMLPickupResponse> - <destination-information xmlns:xsi=" totalweight="1500" total-pieces="1" xsi:type="java:com.fedex.fxf.xml.bean.xmlpickupresponsedestination"> <destination-service-center-id>mob</destination-service-center-id> <destination-service-center-name>mobile</destination-service-center-name> XML Solutions v /18/09

12 XML Pickup Application <estimated-delivery-date> </estimated-delivery-date> </destination-information> <shipper-name>testing</shipper-name> <carrier-name>fedex Freight</carrier-name> <origin-service-center-id>hro</origin-service-center-id> <confirmation-number> hro146589</confirmation-number> <pickup-date> </pickup-date> <origin-service-center-name>harrison</origin-service-center-name> </XMLPickupResponse> Example - Error Response: XML Solutions v /18/09

13 XML Rating Application Rating Application (City Name Required) URL: Parameters: The following list of parameters can be passed while sending a rating request. Fields with * are required fields. Optional fields are not required to be included in URL. Include an optional parameter key only if the value needs to be passed. Please refer to the examples for usage. Parameter Description *regkey Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. *as_opco Company (opco) identifier [FXF or FXNL] *as_iamthe Indicates the role of the requestor [shipper, consignee or billto] as_acctnbr Account number of the requestor *as_shipterms Terms of the shipment [prepaid or collect] as_guarantee Guaranteed delivery service for FedEx Freight or FedEx National LTL. [Y/N] *as_shzip Origin (shipper) 5 digit (US) 6 character (CA) zip code *as_shcntry Origin (shipper) country code [US or CA] *as_shcity Origin (shipper) city *as_shstate Origin (shipper) state two letter code *as_cnzip Destination (consignee) 5 digit (US) 6 character (CA) zip code *as_cncntry Destination (consignee) country code [US or CA] *as_cncity Destination (consignee) city *as_cnstate Destination (consignee) state two letter code as_billto_address Bill-to address - Required if ship terms are billto as_billto_city Bill-to city - Required if ship terms are billto as_billto_state Bill-to two letter state - Required if ship terms are billto as_billto_zip Bill-to zip - Required if ship terms are billto as_billto_country Bill-to country (US, MX, or CA) - Required if ship terms are billto *as_class1 Freight bill class [Standard FB classification codes] See Notes Section N-1 and N-2. *as_weight1 Weight. as_pkgtype1 package type ( SKID, CRAT, DRUM, BNDL, LOOS, CTN OR OTHR ) as_pcs1 piece count as_descr1 commodity description line as_nmfc1 National Motor Freight Classification number as_haz1 hazardous indicator [Y/N] as_decvalue Declared value of the shipment [#.##] as_units Number of handling units (Handling units require package type for freight items) as_codamount COD dollar amount to be collected [#.##] as_codfee COD terms (prepaid or collect) as_insidedelivery Indicates if this is an inside delivery and the terms (prepaid or collect) as_insidepickup Indicates if this is an inside pickup and the terms (prepaid or collect) as_residentialpickup Indicates if this a residential pickup [Y/N] as_residentialdelivery Indicates if this a residential delivery [Y/N] as_freezable Indicates if freezable protection is required [Y/N] as_callbefore Indicates if notification prior to delivery is required [Y/N] as_liftgate Indicates if a lift gate is required for pickup or delivery [Y/N] as_limitedaccesspickup Shipment requires limited access pickup [Y/N] as_limitedaccessdelivery Shipment requires limited access delivery [Y/N] XML Solutions v /18/09

14 XML Rating Application Notes: N-1 Valid freight classes are: 050, 055, 060, 065, 070, 077, 085, 092, 100, 110, 125,150, 175, 200, 250, 300, 400 and 500 N-2 Rating application can have up to 6 line items. To add multiple line items, change the ending number on the line item parameters. For example, as_class1 is the first line item, as_class2 becomes the second line item. Response Nodes: If rating proceeds normally the rating engine will return an XML document with the following nodes: customer-rate-response/discounts/disc-name customer-rate-response/discounts/disc-amount customer-rate-response/discounts/disc-desc customer-rate-response/fuel-surcharge-percent customer-rate-response/rate-items/nmfcnumber customer-rate-response/rate-items/commodity-description customer-rate-response/rate-items/rate-per-cwt-amount customer-rate-response/rate-items/freight-class customer-rate-response/rate-items/weight-amount customer-rate-response/charges/chg-name customer-rate-response/charges/chg-amt customer-rate-response/rate-number customer-rate-response/ltlfuelsurcharge customer-rate-response/net-freight-charges customer-rate-response/transit-days Example - XML Script: &as_opco=FXF&a s_iamthe=shipper&as_shipterms=prepaid&as_shzip=91761&as_shcntry=us&as_shcity=ontario& as_shstate=ca&as_cnzip=55420&as_cncntry=us&as_cncity=bloomington&as_cnstate=mn&as_c lass1=100&as_weight1= &as_opco=FXNL& as_iamthe=shipper&as_shipterms=prepaid&as_shzip=38112&as_shcntry=us&as_shcity=memp his&as_shstate=tn&as_cnzip=55420&as_cncntry=us&as_cncity=bloomington&as_cnstate=mn& as_class1=100&as_weight1=2500 Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <customer-rate-response> - <rate-items xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.rateitem"> <NMFCNumber /> <commodity-description>no DESCRIPTION</commodity-description> <rate-per-cwt-amount>80.38</rate-per-cwt-amount> <freight-class>100</freight-class> <weight-amount>2500.0</weight-amount> </rate-items> <rate-number>nd </rate-number> <LTLFuelSurcharge>332.77</LTLFuelSurcharge> <net-freight-charges> </net-freight-charges> <transit-days>3</transit-days> </customer-rate-response> XML Solutions v /18/09

15 XML Rating Application Example - Error Response: If the rating engine encounters an error it will return an XML formatted response: <?xml version="1.0" encoding="utf-8"?> <request-error> <title>rating Error</title> <messages xmlns:xsi= xsi:type="java:java.lang.string">shipping terms are required </messages> </request-error> XML Solutions v /18/09

16 XML Rating Application Rating Application (City Name NOT Required) This XML Rating application is identical to XML LTL Rating but the interface does not require the city/state for either origin or destination. The system will lookup and utilize the city/state information from the FedEx Freight system. Please note that without specific city/state information, your rate may not accurately reflect the origin or destination FedEx Freight or FedEx National LTL services. URL: Parameters: The following list of parameters can be passed while sending a rating request. Fields with * are required fields. Optional fields are not required to be included in URL. Include an optional parameter key only if the value needs to be passed. Please refer to the examples for usage. Parameter Description *regkey Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. *as_opco Company (opco) identifier [FXF or FXNL] *as_iamthe Indicates the role of the requestor [shipper, consignee or billto] as_acctnbr Account number of the requestor *as_shipterms Terms of the shipment [prepaid or collect] as_guarantee Guaranteed delivery service for FedEx Freight or FedEx National LTL. [Y/N] *as_shzip Origin (shipper) 5 digit (US) 6 character (CA) zip code *as_shcntry Origin (shipper) country code [US or CA] as_shcity Origin (shipper) city as_shstate Origin (shipper) state two letter code *as_cnzip Destination (consignee) 5 digit (US) 6 character (CA) zip code *as_cncntry Destination (consignee) country code [US or CA] as_cncity Destination (consignee) city as_cnstate Destination (consignee) state two letter code as_billto_address Bill-to address - Required if ship terms are billto as_billto_city Bill-to city - Required if ship terms are billto as_billto_state Bill-to two letter state - Required if ship terms are billto as_billto_zip Bill-to zip - Required if ship terms are billto as_billto_country Bill-to country (US, MX, or CA) - Required if ship terms are billto *as_class1 Freight bill class [Standard FB classification codes] See Notes Section N-1 and N-2. *as_weight1 Weight. as_pkgtype1 package type ( SKID, CRAT, DRUM, BNDL, LOOS, CTN OR OTHR ) as_pcs1 piece count as_descr1 commodity description line as_nmfc1 National Motor Freight Classification number as_haz1 hazardous indicator [Y/N] as_decvalue Declared value of the shipment [#.##] as_units Number of handling units (Handling units require package type for freight items) as_codamount COD dollar amount to be collected [#.##] as_codfee COD terms (prepaid or collect) as_insidedelivery Indicates if this is an inside delivery and the terms (prepaid or collect) as_insidepickup Indicates if this is an inside pickup and the terms (prepaid or collect) as_residentialpickup Indicates if this a residential pickup [Y/N] as_residentialdelivery Indicates if this a residential delivery [Y/N] as_freezable Indicates if freezable protection is required [Y/N] XML Solutions v /18/09

17 XML Rating Application as_callbefore Indicates if notification prior to delivery is required [Y/N] as_liftgate Indicates if a lift gate is required for pickup or delivery [Y/N] as_limitedaccesspickup Shipment requires limited access pickup [Y/N] as_limitedaccessdelivery Shipment requires limited access delivery [Y/N] Notes: N-1 Valid freight classes are: 050, 055, 060, 065, 070, 077, 085, 092, 100, 110, 125,150, 175, 200, 250, 300, 400 and 500 N-2 Rating application can have up to 6 line items. To add multiple line items, change the ending number on the line item parameters. For example, as_class1 is the first line item, as_class2 becomes the second line item. Response Nodes: If rating proceeds normally the rating engine will return an XML document with the following nodes: customer-rate-response/discounts/disc-name customer-rate-response/discounts/disc-amount customer-rate-response/discounts/disc-desc customer-rate-response/fuel-surcharge-percent customer-rate-response/rate-items/nmfcnumber customer-rate-response/rate-items/commodity-description customer-rate-response/rate-items/rate-per-cwt-amount customer-rate-response/rate-items/freight-class customer-rate-response/rate-items/weight-amount customer-rate-response/charges/chg-name customer-rate-response/charges/chg-amt customer-rate-response/rate-number customer-rate-response/ltlfuelsurcharge customer-rate-response/net-freight-charges customer-rate-response/transit-days Example - XML Script: &as_opco=FXF&a s_iamthe=shipper&as_shipterms=prepaid&as_shzip=91761&as_shcntry=us&as_cnzip=55420&a s_cncntry=us&as_class1=100&as_weight1= &as_opco=FXNL& as_iamthe=shipper&as_shipterms=prepaid&as_shzip=38112&as_shcntry=us&as_cnzip=55420& as_cncntry=us&as_class1=100&as_weight1=2500 Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <customer-rate-response> <fuel-surcharge-percent>13.1</fuel-surcharge-percent> - <rate-items xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.rateitem"> <NMFCNumber /> <commodity-description>no DESCRIPTION</commodity-description> <rate-per-cwt-amount>50.01</rate-per-cwt-amount> <freight-class>050</freight-class> <weight-amount>1000.0</weight-amount> </rate-items> - <charges xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.ratecharges"> <chg-name>residential pickup</chg-name> XML Solutions v /18/09

18 XML Rating Application <chg-amt>80.0</chg-amt> </charges> - <charges xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.ratecharges"> <chg-name>residential delivery</chg-name> <chg-amt>80.0</chg-amt> </charges> <rate-number>nd </rate-number> <LTLFuelSurcharge>65.52</LTLFuelSurcharge> <net-freight-charges>725.62</net-freight-charges> <transit-days>2</transit-days> </customer-rate-response> Example - Error Response: If the rating engine encounters an error it will return an XML formatted response: <?xml version="1.0" encoding="utf-8"?> <request-error> <title>rating Error</title> <messages xmlns:xsi= xsi:type="java:java.lang.string">shipping terms are required </messages> </request-error> XML Solutions v /18/09

19 XML Transit Time Application Transit Time Application URL: Parameters: The following list of parameters can be passed while sending a transit time request. Fields with * are required fields. Optional fields are not required to be included in URL. Include an optional parameter key only if the value needs to be passed. Please refer to the examples for usage. Parameter *regkey *as_orig_zip *as_dest_zip *as_orig_cnty *as_dest_cnty *as_opco as_orig_city as_dest_city as_orig_state as_dest_state Description Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. Origin zipcode for lane lookup Destination zipcode for lane lookup Origin country code [US, CA, or MX] Destination country code [US, CA, or MX] Company (opco) identifier [FXF or FXNL] As some postal codes fall among multiple city/states, this field may be required for a successful request. As some postal codes fall among multiple city/states, this field may be required for a successful request. As some postal codes fall among multiple city/states, this field may be required for a successful request. As some postal codes fall among multiple city/states, this field may be required for a successful request. Response Nodes: If lookup proceeds normally the rating engine will return an XML document with the following nodes: lane-service-response/dest-zip lane-service-response/dest-term-phone lane-service-response/origin-term-city lane-service-response/origin-service-type lane-service-response/origin-zip lane-service-response/dest-term-city lane-service-response/service-days lane-service-response/origin-term-address lane-service-response/dest-service-type lane-service-response/dest-term-zip lane-service-response/company lane-service-response/origin-term-zip lane-service-response/origin-term-phone Example - XML Script: &as_orig_zip=94 545&as_dest_zip=55113&as_opco=FXNL Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <lane-service-response> <dest-zip>55113</dest-zip> <dest-term-phone> </dest-term-phone> <origin-term-city>san LEANDRO</origin-term-city> <origin-service-type>(direct)</origin-service-type> <origin-zip>94545</origin-zip> <dest-term-city>roseville</dest-term-city> XML Solutions v /18/09

20 XML Transit Time Application <service-days>4</service-days> <origin-term-address>549 MONTAGUE STREET</origin-term-address> <dest-service-type>(direct)</dest-service-type> <dest-term-zip>55113</dest-term-zip> <company>fedex National LTL</company> <dest-term-address>2560 LONG LAKE ROAD</dest-term-address> <origin-term-zip>94577</origin-term-zip> <origin-term-phone> </origin-term-phone> </lane-service-response> Example - Error Response: If an error is encountered it will return an XML formatted response: <?xml version="1.0" encoding="utf-8"?> - <request-error> <messages xmlns:xsi=" xsi:type="java:java.lang.string">destination zipcode is invalid</messages> </request-error> XML Solutions v /18/09

21 XML City Lookup Application City Lookup Application Some FedEx Freight XML applications require city and state for accurate matches within the system. This service will lookup any city and state found in the FedEx Freight system that matches a passed in zip code and country. URL: Parameter: The following list of parameters can be passed while sending a city lookup request. Please refer to the examples for usage. Parameter regkey as_zip as_cntry Description Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. Zip code, required Country code for the lookup (US, CA) Response Nodes: zip-city/results/xsi:type zip-city/results/state zip-city/results/city Example - XML Script: &as_zip=72 601&as_cntry=us Example - Successful Response: <?xml version="1.0" encoding="utf-8"?> - <zip-city> - <results xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.cityresult"> <state>ar</state> <city>batavia</city> </results> - <results xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.cityresult"> <state>ar</state> <city>bellefonte</city> </results> - <results xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.cityresult"> <state>ar</state> <city>boone COUNTY AIRPORT</city> </results> - <results xmlns:xsi=" xsi:type="java:com.fedex.fxf.xml.bean.cityresult"> <state>ar</state> <city>harrison</city> </results> </zip-city> XML Solutions v /18/09

22 XML Tracking Application Tracking Application URL: Parameter: The following list of parameters can be passed while sending a tracking request. Please refer to the examples for usage. Parameter regkey as_pro as_suffix as_typecode as_refnumber as_zipcode as_startdate as_enddate as_custnbr Description Personal registration key provided to you by FedEx Freight Technical Support when registering for this service. PRO number for which tracking results are desired. Pro suffix for which tracking results are desired. Document type matching the reference number (BOL or PO) Alternate tracking number. To use, do not send in a pro number. Shipper zip code, required when using alternate reference number Beginning date range for lookup, required when using alternate reference number (yyyy-mm-dd format) Ending date range for lookup, required when using alternate reference number (yyyy-mm-dd format) Customer number of shipment debtor, will result in display of charges. Response Nodes: TRACKING_STATUS/ERROR_CODE TRACKING_STATUS/ERROR_MESSAGE TRACKING_STATUS/TRACKING_NUMBER TRACKING_STATUS/PRO_NUMBER SUFFIX TRACKING_STATUS/SUB_PARTS TRACKING_STATUS//PO_NUMBER TRACKING_STATUS//BOL_NUMBER TRACKING_STATUS/SHIPPER_NAME TRACKING_STATUS/ SHIPPER_ADDRESS1 TRACKING_STATUS/ SHIPPER_ADDRESS2 TRACKING_STATUS/ SHIPPER_ADDRESS3 TRACKING_STATUS/ SHIPPER_CITY TRACKING_STATUS/ SHIPPER_STATE TRACKING_STATUS/SHIPPER_ZIP TRACKING_STATUS/CONSIGNEE_NAME TRACKING_STATUS/CONSIGNEE_ADDRESS1 TRACKING_STATUS/CONSIGNEE_ADDRESS2 TRACKING_STATUS/CONSIGNEE_ADDRESS3 TRACKING_STATUS/CONSIGNEE_CITY TRACKING_STATUS/CONSIGNEE_STATE TRACKING_STATUS/CONSIGNEE_ZIP TRACKING_STATUS/ORIGIN_SERVICE_CENTER TRACKING_STATUS/ORIGIN_SERVICE_CENTER_LINK TRACKING_STATUS/DESTINATION_SERVICE_CENTER TRACKING_STATUS/DESTINATION_SERVICE_CENTER_LINK TRACKING_STATUS/PICKUP_DATE TRACKING_STATUS/ESTIMATED_DELIVERY_DATE TRACKING_STATUS/DELIVERY_STATUS_CODE TRACKING_STATUS/DELIVERY_STATUS_DESC TRACKING_STATUS/IS_APPT_DATE TRACKING_STATUS/DELIVERY_DATE TRACKING_STATUS/DELIVERY_TIME TRACKING_STATUS/SHIPMENT_DELIVERED_FLAG TRACKING_STATUS/FORMATTED_DELIVERY_DATE XML Solutions v /18/09

23 XML Tracking Application TRACKING_STATUS/DELIVERY_SIGNATURE TRACKING_STATUS/SHIPMENT_WEIGHT TRACKING_STATUS/SHIPMENT_TOTAL_PIECES TRACKING_STATUS/OSD_DESCRIPTION TRACKING_STATUS/FXF_CARRIER_NAME TRACKING_STATUS/PARTNER_CARRIER_NAME TRACKING_STATUS/PARTNER_CARRIER_PRO TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/STATUS_CODE TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/STATUS_DESCRIPTION TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/LOCATION TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/DATE TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/TIME TRACKING_STATUS/MOVEMENT_HISTORY/SCAN/COMMENTS Example - XML Script: &as_pro=orl Example - Successful Response: If tracking proceeds normally the engine will return an XML document according to the following structure: <?xml version="1.0" encoding="utf-8"?> - <TRACKING_STATUS> <ERROR_CODE>0</ERROR_CODE> <ERROR_MESSAGE /> <TRACKING_NUMBER>AAA </TRACKING_NUMBER> <PRO_NUMBER SUFFIX="R0">AAA </PRO_NUMBER> <SUB_PARTS /> <PO_NUMBER>NA</PO_NUMBER> <BOL_NUMBER>JK12345</BOL_NUMBER> - <SHIPPER_NAME> - <![CDATA[ JOHN DOE INC ]]> </SHIPPER_NAME> <SHIPPER_ADDRESS1 /> <SHIPPER_ADDRESS2>3600 E COMMERCE PL</SHIPPER_ADDRESS2> <SHIPPER_ADDRESS3 /> <SHIPPER_CITY>ORLANDO</SHIPPER_CITY> <SHIPPER_STATE>FL</SHIPPER_STATE> <SHIPPER_ZIP>32808</SHIPPER_ZIP> - <CONSIGNEE_NAME> - <![CDATA[ JANE SMITH CO ]]> </CONSIGNEE_NAME> <CONSIGNEE_ADDRESS1 /> <CONSIGNEE_ADDRESS2>3300 JAMBOREE RD</CONSIGNEE_ADDRESS2> <CONSIGNEE_ADDRESS3 /> <CONSIGNEE_CITY>NEWPORT BEACH</CONSIGNEE_CITY> <CONSIGNEE_STATE>CA</CONSIGNEE_STATE> <CONSIGNEE_ZIP>92660</CONSIGNEE_ZIP> <ORIGIN_SERVICE_CENTER>ORLANDO</ORIGIN_SERVICE_CENTER> - <ORIGIN_SERVICE_CENTER_LINK> - <![CDATA[ <a href=' '>ORLANDO, FL</a> ]]> </ORIGIN_SERVICE_CENTER_LINK> XML Solutions v /18/09

24 XML Tracking Application <DESTINATION_SERVICE_CENTER>ORANGE COUNTY</DESTINATION_SERVICE_CENTER> - <DESTINATION_SERVICE_CENTER_LINK> - <![CDATA[ <a href=' G'>ORANGE COUNTY, CA</a> ]]> </DESTINATION_SERVICE_CENTER_LINK> <PICKUP_DATE> </PICKUP_DATE> <ESTIMATED_DELIVERY_DATE /> <DELIVERY_STATUS_CODE /> <DELIVERY_STATUS_DESC>Delivered</DELIVERY_STATUS_DESC> <IS_APPT_DATE>0</IS_APPT_DATE> <DELIVERY_DATE> </DELIVERY_DATE> <DELIVERY_TIME>00:27:00</DELIVERY_TIME> <SHIPMENT_DELIVERED_FLAG>true</SHIPMENT_DELIVERED_FLAG> <FORMATTED_DELIVERY_DATE> </FORMATTED_DELIVERY_DATE> <DELIVERY_SIGNATURE /> <SHIPMENT_WEIGHT>640</SHIPMENT_WEIGHT> <SHIPMENT_TOTAL_PIECES>18</SHIPMENT_TOTAL_PIECES> <OSD_DESCRIPTION>NONE</OSD_DESCRIPTION> <FXF_CARRIER_NAME>FEDEX NATIONAL LTL</FXF_CARRIER_NAME> <PARTNER_CARRIER_NAME /> <PARTNER_CARRIER_PRO /> - <MOVEMENT_HISTORY> - <SCAN> <STATUS_CODE>DL</STATUS_CODE> <STATUS_DESCRIPTION>UNKNOWN</STATUS_DESCRIPTION> <LOCATION /> <DATE> </DATE> <TIME>12:27:00</TIME> <COMMENTS /> </SCAN> - <SCAN> <STATUS_CODE>OD</STATUS_CODE> <STATUS_DESCRIPTION>OUT FOR DELIVERY</STATUS_DESCRIPTION> <LOCATION>ORANGE, CA</LOCATION> <DATE> </DATE> <TIME>07:44:01</TIME> <COMMENTS>On trailer Manifest Number AAA </COMMENTS> </SCAN> - <SCAN> <STATUS_CODE>M</STATUS_CODE> <STATUS_DESCRIPTION>MANIFESTED</STATUS_DESCRIPTION> <LOCATION>ORANGE, CA</LOCATION> <DATE> </DATE> <TIME>00:37:33</TIME> <COMMENTS>On trailer 12345</COMMENTS> </SCAN> - <SCAN> <STATUS_CODE>AR</STATUS_CODE> <STATUS_DESCRIPTION>ARRIVED</STATUS_DESCRIPTION> <LOCATION>ORANGE, CA</LOCATION> <DATE> </DATE> <TIME>22:09:21</TIME> XML Solutions v /18/09

25 XML Tracking Application <COMMENTS>On trailer 12345</COMMENTS> </SCAN> - <SCAN> <STATUS_CODE>IT</STATUS_CODE> <STATUS_DESCRIPTION>IN TRANSIT</STATUS_DESCRIPTION> <LOCATION>MIRA LOMA, CA</LOCATION> <DATE> </DATE> <TIME>21:08:08</TIME> <COMMENTS>On trailer 12345</COMMENTS> </SCAN> - <SCAN> <STATUS_CODE>DI</STATUS_CODE> <STATUS_DESCRIPTION>DISPATCHED</STATUS_DESCRIPTION> <LOCATION>ORLANDO, FL</LOCATION> <DATE> </DATE> <TIME>12:38:13</TIME> <COMMENTS>On trailer 12345</COMMENTS> </SCAN> - <SCAN> <STATUS_CODE>PKUP</STATUS_CODE> <STATUS_DESCRIPTION>PICKED UP</STATUS_DESCRIPTION> <LOCATION>ORLANDO, FL</LOCATION> <DATE> </DATE> <TIME>17:00:00</TIME> <COMMENTS>On trailer 12345</COMMENTS> </SCAN> </MOVEMENT_HISTORY> </TRACKING_STATUS> XML Solutions v /18/09

26 XML Terms of Use Terms of Use for Plug-In to fedexfreight.fedex.com Your use of any information and XML or other code (collectively "Code") provided at this site constitutes your agreement to the following terms and the fedexfreight.fedex.com terms of use linked below. The information and Code on this site are provided by FedEx Freight ("FedEx") on a royalty-free, nonexclusive basis to assist with your efforts to access FedEx Freight delivery services. The information and Code provided at this site may change without notice, and this site and your use of any information or Code on this site may be terminated or discontinued at any time without notice. Use of the information and Code is at your sole risk and expense. FEDEX EXPRESSLY DISCLAIMS AND EXCLUDES ALL WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. FEDEX DOES NOT WARRANT THAT THE INFORMATION OR CODE WILL MEET ALL YOUR REQUIREMENTS, WILL BE ERROR FREE, OR THAT ANY DEFECT WILL BE CORRECTED. FEDEX DOES NOT WARRANT NOR MAKE ANY REPRESENTATIONS REGARDING THE RESULTS OF YOUR USE OF THE INFORMATION OR CODE IN TERMS OF CAPABILITY, CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE. UNDER NO CIRCUMSTANCES, INCLUDING BUT NOT LIMITED TO NEGLIGENCE, SHALL FEDEX, ITS PARENT OR AFFILIATE COMPANIES, OR THEIR RESPECTIVE EMPLOYEES, AGENTS OR REPRESENTATIVES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES IN TORT, CONTRACT, PRODUCT LIABILITY OR UNDER ANY OTHER THEORY OF LAW RESULTING FROM YOUR USE OF, OR INABILITY TO USE, THE INFORMATION OR CODE INCLUDING, WITHOUT LIMITATION, DAMAGES RESULTING FROM LOSS OF USE, PROFITS, DATA, OR BUSINESS, AND DAMAGE TO YOUR INTERNAL COMPUTER SYSTEMS. You agree to indemnify, defend and hold harmless FedEx, its parent and affiliate companies, and their respective employees, agents and representatives from any and all claims, demands, damages (including incidental and consequential damages), costs, expenses, suits and liabilities (collectively "Claims") including the payment of reasonable attorney fees arising out of your or your customers' use of the information and Code provided at this site. XML Solutions v /18/09