<ISS-257163> Mapping of Declared Value in UPS Integration

Problem Statement

For client Hellmann, currently there is no mapping for declared value and currency passed during booking via customer portal. This is leading to consignments being created in UPS without the declared value and currency field as we are not consuming those two fields and as a result, there is limited insurance for high-value or high-risk shipments.

Bullet Point Summary Scope

• Mapping of the declared value and declared currency field in the UPS carrier. (Booking API via customer portal).

• Declared value to have a check of being passed only when risk surcharge applicable field is set to true.

• Declared value to be sent at package level. If multiple pieces are there, we will be passing the declared value individually for each package.

Requirements

Use Case 1 : Mapping of the declared value and declared currency field.

1. Required to map the declared value and declared currency field in the UPS carrier to not have limited insurance.

2. We will be consuming the same value being mapped to the booking API in customer portal. (consignment level and not consignment.extra_details)

3. const declaredValue = getKeyValue(consignmentData, 'declared_value');

Use Case 2 : Declared Value to be passed when risk surcharge applicable field is true.

1. Risk Surcharge is usually a fee charged by carriers for shipping high-value items.

   If the risk surcharge applicable field is set to true, the carrier needs to know the declared value to assess the appropriate surcharge. Without this information, the carrier wouldn't be able to calculate the additional charge required.

2. Apply validation on the flag risk surcharge applicable where when this flag is true, only then declared value will be passed.

Use Case 3 : Declared Value to be sent at package level and handling to be done for piece level as well.

1. Declared value to be sent at package level.

2. If in case there are multiple pieces, we will be sending the declared value individually for each package and will be then linking it to the parent consignment.

Acceptance and Rejection Criteria [Extremely Critical]

• Declared value only to be passed when risk surcharge applicable is set to true.

• Consumption of the same value as that of the Booking API in customer portal (const declaredValue = getKeyValue(consignmentData, 'declared_value');

API Playground

Changes required in the API Playground. Addition of a new API/ updates or custom for clients

Assumptions

Any assumptions we made during the scoping of this

Permission Management

New Permissions or any Existing Permission which will enable this for customers

Analytics & Reports

Changes to any analytics or reporting dashboards. E.g addition of a new column will need to be shown in reports as well

Scalability and Release Planning

Load the system should handle. Things to keep in mind for releases like migration etc

Impacted Modules of the Product

Modules of the product this will impact. Say Customer Allocation Rules, Allocation Logs etc

Risks Involved

Other use cases that should be checked before making this live

Future Scopes

Things which are not a part of the current scope but can be a part of the future scope