Service: ShipmentPublicService

Version: 1_17 (other versions, change log) Latest stable version. Please base all your developments on this one.

SOAP Demo endpoint: https://secutix.ws.secutix.com/tnpsb/external-remoting/com.secutix.facade.shipment.v1_17.ShipmentPublicService.webservice?wsdl

REST Demo endpoint (only POST): https://secutix.ws.secutix.com/tnpsb/backend-apis/shipmentPublicService/v1_17/{methodName} Replace {methodName} for the desired method name as shown below.

To get the endpoint for your own institution, replace "secutix" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.Shipment public service. Responsible of handling shipments linked to orders, where a shipment is composed of tickets and documents.

Methods:

• getAvailableShipmentModes: Retrieve the list of available shipment modes based on filtering parameters.
• getAvailableShipmentModesByContactAddressId: Retrieve the list of available shipment modes based on filtering parameters.
• getAvailableShipmentModesWithProducts:
• getShipmentsForOrder: Retrieve all shipments that exists for the given order id.
• getShipmentsForOrderWithGranularity: As getShipmentsForOrder(orderId) but with specified granularity (see {@link ShipmentDataGranularity}).
• setShipmentModeForOrder: Set the shipment mode to use for the given order.
• setShipmentModeForTickets: Set the shipment mode to use for the given ticket.
• setShipmentModesForOrder: This function support one order maybe has 2 shipment modes

getAvailableShipmentModes

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Retrieve the list of available shipment modes based on filtering parameters.

Parameters

pointOfSalesId	long	Technical ID of the point of sales; mandatory, used to find shipment modes authorized for the sales channel the point of sales belongs to.
shipmentContents	(TICKETS|DOCUMENTS| TICKETS_AND_DOCUMENTS)	Filter shipment modes based on their support for tickets, documents or both of those elements; mandatory parameter.
destinationCountryCode	String (8)	filter shipment modes that support mail in the given country code; optional parameter.
contactAddressId	Long	filter shipment modes based on country code of the given contact address; supersede the destinationCountryCode parameter if defined.
orderId	Long	optional parameter, if defined filter shipment modes based on the order content; the following filters are applied: if mail shipments are available in the sales channel, only the ones with valid delivery times will be returned; if print@home shipment mode is available, will check that the order content allow it; If vending machine shipment mode is available, will check that the order content allow it; if the order amount is greater than or equal to the shipment mode shipping fee "free from amount" value, then the shipping fee for the shipment mode is set to 0.
productFamilyIds	List of Long	optional parameter, if defined filter shipment modes based on the order content, but for only given product families in the order; the following filters are applied: if mail shipments are available in the sales channel, only the ones with valid delivery times will be returned; if print@home shipment mode is available, will check that the order content allow it; If vending machine shipment mode is available, will check that the order content allow it; if the order amount is greater than or equal to the shipment mode shipping fee "free from amount" value, then the shipping fee for the shipment mode is set to 0.

Return value

ShipmentModesDetailedData
shipmentModes	List of ShipmentModeDetailedData
requestId	Integer
statusCode	String (8)
statusDetail	String

ShipmentModeDetailedData
baseShipmentFee	ShipmentFeeData
catalogTypes	Set of (TICKETING|GOODS| HOSPITALITY)
collectionDateRequired	Boolean
collectionEndDate	Date
collectionStartDate	Date
contactAddressRequired	boolean
deliveryTimeInDays	Integer
description	String
externalName	ExternalName	60 characters max for each translation
externalProvider	boolean
idCode	String (8)
maxTimeToPerformanceInDays	Integer
name	String
productIds	List of Long
publicDescription	PublicDescription
rank	Integer
shipmentFee	ShipmentFeeData
shipmentFeeProductDataMap	Map of Long, ShipmentFeeData
ticketSupports	List of (THERMAL|ETICKET|PAPER_A4| PASSBOOK|MOBILE| BLOCKCHAIN|BADGE|RFID| PR_RFID_CARD| DEMAT_BADGE)
type	(HANDED_AT_BO| HANDED_POSTPONED| LEFT_AT_CONTROL|BY_MAIL| BY_RECOMMANDED_MAIL| BY_BROKER|BY_EMAIL| PRINT_AT_HOME|DHL|FEDEX| MOBILE|BLOCKCHAIN| LOAD_BADGE|LOAD_RFID_CARD| ELECTRONIC|EXTERNAL)
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

