Commercetools\Api\Models\Order\Delivery Interface Reference

Inherits Commercetools\Base\JsonObject.

Inherited by Commercetools\Api\Models\Order\DeliveryModel.

Public Member Functions
	getId ()
	getKey ()
	getCreatedAt ()
	getItems ()
	getParcels ()
	getAddress ()
	getCustom ()
	setId (?string $id)
	setKey (?string $key)
	setCreatedAt (?DateTimeImmutable $createdAt)
	setItems (?DeliveryItemCollection $items)
	setParcels (?ParcelCollection $parcels)
	setAddress (?Address $address)
	setCustom (?CustomFields $custom)
Public Member Functions inherited from Commercetools\Base\JsonObject
	get (string $field)
	with (?callable $callable=null)

Public Attributes
const	FIELD_ID = 'id'
const	FIELD_KEY = 'key'
const	FIELD_CREATED_AT = 'createdAt'
const	FIELD_ITEMS = 'items'
const	FIELD_PARCELS = 'parcels'
const	FIELD_ADDRESS = 'address'
const	FIELD_CUSTOM = 'custom'

Additional Inherited Members
Static Public Member Functions inherited from Commercetools\Base\JsonObject
static	of ($data=null)
static	fromArray (array $data=[])
static	fromStdClass (?stdClass $data=null)

Detailed Description

Definition at line 17 of file Delivery.php.

Member Function Documentation

getAddress()

Commercetools\Api\Models\Order\Delivery::getAddress

(

)

Address to which Parcels are delivered.

Returns

null|Address

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getCreatedAt()

Commercetools\Api\Models\Order\Delivery::getCreatedAt

(

)

Date and time (UTC) the Delivery was created.

Returns

null|DateTimeImmutable

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getCustom()

Commercetools\Api\Models\Order\Delivery::getCustom

(

)

Custom Fields of the Delivery.

Returns

null|CustomFields

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getId()

Commercetools\Api\Models\Order\Delivery::getId

(

)

Unique identifier of the Delivery.

Returns

null|string

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getItems()

Commercetools\Api\Models\Order\Delivery::getItems

(

)

Line Items or Custom Line Items that are delivered.

Returns

null|DeliveryItemCollection

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getKey()

Commercetools\Api\Models\Order\Delivery::getKey

(

)

User-defined unique identifier of the Delivery.

Returns

null|string

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

getParcels()

Commercetools\Api\Models\Order\Delivery::getParcels

(

)

Information regarding the appearance, content, and shipment of a Parcel.

Returns

null|ParcelCollection

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setAddress()

Commercetools\Api\Models\Order\Delivery::setAddress

(

?Address

$address

)

Parameters

?Address

$address

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setCreatedAt()

Commercetools\Api\Models\Order\Delivery::setCreatedAt

(

?DateTimeImmutable

$createdAt

)

Parameters

?DateTimeImmutable

$createdAt

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setCustom()

Commercetools\Api\Models\Order\Delivery::setCustom

(

?CustomFields

$custom

)

Parameters

?CustomFields

$custom

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setId()

Commercetools\Api\Models\Order\Delivery::setId

(

?string

$id

)

Parameters

?string

$id

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setItems()

Commercetools\Api\Models\Order\Delivery::setItems

(

?DeliveryItemCollection

$items

)

Parameters

?DeliveryItemCollection

$items

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setKey()

Commercetools\Api\Models\Order\Delivery::setKey

(

?string

$key

)

Parameters

?string

$key

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

setParcels()

Commercetools\Api\Models\Order\Delivery::setParcels

(

?ParcelCollection

$parcels

)

Parameters

?ParcelCollection

$parcels

Implemented in Commercetools\Api\Models\Order\DeliveryModel.

Member Data Documentation

FIELD_ADDRESS

const Commercetools\Api\Models\Order\Delivery::FIELD_ADDRESS = 'address'

Definition at line 24 of file Delivery.php.

FIELD_CREATED_AT

const Commercetools\Api\Models\Order\Delivery::FIELD_CREATED_AT = 'createdAt'

Definition at line 21 of file Delivery.php.

FIELD_CUSTOM

const Commercetools\Api\Models\Order\Delivery::FIELD_CUSTOM = 'custom'

Definition at line 25 of file Delivery.php.

FIELD_ID

const Commercetools\Api\Models\Order\Delivery::FIELD_ID = 'id'

Definition at line 19 of file Delivery.php.

FIELD_ITEMS

const Commercetools\Api\Models\Order\Delivery::FIELD_ITEMS = 'items'

Definition at line 22 of file Delivery.php.

FIELD_KEY

const Commercetools\Api\Models\Order\Delivery::FIELD_KEY = 'key'

Definition at line 20 of file Delivery.php.

FIELD_PARCELS

const Commercetools\Api\Models\Order\Delivery::FIELD_PARCELS = 'parcels'

Definition at line 23 of file Delivery.php.

---

The documentation for this interface was generated from the following file:

• lib/commercetools-api/src/Models/Order/Delivery.php