- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
enterprise service bus - fedex [2016/09/14 18:19] |
enterprise service bus - fedex [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ===== Purpose ===== | ||
| + | This [[Enterprise Service Bus]] system allows a Software Developer to generate a FedEx Shipping Label and retrieve the shipping rate and tracking number. | ||
| + | ===== Accounts and End User Experience ===== | ||
| + | A User of a WorkXpress Application that utilizes the FedEx Enterprise Service Bus functionality will need to go to www.fedex.com and sign up for a FedEx Developer Account. This account will have Fedex API Keys associated with it, for use to generate your test labels. WorkXpress Applications in Development and Testing are setup to send their label requests to Fedex's Development/Sandbox environment. | ||
| + | |||
| + | Once the ESB is setup and the WorkXpress Application can generate a label this User will need to go through the Fedex label Certification process the to verify the quality of the label printer. When this certification is past, a new Fedex account will be issued with Production-ready API Keys. These keys will need to be used in the WorkXpress Application in Production to produce real Fedex labels that will be valid and work for shipping packages. | ||
| + | |||
| + | ===== What Data is sent to FedEx? ===== | ||
| + | |||
| + | The following pieces of data are sent to FedEx: | ||
| + | |||
| + | * **User Credential Key** - The FedEx User Credential Key is the key authorizing the use of the FedEx API. | ||
| + | * **User Credential Password** - The FedEx User Credentials Password is used to login to the FedEx API. | ||
| + | * **FedEx Account Number** - This is the FedEx Account Number that will be used to pay for the shipping. | ||
| + | * **FedEx Meter Number** - This is the FedEx Meter Number associated with the FedEx Account | ||
| + | * **Delivery Service** - This is the type of Delivery being requested | ||
| + | * **Signature** - This is the type of signature required by the recipient | ||
| + | * **Packaging Type** - This is the type of packaging used for a package | ||
| + | * **Weight** - This is the total weight of the shipment | ||
| + | * **Weight Unit** - This is the unit for the weight of the shipment | ||
| + | * **Shipper Person Name** - This is the full name of the shipping person (Required if no shipping company name is provided) | ||
| + | * **Shipper Company Name** - This is the company name of the shipper (Required if no shipping person name is provided) | ||
| + | * **Shipper Phone** - This is the shipper's phone number | ||
| + | * **Shipper Address Line 1** - The first line of the shipper's address | ||
| + | * **Shipper Address Line 2** - The second line of the shipper's address | ||
| + | * **Shipper Address Line 3** - The third line of the shipper's address | ||
| + | * **Shipper City** - The city portion of the shipper's address | ||
| + | * **Shipper State or Province** - The state or city portion of the shipper's address | ||
| + | * **Shipper Postal Code** - The postal code portion of the shipper's address | ||
| + | * **Shipper Country** - The country portion of the shipper's address | ||
| + | * **Recipient Person Name** - This is the full name of the recipient person (Required if no recipient company name is provided) | ||
| + | * **Recipient Company Name** - This is the company name of the recipient (Required if no recipient person name is provided) | ||
| + | * **Recipient Phone** - This is the recipient's phone number | ||
| + | * **Recipient Address Line 1** - The first line of the recipient's address | ||
| + | * **Recipient Address Line 2** - The second line of the recipient's address | ||
| + | * **Recipient Address Line 3** - The third line of the recipient's address | ||
| + | * **Recipient City** - The city portion of the recipient's address | ||
| + | * **Recipient State or Province** - The state or city portion of the recipient's address | ||
| + | * **Recipient Postal Code** - The postal code portion of the recipient's address | ||
| + | * **Recipient Country** - The country portion of the recipient's address | ||
| + | * **Recipient Residential** - A YES or NO flag identifying if the recipient's address is residential. | ||
| + | |||
| + | ===== Data Handlers ===== | ||
| + | |||
| + | The data handler selection for an Outgoing ESB Profile will determine what helpers and configuration is needed and or available. | ||
| + | |||
| + | * [[Enterprise Service Bus Data Handler - FedEx Label|FedEx Label]] | ||
