Carrier server integration without pierbridge adapter
This list of user exits must be implemented to integrate with the carrier server, without Pierbridge adapter.
- YCSshipCartonUserExit
This UserExit is invoked when you manifest a shipment or container. The method shipCartonOutXML must be implemented to connect the carrier server by using either Webservice or some other way and then update the response in the output xml. In case Integration fails, an exception must be thrown using YFSUserExitException. In case the Carrier Server returns a response other than success status, then it must throw as YFSUserExitException. Therefore, the pack process must be reverted.
The output of the UE (shipCartonOutXML method) must be as shown as the following: :<ShipCarton BilledWeight="" NetCharge="" TrackingNumber="" PierbridgeLabelURL=""> <ReturnTrackingDetails NumberOfReturnTrackingNumbers=""> <ReturnTrackingDetail ReturnTrackingNumber=""> PierbridgeReturnLabelURL=""> </ReturnTrackingDetails> <PackageLevelDetail/> </ShipCarton>>
Note: When getTrackingNumberAndPrintLabel API is called, this UserExit is invoked and the manifest is opened for the shipment. This UserExit is also called when addContainerToManifest API is called and manifests the containers of a shipment
- YCSopenManifestUserExit
In any store, only one manifest can be open at a time. This UserExit will invoke only when the manifest is closed and packing process needs to be continued. A new manifest will be opened or reopened from the closed manifest for the same day according to the property "ycs.manifest.reopenmanifest." Customers can set this property "ycs.manifest.reopenmanifest=Y." either in customer_overrides.properties file or yfs.properties file.
- YCSdeleteCartonUserExit
This UserExit is invoked when unpacking the shipment or deleting the container. The unpackShipment API when called, invokes this UserExit
- YCSreprintCarrierLabelUserExit
This UserExit is invoked when the user clicks the shipping label.
The output of the UserExit is shown as the following: :<Container ContainerNo="" ContainerScm="" ShipmentContainerKey=" ShipmentKey=" PierbridgeLabelURL=""> <ContainerReturnTrackingList> <ContainerReturnTracking ReturnTrackingNumber="" PierbridgeReturnLabelURL=""/> </ContainerReturnTrackingList> </Container>