EST 05697238 LFS UPS API Changes - Revision history

Anw: v1.00 - Ready for issue

2025-09-18T13:42:21Z

v1.00 - Ready for issue

← Older revision		Revision as of 15:42, 18 September 2025
Line 5:		Line 5:
	\|Supimix_Client_Reference=.		\|Supimix_Client_Reference=.
	\|Supimix_Number=05697238		\|Supimix_Number=05697238
	\|The_version_of_the_document=0.02		\|The_version_of_the_document=1.00
	\|Your_Name=A N Walker		\|Your_Name=A N Walker
	\|Supimix_PO_Reference=-		\|Supimix_PO_Reference=-
Line 74:		Line 74:
	** Any imports other than those listed.		** Any imports other than those listed.
	** Any labels, reports or exports other than those listed.		** Any labels, reports or exports other than those listed.
	\|Requirements_Days=18.75		\|Requirements_Days=20.75
	\|Estimation_Days=7.50		\|Estimation_Days=7.50
	\|Functional_Specification_Days=19.75		\|Functional_Specification_Days=19.75

Anw: V0.02 - Amended following review from customer.

2025-09-18T08:29:17Z

V0.02 - Amended following review from customer.

← Older revision		Revision as of 10:29, 18 September 2025
Line 5:		Line 5:
	\|Supimix_Client_Reference=.		\|Supimix_Client_Reference=.
	\|Supimix_Number=05697238		\|Supimix_Number=05697238
	\|The_version_of_the_document=0.01		\|The_version_of_the_document=0.02
	\|Your_Name=A N Walker		\|Your_Name=A N Walker
	\|Supimix_PO_Reference=-		\|Supimix_PO_Reference=-
	\|Supimix_Priority=-		\|Supimix_Priority=-
	\|Date_(DD/MM/YY)=17/09/2025		\|Date_(DD/MM/YY)=18/09/2025
	\|Clients_Customer=.		\|Clients_Customer=.
	\|System_Version_being_changed=12.48		\|System_Version_being_changed=12.48
Line 65:		Line 65:
	*** SCHED_ORDS		*** SCHED_ORDS
	** Update existing user ORS reports that are based off these ORS types.		** Update existing user ORS reports that are based off these ORS types.
	* Item Labels
	** Add carrier reference to item label


Line 75:		Line 73:
	** Any ORS reports other than those listed.		** Any ORS reports other than those listed.
	** Any imports other than those listed.		** Any imports other than those listed.
	** Any labels or reports or exports other than those listed.		** Any labels, reports or exports other than those listed.
	\|Requirements_Days=15.00		\|Requirements_Days=18.75
	\|Estimation_Days=7.50		\|Estimation_Days=7.50
	\|Functional_Specification_Days=23.5		\|Functional_Specification_Days=19.75
	\|Technical_Specification_Days=0.00		\|Technical_Specification_Days=0.00
	\|Development_Days=58.50		\|Development_Days=49.50
	\|Testing_and_Release_Days=22.25		\|Testing_and_Release_Days=20.00
	\|Implementation_Days=3.75		\|Implementation_Days=3.75
	\|Project_Management_Days=26.00		\|Project_Management_Days=23.75
	\|Year=2025		\|Year=2025
	\|Free_Of_Charge=N		\|Free_Of_Charge=N

Anw: Minor correction

2025-09-17T14:23:49Z

Minor correction

← Older revision		Revision as of 16:23, 17 September 2025
Line 29:		Line 29:
	\|OBS_Solution=The overall solution will be as follows:		\|OBS_Solution=The overall solution will be as follows:
	* UPS send in an additional sub-reference on the order using the standard CTMS Interface format provided - proposed as CARRIER_REFERENCE.		* UPS send in an additional sub-reference on the order using the standard CTMS Interface format provided - proposed as CARRIER_REFERENCE.
	** {{Note}} This is not validated unique, but as this is generated by UPS and sent to us electronically, this will be ~~accetible~~.		** {{Note}} This is not validated unique, but as this is generated by UPS and sent to us electronically, this will be acceptable.
	* CTMS stores that as an additional order reference, visible in and searchable in the CTMS orders screens.		* CTMS stores that as an additional order reference, visible in and searchable in the CTMS orders screens.
	* CTMS passes that to Portal TTM as Order Reference 1 (additional order reference).		* CTMS passes that to Portal TTM as Order Reference 1 (additional order reference).

Anw: Initial Creation

