ShippingStatusServiceInterface¶
-
interface
Firstred\PostNL\Service\ShippingStatusServiceInterface¶ - Class ShippingStatusService.
Summary¶
Methods¶
Methods¶
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatusREST($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::currentStatusesREST($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::completeStatusREST($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::completeStatusesREST($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::getSignatureREST($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::getSignaturesREST($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::buildCurrentStatusRequestREST($currentStatus)¶ - Build the CurrentStatus request for the REST API.This function auto-detects and adjusts the following requests:- CurrentStatus- CurrentStatusByReference
- Parameters
- Returns
\Psr\Http\Message\RequestInterface- Since
1.0.0
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::processCurrentStatusResponseREST($response)¶ - Process CurrentStatus Response REST.
- Parameters
$response (mixed)
- Returns
- 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::buildCompleteStatusRequestREST($completeStatus)¶ - Build the CompleteStatus request for the REST API.This function auto-detects and adjusts the following requests:- CompleteStatus- CompleteStatusByReference
- Parameters
$completeStatus (
Firstred\PostNL\Entity\Request\CompleteStatus)
- Returns
\Psr\Http\Message\RequestInterface- Since
1.0.0
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::processCompleteStatusResponseREST($response)¶ - Process CompleteStatus Response REST.
- Parameters
$response (mixed)
- Returns
\Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse| null- 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::buildGetSignatureRequestREST($getSignature)¶ - Build the GetSignature request for the REST API.
- Parameters
$getSignature (
Firstred\PostNL\Entity\Request\GetSignature)
- Returns
\Psr\Http\Message\RequestInterface
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::processGetSignatureResponseREST($response)¶ - Process GetSignature Response REST.
- Parameters
$response (mixed)
- Returns
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature| null- 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::getUpdatedShipmentsREST($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
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::buildGetUpdatedShipmentsRequestREST($customer, $dateTimeFrom=null, $dateTimeTo=null)¶ - Build get updated shipments request REST.
- Parameters
$customer (
Firstred\PostNL\Entity\Customer)$dateTimeFrom (
DateTimeInterface| null)$dateTimeTo (
DateTimeInterface| null)
- Returns
\Psr\Http\Message\RequestInterface- Since
1.2.0
-
public
Firstred\PostNL\Service\ShippingStatusServiceInterface::processGetUpdatedShipmentsResponseREST($response)¶ - Process updated shipments response REST.
- Parameters
$response (
Psr\Http\Message\ResponseInterface)
- Returns
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Throws
- Since
1.2.0