Public Member Functions
	__construct ($accountNumber)

	__destruct ()

	getProduct ()

	setProduct ($product)

	getCustomerReference ()

	setCustomerReference ($customerReference)

	getShipmentDate ()

	setShipmentDate ($shipmentDate, $useIntTime=false)

	getReturnAccountNumber ()

	setReturnAccountNumber ($returnAccountNumber)

	getReturnReference ()

	setReturnReference ($returnReference)

	getWeight ()

	setWeight ($weight)

	getLength ()

	setLength ($length)

	getWidth ()

	setWidth ($width)

	getHeight ()

	setHeight ($height)

	getService ()

	setService ($service)

	getPackageType ()

	setPackageType ($packageType)

	getNotificationEmail ()

	setNotificationEmail ($notificationEmail)

	getBank ()

	setBank ($bank)

	getShipmentDetailsClass_v1 ()

	getShipmentDetailsClass_v2 ()

Data Fields
const	PALETTE = 'PL'

const	PACKAGE = 'PK'

const	PRODUCT_TYPE_NATIONAL_PACKAGE = 'V01PAK'

const	PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO = 'V01PRIO'

const	PRODUCT_TYPE_INTERNATIONAL_PACKAGE = 'V53WPAK'

const	PRODUCT_TYPE_EUROPA_PACKAGE = 'V54EPAK'

const	PRODUCT_TYPE_PACKED_CONNECT = 'V55PAK'

const	PRODUCT_TYPE_SAME_DAY_PACKAGE = 'V06PAK'

const	PRODUCT_TYPE_SAME_DAY_MESSENGER = 'V06TG'

const	PRODUCT_TYPE_WISH_TIME_MESSENGER = 'V06WZ'

const	PRODUCT_TYPE_AUSTRIA_PACKAGE = 'V86PARCEL'

const	PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE = 'V82PARCEL'

const	PRODUCT_TYPE_CONNECT_PACKAGE = 'V87PARCEL'

Detailed Description

Definition at line 23 of file ShipmentDetails.php.

Constructor & Destructor Documentation

§ __construct()

__construct ( $accountNumber )

ShipmentDetails constructor.

Parameters

string $accountNumber - Account-Number

Definition at line 230 of file ShipmentDetails.php.

§ __destruct()

__destruct ( )

Clears the Memory

Definition at line 237 of file ShipmentDetails.php.

Member Function Documentation

§ getBank()

getBank ( )

Get the Bank-Object

Returns: BankData|null - Bank-Object or null if none

Definition at line 555 of file ShipmentDetails.php.

§ getCustomerReference()

getCustomerReference ( )

Get the Customer-Reference

Returns: null|string - Customer Reference or null for none

Definition at line 329 of file ShipmentDetails.php.

§ getHeight()

getHeight ( )

Get the Height

Returns: int|null - Height in CM or null for none

Definition at line 467 of file ShipmentDetails.php.

§ getLength()

getLength ( )

Get the Length

Returns: int|null - Length in CM or null for none

Definition at line 431 of file ShipmentDetails.php.

§ getNotificationEmail()

getNotificationEmail ( )

Get the Notification E-Mail

Returns: string|null - Notification E-Mail or null for none

Definition at line 537 of file ShipmentDetails.php.

§ getPackageType()

getPackageType ( )

Get the Type of the Package

Return values: 'PK' or ShipmentDetails::PACKAGE -> DHL-Package-Type "Package" 'PL' or ShipmentDetails::PALETTE -> DHL-Package-Type "Palette"

Returns: string - Type of the Package

Deprecated:

DHL-API-Version 1 Method

Definition at line 509 of file ShipmentDetails.php.

§ getProduct()

getProduct ( )

Get which Product is used

Return values: (Use PRODUCT_TYPE_* constants - See above)
'V01PAK' or ShipmentDetails::PRODUCT_TYPE_NATIONAL_PACKAGE -> National-Package
'V01PRIO' or ShipmentDetails::PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO -> National-Package-Prio
'V53WPAK' or ShipmentDetails::PRODUCT_TYPE_INTERNATIONAL_PACKAGE -> International-Package
'V54EPAK' or ShipmentDetails::PRODUCT_TYPE_EUROPA_PACKAGE -> Europa-Package
'V55PAK' or ShipmentDetails::PRODUCT_TYPE_PACKED_CONNECT -> Packed Connect
'V06PAK' or ShipmentDetails::PRODUCT_TYPE_SAME_DAY_PACKAGE -> Same-Day Package
'V06TG' or ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER -> Same Day Messenger
'V06WZ' or ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER -> Wish Time Messenger
'V86PARCEL' or ShipmentDetails::PRODUCT_TYPE_AUSTRIA_PACKAGE -> Austria Package
'V82PARCEL' or ShipmentDetails::PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE -> Austria International Package
'V87PARCEL' or ShipmentDetails::PRODUCT_TYPE_CONNECT_PACKAGE -> Connect Package

Returns: string - Used Product

Definition at line 272 of file ShipmentDetails.php.

