ShippingStatusServiceInterface
- interface Firstred\PostNL\Service\ShippingStatusServiceInterface
Summary
Methods
Methods
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatus(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $currentStatus)
- Gets the current status.This is a combi-function, supporting the following:- CurrentStatus (by barcode):- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:- Fill the Shipment->Reference property. Leave the rest empty.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatuses($currentStatuses)
- Get current statuses REST.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatus(\\Firstred\\PostNL\\Entity\\Request\\CompleteStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CompleteStatus $completeStatus)
- Gets the complete status.This is a combi-function, supporting the following:- CurrentStatus (by barcode):- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:- Fill the Shipment->Reference property. Leave the rest empty.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatuses($completeStatuses)
- Get complete statuses REST.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignature($getSignature)
- Gets the complete status.This is a combi-function, supporting the following:- CurrentStatus (by barcode):- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:- Fill the Shipment->Reference property. Leave the rest empty.
- Parameters:
$getSignature (
Firstred\PostNL\Entity\Request\GetSignature)
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignatures($getSignatures)
- Get multiple signatures.
- Parameters:
$getSignatures (
Firstred\PostNL\Entity\Request\GetSignature[])
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Since:
1.2.0
- public Firstred\PostNL\Service\ShippingStatusServiceInterface::getUpdatedShipments($customer, $dateTimeFrom=null, $dateTimeTo=null)
- Get updated shipments for customer REST.
- Parameters:
$customer (
Firstred\PostNL\Entity\Customer)$dateTimeFrom (
DateTimeInterface| null)$dateTimeTo (
DateTimeInterface| null)
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
\Psr\Cache\InvalidArgumentException- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.2.0