ShipmentFeeData
amount	MoneyData
freeFromAmount	MoneyData
pricePerTicket	boolean
vatRate	String
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

MoneyData
currency	String
digits	int
value	BigDecimal

ExternalName
translations	List of Translation

Translation
locale	String (2)
value	String

PublicDescription
translations	List of Translation

getAvailableShipmentModesByContactAddressId

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Retrieve the list of available shipment modes based on filtering parameters.

Parameters

pointOfSalesId	long	Technical ID of the point of sales; mandatory, used to find shipment modes authorized for the sales channel the point of sales belongs to.
shipmentContents	(TICKETS|DOCUMENTS| TICKETS_AND_DOCUMENTS)	Filter shipment modes based on their support for tickets, documents or both of those elements; mandatory parameter.
contactAddressId	Long	Filter shipment modes based on country code of the given contact address; supersede the destinationCountryCode parameter if defined.
contactNumber	String (20)	Contact number of the contact selected which will be the distributee and from who we need to get the shipment modes availables

Return value

ShipmentModesDetailedData

getAvailableShipmentModesWithProducts

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

Parameters

pointOfSalesId	long
shipmentContents	(TICKETS|DOCUMENTS| TICKETS_AND_DOCUMENTS)
destinationCountryCode	String (8)
contactAddressId	Long
productIds	List of Long
orderId	Long

Return value

ShipmentModesDetailedData

getShipmentsForOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

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. For each shipment's shipping mode, if the order amount is greater than or equal to the shipment mode shipping fee "free from amount" value, then the shipping fee for the shipment mode is set to 0.

Parameters

orderId

long

technical identifier of the order from which to retrieve shipments.

Return value

ShipmentsData
shipments	List of ShipmentData
requestId	Integer
statusCode	String (8)
statusDetail	String

ShipmentData
collectionDateTime	Date
contactAddress	ContactAddressData
contactNumber	String (20)
documents	List of DocumentData
email	String
numberOfTickets	int
operationIds	List of Long
originalContactAddressId	Long	The original contact address corresponding to the denormalized address
referenceNumber	String
shipmentDate	Date
shipmentMode	ShipmentModeDetailedData
shipmentSent	boolean
shipmentState	(UNSENT|SENT|CANCELLED| REFERENCE|REPROCESS| COLLECTED)
strCollectionDateTime	String
tickets	List of TicketData
trackingUrl	String (255)
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

ContactAddressData
countryCode	String (8)
formattedAddress	String
name	String
street1	String
street2	String
street3	String
street4	String
town	String
townComplement	String
zipCode	String (8)
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

DocumentData
documentClass	String
documentClassEnum	(B2B_ACCOUNT| EMAIL_OPTION_WAIT_LIST| OPTION_SUMMARY| ORDER_BANKCREDIT| ORDER_CONFIRMATION| ORDER_FILE_SUMMARY| GOODS_ORDER| OPTION_REQUEST_ACKNOWLEDGEMENT|OPTION_ORDER_ACK|ORDER_REJECTED|LETTER|RAR|BVR|TICKETS_ACKNOWLEDGEMENT|ACCOUNT_BANKDEBIT|FILE_SUMMARY|ORDER_BANKDEBIT|ORDER_INVOICE|ORDER_SUMMARY|PASSWORD_CHANGE|PASSWORD_RESET|NEW_ACCOUNT|CONTACT|OPTION_REQUEST_DELETION|ACCOUNT_BANKCREDIT|ST_SUBSCRIPTION|EMAIL_EXPIRED_OPTION|OPTION_REQUEST_MODIFICATION|ORDER_ACKNOWLEDGEMENT|WAITACC_INVOICE|ORDER_ACK_WITH_CONF|PROFORMA|CREDIT_NOTES|PARTNER|PRODUCT_WAITLIST_EMAIL|EXCHANGE_TICKET_ACK|FILE_PROFORMA|CGV|EMAIL_FOLLOW_SHIPMENT|EMAIL_OPTION_BOOKING_REMINDER|INSTALMENT_REMINDER|INSTALMENT_PAYING_FAILURE|INSTALMENT_PAYING_SUCCESS|EMAIL_RESERVATION_REMINDER|CODE_EMAIL|REQUEST_CONFIRMATION|REQUEST_SUMMARY|EMAIL_CANCEL_CONFIRMATION|EMAIL_REQUEST_REMINDER|ADVANTAGE_NOTIFICATION|PAYMENT_CONFIRMATION|CAMPAIGN_EMAIL_BASIC|CAMPAIGN_EMAIL_NEWSLET|CAMPAIGN_EMAIL_ECOMM|PUT_ON_RESALE_ACK|CANCEL_RESALE_ACK|REFUND_CREDIT_ACK|RFD_PMT_NOTIFICATION_EMAIL|WAITACC_INVOICE_FINAL|ARTIST_WAITLIST_EMAIL|AUTHORIZATION_CONFIRMATION|CONFIRM_WAITLIST_EMAIL|CONFIRM_PROD_WAITLIST_EMAIL|TICKET_RECEIPT|TICKET_DETAILS_EMAIL|REQUEST_CONTACT_CONSENT|APPLICATION_CONFIRMATION|TAX_REFUND)
documentType	String
orderId	Long
alreadyPrinted	boolean
availableForPrint	boolean
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