§ getReturnAccountNumber()

getReturnAccountNumber ( )

Get the Return-Account-Number (EKP)

Returns: null|string - Return-Account-Number or null for none

Definition at line 377 of file ShipmentDetails.php.

§ getReturnReference()

getReturnReference ( )

Get the Return-Reference

Returns: null|string - Return-Reference or null for none

Definition at line 395 of file ShipmentDetails.php.

§ getService()

getService ( )

Get the Service-Object

Returns: Service|null - Service-Object or null if none

Definition at line 485 of file ShipmentDetails.php.

§ getShipmentDate()

getShipmentDate ( )

Get the Shipment-Date (and set the default one -today- if none was set)

Returns: string - Shipment-Date as ISO-Date String YYYY-MM-DD

Definition at line 347 of file ShipmentDetails.php.

§ getShipmentDetailsClass_v1()

getShipmentDetailsClass_v1 ( )

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

Returns: StdClass - ShipmentDetailsClass

Deprecated:

DHL-API-Version 1 Method

Definition at line 590 of file ShipmentDetails.php.

§ getShipmentDetailsClass_v2()

getShipmentDetailsClass_v2 ( )

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

Returns: StdClass - DHL-ShipmentDetails-Class

Definition at line 602 of file ShipmentDetails.php.

§ getWeight()

getWeight ( )

Get the Weight

Returns: float - Weight in KG

Definition at line 413 of file ShipmentDetails.php.

§ getWidth()

getWidth ( )

Get the Width

Returns: int|null - Width in CM or null for none

Definition at line 449 of file ShipmentDetails.php.

§ setBank()

setBank ( $bank )

Set the Bank-Object

Parameters

BankData | null $bank - Bank-Object or null for none

Definition at line 564 of file ShipmentDetails.php.

§ setCustomerReference()

setCustomerReference ( $customerReference )

Set the Customer-Reference

Parameters

null | string $customerReference - Customer Reference or null for none

Definition at line 338 of file ShipmentDetails.php.

§ setHeight()

setHeight ( $height )

Set the Height

Parameters

int | null $height - Height in CM or null for none

Definition at line 476 of file ShipmentDetails.php.

§ setLength()

setLength ( $length )

Set the Length

Parameters

int | null $length - Length in CM or null for none

Definition at line 440 of file ShipmentDetails.php.

§ setNotificationEmail()

setNotificationEmail ( $notificationEmail )

Set the Notification E-Mail

Parameters

string | null $notificationEmail - Notification E-Mail or null for none

Definition at line 546 of file ShipmentDetails.php.

§ setPackageType()

setPackageType ( $packageType )

Set the Type of the Package

Allowed values: 'PK' or ShipmentDetails::PACKAGE -> DHL-Package-Type "Package" 'PL' or ShipmentDetails::PALETTE -> DHL-Package-Type "Palette"

Parameters

string $packageType - Type of the Package

Deprecated:

DHL-API-Version 1 Method

Definition at line 526 of file ShipmentDetails.php.

§ setProduct()

setProduct ( $product )

Set which Product is used

Parameters

string $product - Product, which should be used

Definition at line 294 of file ShipmentDetails.php.

§ setReturnAccountNumber()

setReturnAccountNumber ( $returnAccountNumber )

Set the Return-Account-Number (EKP)

Parameters

null | string $returnAccountNumber - Return-Account-Number or null for none

Definition at line 386 of file ShipmentDetails.php.

§ setReturnReference()

setReturnReference ( $returnReference )

Set the Return-Reference

Parameters

null | string $returnReference - Return-Reference or null for none

Definition at line 404 of file ShipmentDetails.php.

§ setService()

setService ( $service )

Set the Service-Object

Parameters

Service | null $service - Service-Object or null for none

Definition at line 494 of file ShipmentDetails.php.

§ setShipmentDate()

setShipmentDate	(	$shipmentDate,
		$useIntTime = `false`
	)

Set the Shipment-Date

Parameters

string \| int \| null	$shipmentDate	- Shipment-Date as String YYYY-MM-DD or the int value time() of the date \| null for today (+1 Day on Sunday)
bool	$useIntTime	- Use the int Time Value instead of a String

Definition at line 360 of file ShipmentDetails.php.

§ setWeight()

setWeight ( $weight )

Set the Weight

Parameters

float $weight - Weight in KG

Definition at line 422 of file ShipmentDetails.php.

§ setWidth()

setWidth ( $width )

Set the Width

Parameters

int | null $width - Width in CM or null for none

Definition at line 458 of file ShipmentDetails.php.

Field Documentation

§ PACKAGE

const PACKAGE = 'PK'

DHL-Package-Type "Package"

Deprecated:

DHL-API-Version 1 Constant

Definition at line 36 of file ShipmentDetails.php.

§ PALETTE

const PALETTE = 'PL'

DHL-Package-Type "Palette"

Deprecated:

DHL-API-Version 1 Constant

Definition at line 29 of file ShipmentDetails.php.

§ PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE

const PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE = 'V82PARCEL'

Definition at line 62 of file ShipmentDetails.php.

§ PRODUCT_TYPE_AUSTRIA_PACKAGE

const PRODUCT_TYPE_AUSTRIA_PACKAGE = 'V86PARCEL'

Definition at line 61 of file ShipmentDetails.php.

§ PRODUCT_TYPE_CONNECT_PACKAGE

const PRODUCT_TYPE_CONNECT_PACKAGE = 'V87PARCEL'

Definition at line 63 of file ShipmentDetails.php.

§ PRODUCT_TYPE_EUROPA_PACKAGE

const PRODUCT_TYPE_EUROPA_PACKAGE = 'V54EPAK'

Definition at line 56 of file ShipmentDetails.php.

§ PRODUCT_TYPE_INTERNATIONAL_PACKAGE

const PRODUCT_TYPE_INTERNATIONAL_PACKAGE = 'V53WPAK'

Definition at line 55 of file ShipmentDetails.php.

§ PRODUCT_TYPE_NATIONAL_PACKAGE

const PRODUCT_TYPE_NATIONAL_PACKAGE = 'V01PAK'

Product-Type Values:

ShipmentDetails::PRODUCT_TYPE_NATIONAL_PACKAGE -> National-Package
ShipmentDetails::PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO -> National-Package-Prio
ShipmentDetails::PRODUCT_TYPE_INTERNATIONAL_PACKAGE -> International-Package
ShipmentDetails::PRODUCT_TYPE_EUROPA_PACKAGE -> Europa-Package
ShipmentDetails::PRODUCT_TYPE_PACKED_CONNECT -> Packed Connect
ShipmentDetails::PRODUCT_TYPE_SAME_DAY_PACKAGE -> Same-Day Package
ShipmentDetails::PRODUCT_TYPE_SAME_DAY_MESSENGER -> Same Day Messenger
ShipmentDetails::PRODUCT_TYPE_WISH_TIME_MESSENGER -> Wish Time Messenger
ShipmentDetails::PRODUCT_TYPE_AUSTRIA_PACKAGE -> Austria Package
ShipmentDetails::PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE -> Austria International Package
ShipmentDetails::PRODUCT_TYPE_CONNECT_PACKAGE -> Connect Package

Definition at line 53 of file ShipmentDetails.php.

§ PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO

const PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO = 'V01PRIO'

Definition at line 54 of file ShipmentDetails.php.

§ PRODUCT_TYPE_PACKED_CONNECT

const PRODUCT_TYPE_PACKED_CONNECT = 'V55PAK'

Definition at line 57 of file ShipmentDetails.php.

§ PRODUCT_TYPE_SAME_DAY_MESSENGER

const PRODUCT_TYPE_SAME_DAY_MESSENGER = 'V06TG'

Definition at line 59 of file ShipmentDetails.php.

§ PRODUCT_TYPE_SAME_DAY_PACKAGE

const PRODUCT_TYPE_SAME_DAY_PACKAGE = 'V06PAK'

Definition at line 58 of file ShipmentDetails.php.

§ PRODUCT_TYPE_WISH_TIME_MESSENGER

const PRODUCT_TYPE_WISH_TIME_MESSENGER = 'V06WZ'

Definition at line 60 of file ShipmentDetails.php.

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

includes/ShipmentDetails.php

Public Member Functions

Data Fields

Detailed Description

Constructor & Destructor Documentation

§ __construct()

§ __destruct()

Member Function Documentation

§ getBank()

§ getCustomerReference()

§ getHeight()

§ getLength()

§ getNotificationEmail()

§ getPackageType()

§ getProduct()

§ getReturnAccountNumber()

§ getReturnReference()

§ getService()

§ getShipmentDate()

§ getShipmentDetailsClass_v1()

§ getShipmentDetailsClass_v2()

§ getWeight()

§ getWidth()

§ setBank()

§ setCustomerReference()

§ setHeight()

§ setLength()

§ setNotificationEmail()

§ setPackageType()

§ setProduct()

§ setReturnAccountNumber()

§ setReturnReference()

§ setService()

§ setShipmentDate()

§ setWeight()

§ setWidth()

Field Documentation

§ PACKAGE

§ PALETTE

§ PRODUCT_TYPE_AUSTRIA_INTERNATIONAL_PACKAGE

§ PRODUCT_TYPE_AUSTRIA_PACKAGE

§ PRODUCT_TYPE_CONNECT_PACKAGE

§ PRODUCT_TYPE_EUROPA_PACKAGE

§ PRODUCT_TYPE_INTERNATIONAL_PACKAGE

§ PRODUCT_TYPE_NATIONAL_PACKAGE

§ PRODUCT_TYPE_NATIONAL_PACKAGE_PRIO

§ PRODUCT_TYPE_PACKED_CONNECT

§ PRODUCT_TYPE_SAME_DAY_MESSENGER

§ PRODUCT_TYPE_SAME_DAY_PACKAGE

§ PRODUCT_TYPE_WISH_TIME_MESSENGER