2025-09-17T14:00:10Z

Initial Creation

New page

{{Template:EstimateNew
|Supimix_Client_Code=LFS
|Supimix_Project_Code=AU
|Supimix_Site_Code=.
|Supimix_Client_Reference=.
|Supimix_Number=05697238
|The_version_of_the_document=0.01
|Your_Name=A N Walker
|Supimix_PO_Reference=-
|Supimix_Priority=-
|Date_(DD/MM/YY)=17/09/2025
|Clients_Customer=.
|System_Version_being_changed=12.48
|Client_Request=Option 1
* UPS GSA application maintains a set of shipment number ranges (i.e. Con Note Numbers) that are assigned by our carrier
* GSA assigns shipment numbers as each WMS order is processed
* GSA then generates a carrier compliant label that includes this Shipment number
* GSA interfaces the shipment data including the Shipment Number to the carrier
* Goods are handed over when truck picks up and can be tracked based on this shipment number
* Milestones are returned with the shipment number being the primary key

Option 2
* GSA processes a WMS order
* GSA then calls an API with the carrier and passes through the shipment details
* The response to the API call passes back critical information from the carrier which includes the shipment number along with any routing data that will be critical for the label generation
* GSA then generates a carrier compliant label that includes this Shipment number that was returned in the API response
* Goods are handed over when truck picks up and can be tracked based on this shipment number
* Milestones are returned with the shipment number being the primary key
|OBS_Solution=The overall solution will be as follows:
* UPS send in an additional sub-reference on the order using the standard CTMS Interface format provided - proposed as CARRIER_REFERENCE.
** {{Note}} This is not validated unique, but as this is generated by UPS and sent to us electronically, this will be accetible.
* CTMS stores that as an additional order reference, visible in and searchable in the CTMS orders screens.
* CTMS passes that to Portal TTM as Order Reference 1 (additional order reference).
* The Portal TTM Trip/Order Enquiry screen is configured to search by Order Reference 1 (named appropriately such as "Carrier Reference" in the system).
* Portal TTM is configured to display that on the results table shown from a query.
** This will be displayed after the existing PO Reference.
* Portal TTM is configured to display that on the details of the order when you drill down into it.
** {{Note}} This is just for the Trip/Order Enquiry screen - the following screens do not use the new reference: Order Visibility, Airport, Arrivals.
* Portal Gateway - the carrier reference will be sent to the end customer for tracking purposes, and they will be able to view the details of the order through this link.
* Portal Gateway - the parameter entry page will allow the user to select by which reference they want to find the consignment, from a drop-down list of available references
** B – Booking Ref.
** S – External Ref.
** T – OMS Ref.
** P – PO Ref.
** 1/2/3/4/5 – Order Ref 1/2/3/4/5.
* The new additional reference will be passed out on the existing ORD_XML messages.

'''Development Required:'''
* UPS – pass in CARRIER_REFERENCE sub-reference
** No CTMS dev expected on this, but this must be considered a requirement of the final deliverable.
* CTMS
** Pass defined (parameterized) CARRIER_REFERENCE to TTM in Reference1.
* Portal
** Enquiry results: Add Order Reference 1 to configurable items to display.
* Gateway
** Add drop-down list of selectable reference to use to find the order.
* ORS Reports
** Add Carrier Reference to selectable/reportable criteria. List below
*** EX_ORDHEAD
*** EX_ORDITM
*** EX_ORDLINE
*** UNSCHED
*** SCHED_ORD2
*** SCHED_ORDS
** Update existing user ORS reports that are based off these ORS types.
* Item Labels
** Add carrier reference to item label

'''Scope:'''
* Only the interfaces, screens and fields specified will be changed - any other screens, interfaces and fields remain unaffected, specifically but not limited to:
** Other Portal TTM enquiry screens.
** Portal TMS screens.
** Any ORS reports other than those listed.
** Any imports other than those listed.
** Any labels or reports or exports other than those listed.
|Requirements_Days=15.00
|Estimation_Days=7.50
|Functional_Specification_Days=23.5
|Technical_Specification_Days=0.00
|Development_Days=58.50
|Testing_and_Release_Days=22.25
|Implementation_Days=3.75
|Project_Management_Days=26.00
|Year=2025
|Free_Of_Charge=N
|FIXEDCOST=N
|NOFOOTER=Y
|DiscountPerc=0
|DiscountText=
}}
[[Category:CTMS]][[Category:PORTAL]]