io.sphere.sdk.carts.CustomLineItem Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of sphere-models Show documentation

sphere-models

There is a newer version: 1.0.0-M26

package io.sphere.sdk.carts;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import io.sphere.sdk.cartdiscounts.DiscountedLineItemPriceForQuantity;
import io.sphere.sdk.models.LocalizedString;
import io.sphere.sdk.models.Reference;
import io.sphere.sdk.orders.Order;
import io.sphere.sdk.taxcategories.TaxCategory;
import io.sphere.sdk.taxcategories.TaxRate;
import io.sphere.sdk.types.CustomFields;

import javax.annotation.Nullable;
import javax.money.MonetaryAmount;
import java.util.List;
import java.util.Set;

/**
 A custom line item is a generic item that can be added to the cart but is not bound to a product. You can use it for discounts (negative money), vouchers, complex cart rules, additional services or fees. You control the lifecycle of this item.

 A CustomLineItem can have {@link io.sphere.sdk.types.Custom custom fields}.


 Example for adding a {@link CustomLineItem} to a {@link Cart}:
 {@include.example io.sphere.sdk.carts.commands.CartUpdateCommandTest#addCustomLineItem()}

 @see CustomLineItemDraft
 @see io.sphere.sdk.carts.commands.updateactions.AddCustomLineItem
 @see io.sphere.sdk.carts.commands.updateactions.RemoveCustomLineItem
 @see Order#getCustomLineItems()
 @see Cart#getCustomLineItems()
 */
@JsonDeserialize(as=CustomLineItemImpl.class)
public interface CustomLineItem extends LineItemLike {
    LocalizedString getName();

    MonetaryAmount getMoney();

    String getSlug();

    Set getState();

    Reference getTaxCategory();

    @Nullable
    TaxRate getTaxRate();

    @Override
    String getId();

    @Override
    Long getQuantity();

    @Override
    CustomFields getCustom();

    @Override
    MonetaryAmount getTotalPrice();

    @Override
    List getDiscountedPricePerQuantity();

    static String resourceTypeId() {
        return "custom-line-item";
    }
}