- 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 - ups [2016/09/14 18:19] |
enterprise service bus - ups [2016/09/14 18:19] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ===== Purpose ===== | ||
+ | This [[Enterprise Service Bus]] system allows a Software Developer to generate a UPS Shipping Label and retrieve the shipping rate and tracking number. | ||
+ | ===== End User Experience ===== | ||
+ | A User of a WorkXpress Application that utilizes the UPS Enterprise Service Bus functionality will need to go to www.ups.com and sign up for a UPS Account. | ||
+ | |||
+ | ===== What Data is sent to UPS? ===== | ||
+ | |||
+ | The following pieces of data are sent to FedEx: | ||
+ | |||
+ | * **API Key** - The API Key is the key authorizing the use of the UPS API. | ||
+ | * **UPS Username** - The UPS Username of the ups account that will be sending the package | ||
+ | * **UPS Password** - The UPS Password is used to login to the UPS API. | ||
+ | * **UPS Account Number** - This is the UPS Account Number that will be used to pay for the shipping. | ||
+ | * **Delivery Service** - This is the type of Delivery being requested | ||
+ | * **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 | ||
+ | * **Package Length** - This is the length of the package | ||
+ | * **Package Width** - This is the width of the package | ||
+ | * **Package Height** - This is the height of the package | ||
+ | * **Dimensions Unit** - This the the unit used for the length, width, and height measurements | ||
+ | * **Shipper Name** - This is the full name of the shipping person or the name of the shipping company | ||
+ | * **Shipper Phone** - This is the shipper's phone number | ||
+ | * **Shipper Phone Extension** - This is the shipper's phone number extension | ||
+ | * **Shipper Address Line 1** - The first 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 Name** - This is the full name of the recipient person or the name of the receiving company | ||
+ | * **Recipient Attention Name** - This is the attention line for a recipient (required for some delivery types) | ||
+ | * **Recipient Phone** - This is the recipient's phone number | ||
+ | * **Recipient Phone Extension** - This is the recipient's phone number extension | ||
+ | * **Recipient Address Line 1** - The first 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 | ||
+ | |||
+ | ===== 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 - UPS Label|UPS Label]] |