com.worldline.connect.sdk.java.v1.domain

Class Shipping

java.lang.Object

com.worldline.connect.sdk.java.v1.domain.Shipping

public class Shipping
extends Object

Object containing information regarding shipping / delivery

Constructor Summary

Constructors

Constructor and Description
Shipping()

Method Summary

Modifier and Type	Method and Description
AddressPersonal	getAddress() Object containing address information
String	getAddressIndicator() Indicates shipping method chosen for the transaction.
String	getCarrier() Indicates the carrier that will deliver the products.
String	getComments() Comments included during shipping
String	getEmailAddress() Email address linked to the shipping
String	getFirstUsageDate() Date (YYYYMMDD) when the shipping details for this transaction were first used.
String	getInstructions() The delivery instructions or preferences for the shipment.
Boolean	getIsFirstUsage() Indicator if this shipping address is used for the first time to ship an order
String	getShippedFromZip() The zip/postal code of the location from which the goods were shipped.
String	getTrackingNumber() Shipment tracking number
String	getType() Indicates the merchandise delivery timeframe.
void	setAddress(AddressPersonal value) Object containing address information
void	setAddressIndicator(String value) Indicates shipping method chosen for the transaction.
void	setCarrier(String value) Indicates the carrier that will deliver the products.
void	setComments(String value) Comments included during shipping
void	setEmailAddress(String value) Email address linked to the shipping
void	setFirstUsageDate(String value) Date (YYYYMMDD) when the shipping details for this transaction were first used.
void	setInstructions(String value) The delivery instructions or preferences for the shipment.
void	setIsFirstUsage(Boolean value) Indicator if this shipping address is used for the first time to ship an order
void	setShippedFromZip(String value) The zip/postal code of the location from which the goods were shipped.
void	setTrackingNumber(String value) Shipment tracking number
void	setType(String value) Indicates the merchandise delivery timeframe.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Shipping

public Shipping()

Method Detail

getAddress

public AddressPersonal getAddress()

Object containing address information

setAddress

public void setAddress(AddressPersonal value)

Object containing address information

getAddressIndicator

public String getAddressIndicator()

Indicates shipping method chosen for the transaction. Possible values:

• same-as-billing = the shipping address is the same as the billing address
• another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
• different-than-billing = shipping address is different from the billing address
• ship-to-store = goods are shipped to a store (shipping address = store address)
• digital-goods = electronic delivery of digital goods
• travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
• other = other means of delivery

setAddressIndicator

public void setAddressIndicator(String value)

Indicates shipping method chosen for the transaction. Possible values:

• same-as-billing = the shipping address is the same as the billing address
• another-verified-address-on-file-with-merchant = the address used for shipping is another verified address of the customer that is on file with you
• different-than-billing = shipping address is different from the billing address
• ship-to-store = goods are shipped to a store (shipping address = store address)
• digital-goods = electronic delivery of digital goods
• travel-and-event-tickets-not-shipped = travel and/or event tickets that are not shipped
• other = other means of delivery

getCarrier

public String getCarrier()

Indicates the carrier that will deliver the products.

setCarrier

public void setCarrier(String value)

Indicates the carrier that will deliver the products.

getComments

public String getComments()

Comments included during shipping

setComments

public void setComments(String value)

Comments included during shipping

getEmailAddress

public String getEmailAddress()

Email address linked to the shipping

setEmailAddress

public void setEmailAddress(String value)

Email address linked to the shipping

getFirstUsageDate

public String getFirstUsageDate()

Date (YYYYMMDD) when the shipping details for this transaction were first used.

setFirstUsageDate

public void setFirstUsageDate(String value)

Date (YYYYMMDD) when the shipping details for this transaction were first used.

getInstructions

public String getInstructions()

The delivery instructions or preferences for the shipment. The instructions that informed the delivery carrier about handling requirements, delivery methods, and any special considerations to ensure successful delivery.

Possible values:

• signature-required = A signature is required upon delivery.
• identification-required = Recipient needs to provide identification.
• contactless-delivery = Delivery should be contactless.
• leave-at-door = Leave the package at the recipient's door.
• leave-at-curb = Leave the package at the curbside.
• leave-with-neighbor = Leave the package with a neighbor.
• express = Expedite the delivery process.
• tracked = The delivery is tracked with real-time updates.
• untracked = The delivery is untracked, with no real-time updates.

setInstructions

public void setInstructions(String value)

The delivery instructions or preferences for the shipment. The instructions that informed the delivery carrier about handling requirements, delivery methods, and any special considerations to ensure successful delivery.

Possible values:

• signature-required = A signature is required upon delivery.
• identification-required = Recipient needs to provide identification.
• contactless-delivery = Delivery should be contactless.
• leave-at-door = Leave the package at the recipient's door.
• leave-at-curb = Leave the package at the curbside.
• leave-with-neighbor = Leave the package with a neighbor.
• express = Expedite the delivery process.
• tracked = The delivery is tracked with real-time updates.
• untracked = The delivery is untracked, with no real-time updates.

getIsFirstUsage

public Boolean getIsFirstUsage()

Indicator if this shipping address is used for the first time to ship an order

true = the shipping details are used for the first time with this transaction

false = the shipping details have been used for other transactions in the past

setIsFirstUsage

public void setIsFirstUsage(Boolean value)

Indicator if this shipping address is used for the first time to ship an order

true = the shipping details are used for the first time with this transaction

false = the shipping details have been used for other transactions in the past

getShippedFromZip

public String getShippedFromZip()

The zip/postal code of the location from which the goods were shipped.

setShippedFromZip

public void setShippedFromZip(String value)

The zip/postal code of the location from which the goods were shipped.

getTrackingNumber

public String getTrackingNumber()

Shipment tracking number

setTrackingNumber

public void setTrackingNumber(String value)

Shipment tracking number

getType

public String getType()

Indicates the merchandise delivery timeframe. Possible values:

• electronic = For electronic delivery (services or digital goods)
• same-day = For same day deliveries
• overnight = For overnight deliveries
• 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform
• 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform
• priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform
• ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform
• to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform

setType

public void setType(String value)

Indicates the merchandise delivery timeframe. Possible values:

• electronic = For electronic delivery (services or digital goods)
• same-day = For same day deliveries
• overnight = For overnight deliveries
• 2-day-or-more = For two day or more delivery time for payments that are processed by the GlobalCollect platform
• 2-day-or-more = For two day or more delivery time for payments that are processed by the Ogone platform
• priority = For prioritized deliveries for payments that are processed by the WL Online Payment Acceptance platform
• ground = For deliveries via ground for payments that are processed by the WL Online Payment Acceptance platform
• to-store = For deliveries to a store for payments that are processed by the WL Online Payment Acceptance platform