GeschaeftskundenversandShipment
in package
Class GeschaeftskundenversandShipment
Tags
Table of Contents
- $ekp : mixed
- $product : mixed
- $shipmentData : mixed
- __construct() : mixed
- GeschaeftskundenversandShipment constructor.
- addExportDocPosition() : mixed
- setAllServices() : mixed
- setBankData() : mixed
- setCombinedPrinting() : mixed
- setCustomerReference() : mixed
- setExportDocument() : mixed
- setExportTypeDescription() : mixed
- setLabelFormat() : void
- Sets label format.
- setLabelFormatRetoure() : void
- Sets label format for return labels.
- setLabelResponseType() : mixed
- setNotification() : mixed
- setPrintOnlyIfCodeable() : mixed
- setProduct() : mixed
- setReceiverAdditionalNames() : mixed
- setReceiverAddress() : mixed
- setReceiverCommunication() : mixed
- setReceiverName() : mixed
- setReceiverPackstation() : mixed
- setReceiverParcelShop() : mixed
- setReceiverPostfiliale() : mixed
- setReturnReceiverAddress() : mixed
- setReturnReceiverCommunication() : mixed
- setReturnReceiverName() : mixed
- setReturnShipmentAccountNumber() : void
- setServiceAdditionalInsurance() : mixed
- setServiceBulkyGoods() : mixed
- setServiceCashOnDelivery() : mixed
- Sets COD amount.
- setServiceCDP() : void
- Sets service Closest Drop Point
- setServiceDayOfDelivery() : mixed
- setServiceDeliveryTimeframe() : mixed
- setServiceEconomy() : void
- Sets service Economy
- setServiceEndorsement() : mixed
- setServiceGoGreen() : mixed
- setServiceIdentCheck() : mixed
- setServiceIndividualSenderRequirement() : mixed
- setServiceNamedPersonOnly() : mixed
- setServiceNoNeighbourDelivery() : mixed
- setServiceNoticeOfNonDeliverability() : mixed
- setServicePackagingReturn() : mixed
- setServiceParcelOutletRouting() : void
- setServicePDDP() : void
- Sets service Postal Delivery Duty Paid
- setServicePerishables() : mixed
- setServicePersonally() : mixed
- setServicePreferredDay() : mixed
- setServicePreferredLocation() : mixed
- setServicePreferredNeighbour() : mixed
- setServicePreferredTime() : mixed
- setServicePremium() : mixed
- setServiceReturnImmediately() : mixed
- setServiceReturnReceipt() : mixed
- setServiceShipmentHandling() : mixed
- setServiceVisualCheckOfAge() : mixed
- setShipmentDate() : mixed
- setShipperAddress() : mixed
- setShipperCommunication() : mixed
- setShipperName() : mixed
- setShipperReference() : void
- Sets a ShipperReference.
- setWeight() : mixed
- toArray() : mixed
Properties
$ekp
protected
mixed
$ekp
$product
protected
mixed
$product
$shipmentData
protected
mixed
$shipmentData
Methods
__construct()
GeschaeftskundenversandShipment constructor.
public
__construct( $ekp) : mixed
Parameters
Tags
Return values
mixed —addExportDocPosition()
public
addExportDocPosition(mixed $description, mixed $countryCode, mixed $customsTariffNumber, mixed $amount, mixed $netWeightKG, mixed $customsValue) : mixed
Parameters
- $description : mixed
- $countryCode : mixed
- $customsTariffNumber : mixed
- $amount : mixed
- $netWeightKG : mixed
- $customsValue : mixed
Return values
mixed —setAllServices()
public
setAllServices(array<string|int, mixed> $servicesArray) : mixed
Parameters
- $servicesArray : array<string|int, mixed>
Return values
mixed —setBankData()
public
setBankData(mixed $accountOwner, mixed $bankName, mixed $iban[, mixed $note1 = '' ][, mixed $note2 = '' ][, mixed $bic = '' ][, mixed $accountreference = '' ]) : mixed
Parameters
- $accountOwner : mixed
- $bankName : mixed
- $iban : mixed
- $note1 : mixed = ''
- $note2 : mixed = ''
- $bic : mixed = ''
- $accountreference : mixed = ''
Return values
mixed —setCombinedPrinting()
public
setCombinedPrinting([bool $active = false ]) : mixed
Parameters
- $active : bool = false
Return values
mixed —setCustomerReference()
public
setCustomerReference(mixed $customerReference) : mixed
Parameters
- $customerReference : mixed
Return values
mixed —setExportDocument()
public
setExportDocument(mixed $exportType, mixed $placeOfCommital, mixed $additionalFee[, mixed $invNumber = '' ][, mixed $termsOfTrade = '' ][, mixed $permitNumber = '' ][, mixed $attestationNumber = '' ][, mixed $withElectronicExportNtfctn = null ]) : mixed
Parameters
- $exportType : mixed
- $placeOfCommital : mixed
- $additionalFee : mixed
- $invNumber : mixed = ''
- $termsOfTrade : mixed = ''
- $permitNumber : mixed = ''
- $attestationNumber : mixed = ''
- $withElectronicExportNtfctn : mixed = null
Return values
mixed —setExportTypeDescription()
public
setExportTypeDescription(mixed $exportTypeDescription) : mixed
Parameters
- $exportTypeDescription : mixed
Return values
mixed —setLabelFormat()
Sets label format.
public
setLabelFormat([string $format = 'A4' ]) : void
Valid formats are: A4: common label laser printing A4 plain paper; 910-300-700: common label laser printing 105 x 205 mm (A5 plain paper, 910-300-700); 910-300-700-oz: common label laser printing 105 x 205 mm without additional barcode labels (A5 plain paper, 910-300-700); 910-300-300: common label laser printing 105 x 148 mm (A5 plain paper, 910-300-700); 910-300-300-oz: common label laser printing 105 x 148 mm without additional barcode labels (A5 plain paper, 910-300-300); 910-300-710: common label laser printing 105 x 208 mm (910-300-710); 910-300-600: common label thermal printing 103 x 199 mm (910-300-600, 910-300-610); 910-300-400: common label thermal printing 103 x 150 mm (910-300-400, 910-300-410); 100x70mm: 100 x 70 mm label (only for Warenpost and Warenpost International);
Parameters
- $format : string = 'A4'
Return values
void —setLabelFormatRetoure()
Sets label format for return labels.
public
setLabelFormatRetoure([string $format = 'A4' ]) : void
Valid formats are: A4: common label laser printing A4 plain paper; 910-300-700: common label laser printing 105 x 205 mm (A5 plain paper, 910-300-700); 910-300-700-oz: common label laser printing 105 x 205 mm without additional barcode labels (A5 plain paper, 910-300-700); 910-300-300: common label laser printing 105 x 148 mm (A5 plain paper, 910-300-700); 910-300-300-oz: common label laser printing 105 x 148 mm without additional barcode labels (A5 plain paper, 910-300-300); 910-300-710: common label laser printing 105 x 208 mm (910-300-710); 910-300-600: common label thermal printing 103 x 199 mm (910-300-600, 910-300-610); 910-300-400: common label thermal printing 103 x 150 mm (910-300-400, 910-300-410); 100x70mm: 100 x 70 mm label (only for Warenpost and Warenpost International);
Parameters
- $format : string = 'A4'
Return values
void —setLabelResponseType()
public
setLabelResponseType([mixed $type = 'URL' ]) : mixed
Parameters
- $type : mixed = 'URL'
Return values
mixed —setNotification()
public
setNotification(mixed $emailAddress) : mixed
Parameters
- $emailAddress : mixed
Return values
mixed —setPrintOnlyIfCodeable()
public
setPrintOnlyIfCodeable(mixed $onlyIfCodeable) : mixed
Parameters
- $onlyIfCodeable : mixed
Return values
mixed —setProduct()
public
setProduct(GeschaeftskundenversandProduct $product[, mixed $setReturnAccount = false ]) : mixed
Parameters
- $product : GeschaeftskundenversandProduct
- $setReturnAccount : mixed = false
Return values
mixed —setReceiverAdditionalNames()
public
setReceiverAdditionalNames(mixed $name2, mixed $name3) : mixed
Parameters
- $name2 : mixed
- $name3 : mixed
Return values
mixed —setReceiverAddress()
public
setReceiverAddress(mixed $streetName, mixed $streetNumber, mixed $addition, mixed $zip, mixed $city, mixed $iso2[, mixed $state = '' ][, mixed $country = '' ]) : mixed
Parameters
- $streetName : mixed
- $streetNumber : mixed
- $addition : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $state : mixed = ''
- $country : mixed = ''
Return values
mixed —setReceiverCommunication()
public
setReceiverCommunication([mixed $phone = '' ][, mixed $email = '' ][, mixed $contactPerson = '' ]) : mixed
Parameters
- $phone : mixed = ''
- $email : mixed = ''
- $contactPerson : mixed = ''
Return values
mixed —setReceiverName()
public
setReceiverName(mixed $name1) : mixed
Parameters
- $name1 : mixed
Return values
mixed —setReceiverPackstation()
public
setReceiverPackstation(mixed $packstationNumber, mixed $zip, mixed $city, mixed $iso2[, mixed $postNumber = '' ][, mixed $country = '' ][, mixed $state = '' ]) : mixed
Parameters
- $packstationNumber : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $postNumber : mixed = ''
- $country : mixed = ''
- $state : mixed = ''
Return values
mixed —setReceiverParcelShop()
public
setReceiverParcelShop(mixed $parcelShopNumber, mixed $zip, mixed $city, mixed $iso2[, mixed $streetName = '' ][, mixed $streetNumber = '' ][, mixed $country = '' ][, mixed $state = '' ]) : mixed
Parameters
- $parcelShopNumber : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $streetName : mixed = ''
- $streetNumber : mixed = ''
- $country : mixed = ''
- $state : mixed = ''
Tags
Return values
mixed —setReceiverPostfiliale()
public
setReceiverPostfiliale(mixed $postfilialNumber, mixed $zip, mixed $city, mixed $iso2, mixed $postNumber[, mixed $country = '' ][, mixed $state = '' ]) : mixed
Parameters
- $postfilialNumber : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $postNumber : mixed
- $country : mixed = ''
- $state : mixed = ''
Return values
mixed —setReturnReceiverAddress()
public
setReturnReceiverAddress(mixed $streetName, mixed $streetNumber, mixed $addition, mixed $zip, mixed $city, mixed $iso2[, mixed $state = '' ][, mixed $country = '' ]) : mixed
Parameters
- $streetName : mixed
- $streetNumber : mixed
- $addition : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $state : mixed = ''
- $country : mixed = ''
Return values
mixed —setReturnReceiverCommunication()
public
setReturnReceiverCommunication([mixed $phone = '' ][, mixed $email = '' ][, mixed $contactPerson = '' ]) : mixed
Parameters
- $phone : mixed = ''
- $email : mixed = ''
- $contactPerson : mixed = ''
Return values
mixed —setReturnReceiverName()
public
setReturnReceiverName(mixed $name1[, mixed $name2 = '' ][, mixed $name3 = '' ]) : mixed
Parameters
- $name1 : mixed
- $name2 : mixed = ''
- $name3 : mixed = ''
Return values
mixed —setReturnShipmentAccountNumber()
public
setReturnShipmentAccountNumber(string $accountNumber) : void
Parameters
- $accountNumber : string
Return values
void —setServiceAdditionalInsurance()
public
setServiceAdditionalInsurance(mixed $insuranceAmount) : mixed
Parameters
- $insuranceAmount : mixed
Return values
mixed —setServiceBulkyGoods()
public
setServiceBulkyGoods([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceCashOnDelivery()
Sets COD amount.
public
setServiceCashOnDelivery([float $codAmount = 0.0 ][, bool $addFee = false ]) : mixed
Parameters
- $codAmount : float = 0.0
- $addFee : bool = false
-
deprecated, unused
Return values
mixed —setServiceCDP()
Sets service Closest Drop Point
public
setServiceCDP([bool $activate = false ]) : void
Parameters
- $activate : bool = false
Return values
void —setServiceDayOfDelivery()
public
setServiceDayOfDelivery([mixed $date = '' ]) : mixed
Parameters
- $date : mixed = ''
Return values
mixed —setServiceDeliveryTimeframe()
public
setServiceDeliveryTimeframe([mixed $timeframe = '' ]) : mixed
Parameters
- $timeframe : mixed = ''
Return values
mixed —setServiceEconomy()
Sets service Economy
public
setServiceEconomy([bool $activate = false ]) : void
Parameters
- $activate : bool = false
Return values
void —setServiceEndorsement()
public
setServiceEndorsement([mixed $type = '' ]) : mixed
Parameters
- $type : mixed = ''
Return values
mixed —setServiceGoGreen()
public
setServiceGoGreen([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceIdentCheck()
public
setServiceIdentCheck([mixed $surname = '' ][, mixed $givenName = '' ][, mixed $dateOfBirth = '' ][, mixed $minimumAge = '' ]) : mixed
Parameters
- $surname : mixed = ''
- $givenName : mixed = ''
- $dateOfBirth : mixed = ''
- $minimumAge : mixed = ''
Return values
mixed —setServiceIndividualSenderRequirement()
public
setServiceIndividualSenderRequirement([mixed $requirementText = '' ]) : mixed
Parameters
- $requirementText : mixed = ''
Return values
mixed —setServiceNamedPersonOnly()
public
setServiceNamedPersonOnly([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceNoNeighbourDelivery()
public
setServiceNoNeighbourDelivery([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceNoticeOfNonDeliverability()
public
setServiceNoticeOfNonDeliverability([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServicePackagingReturn()
public
setServicePackagingReturn([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceParcelOutletRouting()
public
setServiceParcelOutletRouting([bool $activate = false ][, string $email = '' ]) : void
Parameters
- $activate : bool = false
- $email : string = ''
Return values
void —setServicePDDP()
Sets service Postal Delivery Duty Paid
public
setServicePDDP([bool $activate = false ]) : void
Parameters
- $activate : bool = false
Return values
void —setServicePerishables()
public
setServicePerishables([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServicePersonally()
public
setServicePersonally([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServicePreferredDay()
public
setServicePreferredDay([mixed $details = '' ]) : mixed
Parameters
- $details : mixed = ''
Return values
mixed —setServicePreferredLocation()
public
setServicePreferredLocation([mixed $details = '' ]) : mixed
Parameters
- $details : mixed = ''
Return values
mixed —setServicePreferredNeighbour()
public
setServicePreferredNeighbour([mixed $details = '' ]) : mixed
Parameters
- $details : mixed = ''
Return values
mixed —setServicePreferredTime()
public
setServicePreferredTime(mixed $preferredTime) : mixed
Parameters
- $preferredTime : mixed
Return values
mixed —setServicePremium()
public
setServicePremium([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceReturnImmediately()
public
setServiceReturnImmediately([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceReturnReceipt()
public
setServiceReturnReceipt([mixed $activate = false ]) : mixed
Parameters
- $activate : mixed = false
Return values
mixed —setServiceShipmentHandling()
public
setServiceShipmentHandling([mixed $type = '' ]) : mixed
Parameters
- $type : mixed = ''
Return values
mixed —setServiceVisualCheckOfAge()
public
setServiceVisualCheckOfAge([mixed $type = '' ]) : mixed
Parameters
- $type : mixed = ''
Return values
mixed —setShipmentDate()
public
setShipmentDate(mixed $date) : mixed
Parameters
- $date : mixed
Return values
mixed —setShipperAddress()
public
setShipperAddress(mixed $streetName, mixed $streetNumber, mixed $addition, mixed $zip, mixed $city, mixed $iso2[, mixed $state = '' ][, mixed $country = '' ]) : mixed
Parameters
- $streetName : mixed
- $streetNumber : mixed
- $addition : mixed
- $zip : mixed
- $city : mixed
- $iso2 : mixed
- $state : mixed = ''
- $country : mixed = ''
Return values
mixed —setShipperCommunication()
public
setShipperCommunication([mixed $phone = '' ][, mixed $email = '' ][, mixed $contactPerson = '' ]) : mixed
Parameters
- $phone : mixed = ''
- $email : mixed = ''
- $contactPerson : mixed = ''
Return values
mixed —setShipperName()
public
setShipperName(mixed $name1[, mixed $name2 = '' ][, mixed $name3 = '' ]) : mixed
Parameters
- $name1 : mixed
- $name2 : mixed = ''
- $name3 : mixed = ''
Return values
mixed —setShipperReference()
Sets a ShipperReference.
public
setShipperReference(string $shipperReference) : void
Note that setting a ShipperReference will override (unset) Shipper data, i.e. ShipmentOrder.Shipment.Shipper.
Parameters
- $shipperReference : string
Return values
void —setWeight()
public
setWeight(mixed $weight) : mixed
Parameters
- $weight : mixed
Return values
mixed —toArray()
public
toArray() : mixed