ShipmentOrder Class Reference

Public Member Functions
	__destruct ()
	getSequenceNumber ()
	setSequenceNumber ($sequenceNumber)
	getShipmentDetails ()
	setShipmentDetails ($shipmentDetails)
	getSender ()
	setSender ($sender)
	getReceiver ()
	setReceiver ($receiver)
	getReturnReceiver ()
	setReturnReceiver ($returnReceiver)
	getExportDocument ()
	setExportDocument ($exportDocument)
	getPrintOnlyIfReceiverIsValid ()
	setPrintOnlyIfReceiverIsValid ($printOnlyIfReceiverIsValid)
	getLabelResponseType ()
	setLabelResponseType ($labelResponseType)
	getShipmentOrderClass_v2 ()

Detailed Description

Definition at line 24 of file ShipmentOrder.php.

Constructor & Destructor Documentation

__destruct()

__destruct

(

)

Clears Memory

Definition at line 98 of file ShipmentOrder.php.

Member Function Documentation

getExportDocument()

getExportDocument

(

)

Get the ExportDocument-Object

Returns

ExportDocument|null - ExportDocument-Object or null if none

Definition at line 208 of file ShipmentOrder.php.

getLabelResponseType()

getLabelResponseType

(

)

Get the Label-Response type

Returns

null|string - Label-Response type | null means DHL-Default

Definition at line 246 of file ShipmentOrder.php.

getPrintOnlyIfReceiverIsValid()

getPrintOnlyIfReceiverIsValid

(

)

Get if the label should only printed if the Receiver-Address is valid

Returns

bool|null - Should the label only printed on a valid Address | null means DHL-Default

Definition at line 226 of file ShipmentOrder.php.

getReceiver()

getReceiver

(

)

Get the Receiver-Object

Returns

Receiver|PackStation|Filial - Receiver-Object

Definition at line 168 of file ShipmentOrder.php.

getReturnReceiver()

getReturnReceiver

(

)

Get the ReturnReceiver-Object

Usually only used for Re-Tour (In most cases the same Address like the Sender)

Returns

ReturnReceiver|null - ReturnReceiver-Object or null if none

Definition at line 188 of file ShipmentOrder.php.

getSender()

getSender

(

)

Get the Sender-Object

Returns

Sender - Sender-Object

Definition at line 150 of file ShipmentOrder.php.

getSequenceNumber()

getSequenceNumber

(

)

Get the Sequence-Number

Returns

string - Sequence-Number

Definition at line 114 of file ShipmentOrder.php.

getShipmentDetails()

getShipmentDetails

(

)

Get Shipment-Details-Object

Returns

ShipmentDetails - Shipment-Details-Object

Definition at line 132 of file ShipmentOrder.php.

getShipmentOrderClass_v2()

getShipmentOrderClass_v2

(

)

Returns an DHL-Class of this Object for DHL-Shipment Order

Returns

stdClass - DHL-ShipmentOrder-Class

Definition at line 264 of file ShipmentOrder.php.

setExportDocument()

setExportDocument

(

$exportDocument

)

Set the ExportDocument-Object

Parameters

ExportDocument | null

$exportDocument

- ExportDocument-Object or null for none

Definition at line 217 of file ShipmentOrder.php.

setLabelResponseType()

setLabelResponseType

(

$labelResponseType

)

Set the Label-Response type

Parameters

null | string

$labelResponseType

- Label-Response type | null uses DHL-Default

Definition at line 255 of file ShipmentOrder.php.

setPrintOnlyIfReceiverIsValid()

setPrintOnlyIfReceiverIsValid

(

$printOnlyIfReceiverIsValid

)

Set if the label should only printed if the Receiver-Address is valid

WARNING: The Address-Validation can fail sometimes also on existing Addresses (for example new streets) use with care!

Parameters

bool | null

$printOnlyIfReceiverIsValid

- Should the label only printed on a valid Address | null uses default from DHL

Definition at line 237 of file ShipmentOrder.php.

setReceiver()

setReceiver

(

$receiver

)

Set the Receiver-Object

Parameters

Receiver | PackStation | Filial

$receiver

- Receiver-Object

Definition at line 177 of file ShipmentOrder.php.

setReturnReceiver()

setReturnReceiver

(

$returnReceiver

)

Set the ReturnReceiver-Object

Usually only used for Re-Tour (In most cases the same Address like the Sender)

Parameters

ReturnReceiver | null

$returnReceiver

- ReturnReceiver-Object or null for none

Definition at line 199 of file ShipmentOrder.php.

setSender()

setSender

(

$sender

)

Set the Sender-Object

Parameters

Sender

$sender

- Sender-Object

Definition at line 159 of file ShipmentOrder.php.

setSequenceNumber()

setSequenceNumber

(

$sequenceNumber

)

Set the Sequence-Number

Parameters

string

$sequenceNumber

- Sequence-Number

Definition at line 123 of file ShipmentOrder.php.

setShipmentDetails()

setShipmentDetails

(

$shipmentDetails

)

Set Shipment-Details-Object

Parameters

ShipmentDetails

$shipmentDetails

- Shipment-Details-Object

Definition at line 141 of file ShipmentOrder.php.

---

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

• includes/ShipmentOrder.php