com.ingenico.connect.gateway.sdk.java.domain.payment.definitions.Shipping Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of connect-sdk-java Show documentation
SDK to communicate with the Ingenico ePayments platform using the Ingenico Connect Server API
There is a newer version: 6.47.0
/*
 * This class was auto-generated from the API references found at
 * https://epayments-api.developer-ingenico.com/s2sapi/v1/
 */

package com.ingenico.connect.gateway.sdk.java.domain.payment.definitions;

/**
 * Object containing information regarding shipping / delivery
 */
public class Shipping {

	private AddressPersonal address = null;

	private String addressIndicator = null;

	private String comments = null;

	private String emailAddress = null;

	private String firstUsageDate = null;

	private Boolean isFirstUsage = null;

	private String trackingNumber = null;

	private String type = null;

	/**
	 * Object containing address information
	 */
	public AddressPersonal getAddress() {
		return address;
	}

	/**
	 * Object containing address information
	 */
	public void setAddress(AddressPersonal value) {
		this.address = 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
	 */
	public String getAddressIndicator() {
		return addressIndicator;
	}

	/**
	 * 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
	 */
	public void setAddressIndicator(String value) {
		this.addressIndicator = value;
	}

	/**
	 * Comments included during shipping
	 */
	public String getComments() {
		return comments;
	}

	/**
	 * Comments included during shipping
	 */
	public void setComments(String value) {
		this.comments = value;
	}

	/**
	 * Email address linked to the shipping
	 */
	public String getEmailAddress() {
		return emailAddress;
	}

	/**
	 * Email address linked to the shipping
	 */
	public void setEmailAddress(String value) {
		this.emailAddress = value;
	}

	/**
	 * Date (YYYYMMDD) when the shipping details for this transaction were first used.
	 */
	public String getFirstUsageDate() {
		return firstUsageDate;
	}

	/**
	 * Date (YYYYMMDD) when the shipping details for this transaction were first used.
	 */
	public void setFirstUsageDate(String value) {
		this.firstUsageDate = 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
	 */
	public Boolean getIsFirstUsage() {
		return isFirstUsage;
	}

	/**
	 * 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
	 */
	public void setIsFirstUsage(Boolean value) {
		this.isFirstUsage = value;
	}

	/**
	 * Shipment tracking number
	 */
	public String getTrackingNumber() {
		return trackingNumber;
	}

	/**
	 * Shipment tracking number
	 */
	public void setTrackingNumber(String value) {
		this.trackingNumber = 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
	 * 
	 */
	public String getType() {
		return type;
	}

	/**
	 * 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
	 * 
	 */
	public void setType(String value) {
		this.type = value;
	}
}