TicketData
barcode	String (8)
humanReadableBarcode	String (8)
refundMovementId	Long
salesMovementId	long
taxNumber	String
ticketKind	(EBO|PRODUCER|SECUTIX| THIRD_PARTY|SECUTIX_EXT| IMPORTED_ITR|UNDEFINED)
ticketPrintingMode	(CARD|CARD_AND_TICKETS| TICKETS|BADGE| BADGE_AND_TICKETS|NONE)
alreadyPrinted	boolean
availableForPrint	boolean
EMPTY_ID	long
id	long
requestId	Integer
statusCode	String (8)
statusDetail	String

getShipmentsForOrderWithGranularity

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

As getShipmentsForOrder(orderId) but with specified granularity (see {@link ShipmentDataGranularity}). Allows for returning the ShipmentData without tickets, for use with very large orders.

Parameters

orderId	long
shipmentDataGranularity	(SHIPMENT|TICKETS| SHIPMENT_OR_TICKETS)

Return value

ShipmentsData

setShipmentModeForOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

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

In a shipment mode is already associated with the given order, it will be updated with the new shipment mode and other given information.

This method can only be used for open orders, if the given order is closed this method will raise an exception.
If there's a shipment fee associated with the given shipment mode, the order amount is compared to the shipping fee "free from amount" value. If the order amount is under this value, a shipment fee operation will be created for the order. Any previous shipping fee operation will be replaced by the new operation.

Parameters

shipmentModeId	long	shipment mode to create; mandatory parameter.
orderId	long	order id linked to the shipment to create; mandatory parameter.
contactNumber	String (20)	number of the contact to associate with the shipment; optional parameter.
contactAddressId	Long	contact address id to associate with the shipment; optional parameter.
email	String	Email of the contact; optional parameter; will create a new Email entry associated to the contact if it does not already exist; if none given, the contact main email adress will be used instead; if this parameter is specified, either a contactId or a contactAddressId must be given!

Return value

ShipmentModesDetailedData

setShipmentModeForTickets

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

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

If the order of ticket has associated with a SENT shipment, and the shipment's shipment mode is shipmentModeId, the ticket will attached to this shipment. Otherwise, create new {@link Shipment} has same data with current shipment, and set state of this shipment is SENT.

Currently, the following function only handle the case when want to attach ticket to PRINT_AT_HOME {@link ShipmentMode}.

Parameters

shipmentModeId	long	shipment mode to set to ticket.
ticketsId	List of Long	tickets which we want to set shipment mode.

Return value

ShipmentsIdData
shipmentdIdData	List of ShipmentIdData
requestId	Integer
statusCode	String (8)
statusDetail	String

ShipmentIdData
shipmentId	Long
requestId	Integer
statusCode	String (8)
statusDetail	String

setShipmentModesForOrder

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This function support one order maybe has 2 shipment modes

Parameters

orderId	long	order id linked to the shipment to create; mandatory parameter.
contactNumber	String (20)	number of the contact to associate with the shipment; optional parameter.
shipmentRequestData	List of ShipmentRequestData	shipmentRequestData include shipmentModeId, contactAddressid, email and operations

ShipmentRequestData
collectionDate	Date
contactAddressId	Long
email	String
operationIds	List of Long
shipmentId	Long
shipmentModeId	long

Return value

ShipmentModesDetailedData