com.logicommerce.sdk.models.CartShipment Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sdk Show documentation

SDK for developing Logicommerce plugins.

There is a newer version: 2.3.0

package com.logicommerce.sdk.models;

import java.util.List;

/**
 * CartShipment interface. Get data related to the shipment of the cart
 *
 * @see		com.logicommerce.sdk.models.Cart Cart
 * @see		com.logicommerce.sdk.models.CartDelivery CartDelivery
 * @see		com.logicommerce.sdk.models.CartShipmentItem CartShipmentItem
 * @see		com.logicommerce.sdk.models.CartWarehouse CartWarehouse
 * @author 	Logicommerce
 * @since 	1.0.16
 */
public interface CartShipment {

	/**
	 * Get Hash value of the shipment, this value identifies the shipment.
	 *
	 * @since 1.0.16
	 * @return a {@link java.lang.String String} object
	 */
	String getHash();


	/**
	 * Return Shipping
	 * 
	 * @since 1.3.0
	 * @return a {@link com.logicommerce.sdk.models.CartShipping} object
	 */
	CartShipping getShipping();

	/**
	 * Get Items of the shipment.
	 *
	 * @see com.logicommerce.sdk.models.CartShipmentItem CartShipmentItem
	 * @since 1.0.16
	 * @return a {@link java.util.List List}<{@link com.logicommerce.sdk.models.CartShipmentItem CartShipmentItem}> object
	 */
	List getItems();

	/**
	 * Get total amount of the shipment.
	 *
	 * @since 1.0.16
	 * @return a double
	 */
	double getTotal();

	/**
	 * Get weight of the shipment.
	 *
	 * @since 1.0.16
	 * @return a double
	 */
	double getWeight();

	/**
	 * Get warehouse related to the shipment.
	 *
	 * @see	com.logicommerce.sdk.models.CartWarehouse CartWarehouse
	 * @since 1.0.16
	 * @return a {@link com.logicommerce.sdk.models.CartWarehouse CartWarehouse} object
	 */
	CartWarehouse getWarehouse();

	/**
	 * Get the logistics center address.
	 * 
	 * @since 1.3.3
	 * @return a {@link com.logicommerce.sdk.models.Address Address} object
	 */
	Address getLogisticsCenterAddress();

}