- Generated by
1.8.12
|
DHL-PHP-SDK
v0.4
A wrapper for the DHL-XML-API Version 2
|
Definition at line 23 of file Service.php.
| __destruct | ( | ) |
Clears Memory
Definition at line 483 of file Service.php.
| getAdditionalInsuranceAmount | ( | ) |
Get the Amount with that the Shipment is insured
Definition at line 1363 of file Service.php.
| getAdditionalInsuranceEnabled | ( | ) |
Get if additional Insurance is enabled
Definition at line 1345 of file Service.php.
| getBulkyGoods | ( | ) |
Get if you deliver Bulky-Goods
Definition at line 1381 of file Service.php.
| getCashOnDeliveryAddFee | ( | ) |
Get if the Service "AddFee" is enabled
Definition at line 1309 of file Service.php.
| getCashOnDeliveryAmount | ( | ) |
Get the Amount how much the receiver must pay
Definition at line 1327 of file Service.php.
| getCashOnDeliveryEnabled | ( | ) |
Get if Cash on delivery (COD) is enabled
Definition at line 1291 of file Service.php.
| getDayOfDeliveryDate | ( | ) |
Get the Date for the Service "DayOfDelivery"
Definition at line 547 of file Service.php.
| getDayOfDeliveryEnabled | ( | ) |
Get if the Service "DayOfDelivery" is enabled
Definition at line 529 of file Service.php.
| getDeliveryTimeframe | ( | ) |
Get the Timeframe for the Service "DeliveryTimeframe"
You get Values like this: 10:00 - 12:30 => '10001230' 9:13 - 10:00 => '09131000' 16:00 - 19:00 => '16001900'
Definition at line 596 of file Service.php.
| getDeliveryTimeframeEnabled | ( | ) |
Get if the Service "DeliveryTimeframe" is enabled
Definition at line 573 of file Service.php.
| getDisableNeighbourDelivery | ( | ) |
Get if the Service "DisableNeighbourDelivery" is enabled
Definition at line 1219 of file Service.php.
| getEndorsementEnabled | ( | ) |
Get if the Service "Endorsement" is enabled
Definition at line 935 of file Service.php.
| getEndorsementType | ( | ) |
Get the Endorsement Type
Values for national: 'SOZU': (Return immediately),
Values for International: 'IMMEDIATE': (Sending back immediately to sender), 'AFTER_DEADLINE': (Sending back immediately to sender after expiration of time), 'ABANDONMENT': (Abandonment of parcel at the hands of sender (free of charge))
Definition at line 962 of file Service.php.
| getGoGreen | ( | ) |
Get if the Service "GoGreen" is enabled
Definition at line 1143 of file Service.php.
| getIdentCheckEnabled | ( | ) |
Get if Ident check is enabled
Definition at line 1399 of file Service.php.
| getIdentCheckObj | ( | ) |
Get the IdentCheck Object
Definition at line 1417 of file Service.php.
| getIndividualSenderRequiredmentsEnabled | ( | ) |
Alias for $this->getIndividualSenderRequirementsEnabled()
Definition at line 667 of file Service.php.
| getIndividualSenderRequiredmentsText | ( | ) |
Alias for $this->getIndividualSenderRequirementsText()
Definition at line 699 of file Service.php.
| getIndividualSenderRequirementsEnabled | ( | ) |
Get if the Service "IndividualSenderRequirements" is enabled
Definition at line 729 of file Service.php.
| getIndividualSenderRequirementsText | ( | ) |
Get the Sender Requirements
Definition at line 747 of file Service.php.
| getNamedPersonOnly | ( | ) |
Get if named Person can only accept delivery
Definition at line 1237 of file Service.php.
| getNoticeNonDeliverability | ( | ) |
Alias for $this->getNoticeOnNonDeliverable()
Definition at line 835 of file Service.php.
| getNoticeOnNonDeliverable | ( | ) |
Get if the Service "Notice on Non-Deliverable" is enabled
Definition at line 865 of file Service.php.
| getPackagingReturn | ( | ) |
Get if Packaging return is enabled
Definition at line 765 of file Service.php.
| getPerishables | ( | ) |
Get if deliver Perishables
Definition at line 1167 of file Service.php.
| getPersonalHandover | ( | ) |
Get if the Service "PersonalHandover" is enabled
Definition at line 1187 of file Service.php.
| getPreferredDayEnabled | ( | ) |
Get if the Service "PreferredDay" is enabled
Definition at line 1105 of file Service.php.
| getPreferredDayText | ( | ) |
Get the details of the preferred Day (Free text)
Definition at line 1123 of file Service.php.
| getPreferredLocationDetails | ( | ) |
Get the details of the preferred Location (Free text)
Definition at line 1051 of file Service.php.
| getPreferredLocationEnabled | ( | ) |
Get if the Service "PreferredLocation" is enabled
Definition at line 1033 of file Service.php.
| getPreferredNeighbourEnabled | ( | ) |
Get if the Service "PreferredNeighbour" is enabled
Definition at line 1069 of file Service.php.
| getPreferredNeighbourText | ( | ) |
Get the details of the preferred Neighbour (Free text)
Definition at line 1087 of file Service.php.
| getPreferredTime | ( | ) |
Get the Timeframe for the "PreferredTime"-Service
You get Values like this: 10:00 - 12:30 => '10001230' 9:13 - 10:00 => '09131000' 16:00 - 19:00 => '16001900'
Definition at line 642 of file Service.php.
| getPreferredTimeEnabled | ( | ) |
Get if the Service "PreferredTime" is enabled
Definition at line 619 of file Service.php.
| getPremium | ( | ) |
Get if Premium is enabled (for fast and safe delivery of international shipments)
Definition at line 1273 of file Service.php.
| getReturnImmediatelyIfShipmentFailed | ( | ) |
Get if the Package should return immediately when the shipping has failed
Definition at line 815 of file Service.php.
| getReturnImmediatlyIfShipmentFailed | ( | ) |
Alias for $this->getReturnImmediatelyIfShipmentFailed()
Definition at line 785 of file Service.php.
| getReturnReceipt | ( | ) |
Get if the Service "ReturnReceipt" is enabled
Definition at line 1255 of file Service.php.
| getServiceClass_v1 | ( | $productType | ) |
Get the Class of this Service-Object
| string | $productType | - Type of the Product |
Definition at line 1438 of file Service.php.
| getServiceClass_v2 | ( | $productType | ) |
Get the Class of this Service-Object
| string | $productType | - Type of the Product |
Definition at line 1451 of file Service.php.
| getShipmentHandlingEnabled | ( | ) |
Get if the Service "ShipmentHandling" is enabled
Definition at line 883 of file Service.php.
| getShipmentHandlingType | ( | ) |
Get the Shipment-Handling Type
You will get the following values: 'a': Remove content, return box; 'b': Remove content, pick up and dispose cardboard packaging; 'c': Handover parcel/box to customer ¿ no disposal of cardboar.d/box; 'd': Remove bag from of cooling unit and handover to customer; 'e': Remove content, apply return label und seal box, return box null: none
Definition at line 909 of file Service.php.
| getVisualCheckOfAgeEnabled | ( | ) |
Get if the Service "VisualCheckOfAge" is enabled
Definition at line 989 of file Service.php.
| getVisualCheckOfAgeType | ( | ) |
Get the Age that the Receiver should be at least have
You will get the following values: 'A16': Person must be 16+ 'A18': Person must be 18+
Definition at line 1011 of file Service.php.
| setAdditionalInsuranceAmount | ( | $additionalInsuranceAmount | ) |
Set the Amount with that the Shipment is insured
| float | null | $additionalInsuranceAmount | - The Amount with that the Shipment is insured or null for none |
Definition at line 1372 of file Service.php.
| setAdditionalInsuranceEnabled | ( | $additionalInsuranceEnabled | ) |
Set if additional Insurance is enabled
| bool | null | $additionalInsuranceEnabled | - Is additional Insurance enabled or null for default |
Definition at line 1354 of file Service.php.
| setBulkyGoods | ( | $bulkyGoods | ) |
Set if you deliver Bulky-Goods
| bool | null | $bulkyGoods | - Do you deliver Bulky-Goods or null for default |
Definition at line 1390 of file Service.php.
| setCashOnDeliveryAddFee | ( | $cashOnDeliveryAddFee | ) |
Set if the Service "AddFee" is enabled
| bool | null | $cashOnDeliveryAddFee | - Is the Service "AddFee" is enabled or null for default |
Definition at line 1318 of file Service.php.
| setCashOnDeliveryAmount | ( | $cashOnDeliveryAmount | ) |
Set the Amount how much the receiver must pay
| float | null | $cashOnDeliveryAmount | - The Amount how much the receiver must pay or null for none |
Definition at line 1336 of file Service.php.
| setCashOnDeliveryEnabled | ( | $cashOnDeliveryEnabled | ) |
Set if Cash on delivery (COD) is enabled
| bool | null | $cashOnDeliveryEnabled | - Is Cash on delivery (COD) enabled or null for default |
Definition at line 1300 of file Service.php.
| setDayOfDeliveryDate | ( | $dayOfDeliveryDate, | |
$useIntTime = false |
|||
| ) |
Set the Date for the Service "DayOfDelivery"
| null | int | string | $dayOfDeliveryDate | - The Day of Delivery as ISO-Date-Format (YYYY-MM-DD), the day as time() int value or null for none |
| bool | $useIntTime | - Use the int Time Value instead of a String |
Definition at line 557 of file Service.php.
| setDayOfDeliveryEnabled | ( | $dayOfDeliveryEnabled | ) |
Set if the Service "DayOfDelivery" is enabled
| bool | null | $dayOfDeliveryEnabled | - Service "DayOfDelivery" is enabled or null for default |
Definition at line 538 of file Service.php.
| setDeliveryTimeframe | ( | $deliveryTimeframe | ) |
Set the Timeframe for the Service "DeliveryTimeframe"
Write Values like this: 10:00 - 12:30 => (Correct Value) '10001230' 9:13 - 10:00 => '09131000' 16:00 - 19:00 => '16001900'
| null | string | $deliveryTimeframe | - Timeframe for the Service "DeliveryTimeframe" or null for none |
Definition at line 610 of file Service.php.
| setDeliveryTimeframeEnabled | ( | $deliveryTimeframeEnabled | ) |
Set if the Service "DeliveryTimeframe" is enabled
| bool | null | $deliveryTimeframeEnabled | - Service "DeliveryTimeframe" is enabled or null for default |
Definition at line 582 of file Service.php.
| setDisableNeighbourDelivery | ( | $disableNeighbourDelivery | ) |
Set if the Service "DisableNeighbourDelivery" is enabled
| bool | null | $disableNeighbourDelivery | - Is the Service "DisableNeighbourDelivery" enabled or null for default |
Definition at line 1228 of file Service.php.
| setEndorsementEnabled | ( | $endorsementEnabled | ) |
Set if the Service "Endorsement" is enabled
| bool | null | $endorsementEnabled | - Is the Service "Endorsement" enabled or null for default |
Definition at line 944 of file Service.php.
| setEndorsementType | ( | $endorsementType | ) |
Set the Endorsement Type
Values for national: 'SOZU': (Return immediately),
Values for International: 'IMMEDIATE': (Sending back immediately to sender), 'AFTER_DEADLINE': (Sending back immediately to sender after expiration of time), 'ABANDONMENT': (Abandonment of parcel at the hands of sender (free of charge))
| null | string | $endorsementType | - Endorsement-Service Type or null for none |
Definition at line 980 of file Service.php.
| setGoGreen | ( | $goGreen | ) |
Set if the Service "GoGreen" is enabled
| bool | null | $goGreen | - Is the Service "GoGreen" enabled or null for default |
Definition at line 1156 of file Service.php.
| setIdentCheckEnabled | ( | $identCheckEnabled | ) |
Set if Ident check is enabled
| bool | null | $identCheckEnabled | - Is Ident check enabled or null for default |
Definition at line 1408 of file Service.php.
| setIdentCheckObj | ( | $identCheckObj | ) |
Set the IdentCheck Object
| IdentCheck | null | $identCheckObj | - The IdentCheck Object or null for none |
Definition at line 1426 of file Service.php.
| setIndividualSenderRequiredmentsEnabled | ( | $individualSenderRequirementsEnabled | ) |
Alias for $this->setIndividualSenderRequirementsEnabled()
| bool | null | $individualSenderRequirementsEnabled | - Service "IndividualSenderRequirements" is enabled or null for default |
Definition at line 683 of file Service.php.
| setIndividualSenderRequiredmentsText | ( | $individualSenderRequirementsText | ) |
Alias for $this->setIndividualSenderRequirementsText()
| null | string | $individualSenderRequirementsText | - Sender Requirement (Free text) or null for none |
Definition at line 715 of file Service.php.
| setIndividualSenderRequirementsEnabled | ( | $individualSenderRequirementsEnabled | ) |
Set if the Service "IndividualSenderRequirements" is enabled
| bool | null | $individualSenderRequirementsEnabled | - Service "IndividualSenderRequirements" is enabled or null for default |
Definition at line 738 of file Service.php.
| setIndividualSenderRequirementsText | ( | $individualSenderRequirementsText | ) |
Set the Sender Requirements
| null | string | $individualSenderRequirementsText | - Sender Requirement (Free text) or null for none |
Definition at line 756 of file Service.php.
| setNamedPersonOnly | ( | $namedPersonOnly | ) |
Set if named Person can only accept delivery
| bool | null | $namedPersonOnly | - Named Person can only accept delivery or null for default |
Definition at line 1246 of file Service.php.
| setNoticeNonDeliverability | ( | $noticeOnNonDeliverable | ) |
Alias for $this->setNoticeOnNonDeliverable()
| bool | null | $noticeOnNonDeliverable | - Is the Service "Notice on Non-Deliverable" enabled or null for default |
Definition at line 851 of file Service.php.
| setNoticeOnNonDeliverable | ( | $noticeOnNonDeliverable | ) |
Set if the Service "Notice on Non-Deliverable" is enabled
| bool | null | $noticeOnNonDeliverable | - Is the Service "Notice on Non-Deliverable" enabled or null for default |
Definition at line 874 of file Service.php.
| setPackagingReturn | ( | $packagingReturn | ) |
Set if Packaging return is enabled
| bool | null | $packagingReturn | - Packaging return is enabled or null for default |
Definition at line 774 of file Service.php.
| setPerishables | ( | $perishables | ) |
Set if deliver Perishables
| bool | null | $perishables | - Deliver Perishables or null for default |
Definition at line 1176 of file Service.php.
| setPersonalHandover | ( | $personalHandover | ) |
Set if the Service "PersonalHandover" is enabled
| bool | null | $personalHandover | - Is the Service "PersonalHandover" enabled or null for default |
Definition at line 1204 of file Service.php.
| setPreferredDayEnabled | ( | $preferredDayEnabled | ) |
Set if the Service "PreferredDay" is enabled
| bool | null | $preferredDayEnabled | - Is the Service "PreferredDay" enabled or null for default |
Definition at line 1114 of file Service.php.
| setPreferredDayText | ( | $preferredDayText | ) |
Set the details of the preferred Day (Free text)
| null | string | $preferredDayText | - The details of the preferred Day (Free text) or null for none |
Definition at line 1132 of file Service.php.
| setPreferredLocationDetails | ( | $preferredLocationDetails | ) |
Set the details of the preferred Location (Free text)
| null | string | $preferredLocationDetails | - Details of the preferred Location (Free text) or null for none |
Definition at line 1060 of file Service.php.
| setPreferredLocationEnabled | ( | $preferredLocationEnabled | ) |
Set if the Service "PreferredLocation" is enabled
| bool | null | $preferredLocationEnabled | - Is the Service "PreferredLocation" enabled or null for default |
Definition at line 1042 of file Service.php.
| setPreferredNeighbourEnabled | ( | $preferredNeighbourEnabled | ) |
Set if the Service "PreferredNeighbour" is enabled
| bool | null | $preferredNeighbourEnabled | - Is the Service "PreferredNeighbour" enabled or null for default |
Definition at line 1078 of file Service.php.
| setPreferredNeighbourText | ( | $preferredNeighbourText | ) |
Set the details of the preferred Neighbour (Free text)
| null | string | $preferredNeighbourText | - The details of the preferred Neighbour (Free text) or null for none |
Definition at line 1096 of file Service.php.
| setPreferredTime | ( | $preferredTime | ) |
Set the Timeframe for the "PreferredTime"-Service
Write Values like this: 10:00 - 12:30 => (Correct Value) '10001230' or 9:13 - 10:00 => '09131000' or 16:00 - 19:00 => '16001900'
| null | string | $preferredTime | - Preferred Time-Frame or null for none |
Definition at line 656 of file Service.php.
| setPreferredTimeEnabled | ( | $preferredTimeEnabled | ) |
Set if the Service "PreferredTime" is enabled
| bool | null | $preferredTimeEnabled | - Service "PreferredTime" is enabled or null for default |
Definition at line 628 of file Service.php.
| setPremium | ( | $premium | ) |
Set if Premium is enabled (for fast and safe delivery of international shipments)
| bool | null | $premium | - Premium is enabled or null for default |
Definition at line 1282 of file Service.php.
| setReturnImmediatelyIfShipmentFailed | ( | $returnImmediatelyIfShipmentFailed | ) |
Set if the Package should return immediately when the shipping has failed
| bool | null | $returnImmediatelyIfShipmentFailed | - Should Package return immediately when the shipping has failed or null for default |
Definition at line 824 of file Service.php.
| setReturnImmediatlyIfShipmentFailed | ( | $returnImmediatelyIfShipmentFailed | ) |
Alias for $this->setReturnImmediatelyIfShipmentFailed()
| bool | null | $returnImmediatelyIfShipmentFailed | - Should Package return immediately when the shipping has failed or null for default |
Definition at line 801 of file Service.php.
| setReturnReceipt | ( | $returnReceipt | ) |
Set if the Service "ReturnReceipt" is enabled
| bool | null | $returnReceipt | - Is the Service "ReturnReceipt" enabled or null for default |
Definition at line 1264 of file Service.php.
| setShipmentHandlingEnabled | ( | $shipmentHandlingEnabled | ) |
Set if the Service "ShipmentHandling" is enabled
| bool | null | $shipmentHandlingEnabled | - Is the Service "ShipmentHandling" enabled or null for default |
Definition at line 892 of file Service.php.
| setShipmentHandlingType | ( | $shipmentHandlingType | ) |
Set the Shipment-Handling Type
The following values are allowed: 'a': Remove content, return box; 'b': Remove content, pick up and dispose cardboard packaging; 'c': Handover parcel/box to customer ¿ no disposal of cardboar.d/box; 'd': Remove bag from of cooling unit and handover to customer; 'e': Remove content, apply return label und seal box, return box null: none
| null | string | $shipmentHandlingType | - Shipment-Handling Type or null for none |
Definition at line 926 of file Service.php.
| setVisualCheckOfAgeEnabled | ( | $visualCheckOfAgeEnabled | ) |
Set if the Service "VisualCheckOfAge" is enabled
| bool | null | $visualCheckOfAgeEnabled | - Is the Service "VisualCheckOfAge" enabled or null for default |
Definition at line 998 of file Service.php.
| setVisualCheckOfAgeType | ( | $visualCheckOfAgeType | ) |
Set the Age that the Receiver should be at least have
The following Values are allowed: 'A16': Person must be 16+ 'A18': Person must be 18+
| null | string | $visualCheckOfAgeType | - Minimum-Age of the Receiver or null for none |
Definition at line 1024 of file Service.php.
1.8.12