io.sphere.sdk.orders

Interface Delivery

All Superinterfaces:

CreationTimestamped, Identifiable<Delivery>

public interface Delivery
extends Identifiable<Delivery>, CreationTimestamped

Deliveries are compilations of information on how the articles are being shipped to the customers. A delivery can contain multiple items. All items in a delivery can be shipped with several parcels. To create a delivery, it is necessary to have a shipment method assigned to the order. A sample use case for a delivery object is to create a delivery note.

See Also:

AddDelivery, DeliveryAddedMessage

Method Summary

Modifier and Type	Method and Description
Address	getAddress()
ZonedDateTime	getCreatedAt()
CustomFields	getCustom()
String	getId() The unique ID of this object.
List<DeliveryItem>	getItems()
List<Parcel>	getParcels()
static Delivery	of(String id, ZonedDateTime createdAt, List<DeliveryItem> items, List<Parcel> parcels)

Method Detail

getId

String getId()

Description copied from interface: Identifiable

The unique ID of this object.

Specified by:

getId in interface Identifiable<Delivery>

Returns:

ID

getCreatedAt

ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface CreationTimestamped

getItems

List<DeliveryItem> getItems()

getParcels

List<Parcel> getParcels()

getAddress

@Nullable
Address getAddress()

getCustom

@Nullable
CustomFields getCustom()

of

static Delivery of(String id,
                   ZonedDateTime createdAt,
                   List<DeliveryItem> items,
                   List<Parcel> parcels)