generated from axonivy-market/market-product
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
1 changed file
with
28 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,93 +1,74 @@ | ||
| # UPS Modules | ||
|
|
||
| ## Description | ||
| This is a UPS module built in the Axon Ivy framework, enabling users to seamlessly integrate with UPS services. With this app, users can effortlessly manage their packages through UPS. | ||
|
|
||
| This is a UPS modules made in Axon Ivy framework. It allows users to quickly and easily integrate with UPS Service. With this App, users can effortlessly manage their packages from UPS. | ||
| With this connector: | ||
| - Empowers you with full access to the OpenAPI UPS services. | ||
| - Provides an easy-to-copy demo implementation to streamline your integration efforts. | ||
| - Gives you full power to the OpenAPI UPS services. | ||
| - Supports you with an easy-to-copy demo implementation to reduce your integration effort. | ||
|
|
||
| The UPS modules comprises the following components: | ||
| UPS modules contains: | ||
| - ups-connector | ||
| - ups-oauth-feature | ||
| - ups-connector-demo | ||
| - ups-connector-product | ||
| - ups-connector-test | ||
|
|
||
| Common use cases for UPS APIs include: | ||
| - Shipping and tracking packages for your business. | ||
| - Obtaining shipping rates and transit times for e-commerce. | ||
| - Creating visibility applications for your customers on your platform. | ||
| Common use cases for UPS APIs: | ||
| - Shipping and tracking packages for your business | ||
| - Obtaining shipping rates and time in transit for ecommerce | ||
| - Creating visibility applications for your customers on your platform | ||
|
|
||
| Explore the [API catalog](https://developer.ups.com/catalog) to identify which APIs align with your business needs. | ||
| We hope you enjoy using this module, and we look forward to your contributions! | ||
| View the [API catalog](https://developer.ups.com/catalog) to identify which APIs meet your business needs. | ||
| We hope you enjoy and we look forward to your contributions! | ||
|
|
||
| ## Set up | ||
|
|
||
| 1. Visit https://developer.ups.com, log in, or create a new UPS accoun. | ||
| 2. Create an application on UPS | ||
| 3. Once your application is created, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token for authorizing your API requests | ||
| 1. Go to https://developer.ups.com, login or create a new UPS account. | ||
| 2. Create an Application on UPS | ||
| 3. After creating your application, the **Client ID** and **Client Secret** are generated and can be used to obtain an access token to authorize your API requests | ||
| 4. Configure the following variables in your project: | ||
|  | ||
|  | ||
|
|
||
|
|
||
|
|
||
| ## Demo | ||
| ### Get tracking information | ||
| This service is used to retrieve package information. | ||
| This service is used to retrieve package information | ||
| 1. Login to the Axon Ivy Portal | ||
| 2. On the Process List page, click on **Get Tracking** | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 3. Fill in your tracking number | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 4. Click **Search** button to get all information of the package | ||
|
|
||
|  | ||
|  | ||
|
|
||
| ### Pickup Creation | ||
| This service is used to schedule pickups. | ||
| This service is used to schedule pickups | ||
| 1. Login to the Axon Ivy Portal | ||
| 2. On the Process List page, click on **Pickup Creation** | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 3. Fill in required fields | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 4. Click **Process** button to schedule pickups | ||
|
|
||
|  | ||
|  | ||
|
|
||
|
|
||
|
|
||
| ### Pickup cancel | ||
| This service is used to cancel previously scheduled pickups. | ||
| This service is used to cancel previously scheduled pickups | ||
| 1. Login to the Axon Ivy Portal | ||
| 2. On the Process List page, click on **Pickup Creation** | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 3. Fill in required fields | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 4. Click **Cancel** button to finish | ||
|
|
||
|
|
||
| ### Address validation | ||
| This service is utilized to verify addresses against the United States Postal Service database of valid addresses in the U.S. | ||
| This service is used to check addresses against the United States Postal Service database of valid addresses in the U.S | ||
| 1. Login to the Axon Ivy Portal | ||
| 2. On the Process List page, click on **Validate Address** | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 3. Fill in address info | ||
|
|
||
|  | ||
|
|
||
|  | ||
| 4. Click **Validate** button |