com.secutix.plugin.paymentintegration.service

Interface ShipmentPublicService

All Known Implementing Classes:

ShipmentPublicServiceEmpty

public interface ShipmentPublicService

This interface appointed for calling a facade for public Web Service ShipmentPublicService and using only two methods from the mentioned Web Service.

For more detail information about Web Service, please refer to the link of API documentation below

See Also:

ShipmentPublicService_v1_15

Method Summary

Modifier and Type	Method and Description
ShipmentsData	getShipmentsForOrder(long orderId) Retrieve all shipments that exists for the given order id.
ShipmentModesDetailedData	setShipmentModeForOrder(long shipmentModeId, long orderId, String contactNumber, Long contactAddressId, String email) Set the shipment mode to use for the given order.

Method Detail

setShipmentModeForOrder

ShipmentModesDetailedData setShipmentModeForOrder(long shipmentModeId,
                                                  long orderId,
                                                  String contactNumber,
                                                  Long contactAddressId,
                                                  String email)

Set the shipment mode to use for the given order. Return the technical identifier of the underlying shipment created.

Parameters:

orderId - Order Id

shipmentModeId - Shipment mode Id

contactNumber - Contact number

contactAddressId - Contact address Id

email - Email

Returns:

ShipmentModesDetailedData

getShipmentsForOrder

ShipmentsData getShipmentsForOrder(long orderId)

Retrieve all shipments that exists for the given order id. For each movement of the order, if multiple tickets are available, this method will only return the ticket ID of the only valid ticket.

Parameters:

orderId - Order Id

Returns:

ShipmentsData