External Linkage

Transcription

1 External Linkage API Version 1.1 September 30, 2003 Page 1 of 5

2 SECTION 1 External Access External Request Documentation The External request system has been provided to enable external customers to auto populate the shipment preparation form. This is accomplished by sending the shipment request to the system by data embedded in a URL request. The variable names and definitions are as follows. Optional values are in red text. companyname suitedept address1 address2 city state zip attn receiverphone notes sentby senderphone servicetype shipmentreference - Name of the company the shipment is being sent to - Suite number or department name of the receiving company - First address line for the receiving company - Second address line for the receiving company - City name for the receiving company - Two letter abbreviation for the receiving company - Zip code for the receiving company - Attention To - Receiver s telephone number - Recipients address - Notes you wish included on the airbill - Name of sending entity - Sender s telephone number - Type of service being requested (valid values GND, NAS, EXP, SDS) - Free form shipment ref field This request can be sent by either an HTTP GET or POST operation to the following URL: Development Design&address1=5615 NW Central Drive&suiteDept=Suite C107&city=Houston&state=TX&zip=77092&serviceType=GND Making this request will start the airbill generation process. You will still have to authenticate yourself at the requested dialog, and click on Print Airbill when presented with the create shipment page. Page 2 of 5

3 Rate Matrix Access API The external rate matrix access has been provided for customers using a third party online ordering or shopping cart system. It provides estimated costs for each of the 4 service levels, in a comma-separated format. In order to retrieve rates, 4 pieces of information need to be provided. fromzip tozip weight acctnum length width height res insurance - Origin zip code - Destination zip code - Package weight, for letter, use weight=0 - Account number requesting rates - package length (optional) - package width (optional) - package height (optional) - if address is a residential address (res = true) (optional) - Additional Protection (insurance) amount(optional) This request can be sent by either an HTTP GET or POST operation to the following URL: &acctnum= &res=true&length=0&width=0&height=0&insurance=100 Making this request will return two lines of comma separated data. The first line is the service level, and the second line is the corresponding pricing. For example GND, NAS, SDS, EXP $6.50, $12.25, $7.85, $14.00 Anyone who prefers not to process this data and display it in their own format may use to have it displayed in an HTML table. ht=0&acctnum= The data will be outputted in HTML table cells like this: Rate for this item to zip code Express Next Afternoon Second Day Ground Page 3 of 5

4 $13.99 $12.88 $7.15 $3.91 Page 4 of 5

5 SECTION 2 - Notifications XML Shipment Notification For customers that wish to receive automated notifications that a shipment has been generated, we offer an XML notification API that enables our system to send an XML message to a URL specified by the customer. This allows the customer to be sent information such as the airbill number, shipment reference, and a cost estimate whenever a shipment is generated using their account. The XML document is defined below. Shipment Node Description 1 - * Required Size Shipment/Airbill Airbill number of the generated shipment 1 Required 0-15 Text Shipment/ShipmentReference Free-form shipment reference field entered by customer 1 Required Text Shipment/Estimate Rate and service estimate 1 Required 0-8 Numeric EXAMPLE: <Shipment> <Airbill> </Airbill> <ShipmentReference>Customer 123 Order Number 456</ShipmentReference> <Estimate>10.55</Estimate> </Shipment> This XML notification will be sent to a customer provided URL via an HTTP POST operation. The URL that this data is sent to can reside on any web server within any organization that is publicly accessible. URL Shipment Notification Another way to receive shipment notification is by URL. When a shipment is generated, our system will make a request to a URL provided by the customer. This URL will have several parameters airbill shipmentreference estimate - Airbill number of generated shipment - Reference field of generated shipment - Estimated shipping costs These parameters will be passed to a customer-provided URL to form a complete URL string that resembles the following: rence=00000&estimate=12.35 Page 5 of 5