ShippingStatusService
- class Firstred\PostNL\Service\ShippingStatusService
- Class ShippingStatusService.
Summary
Methods
Constants
- VERSION = \'2\'
- LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2/status\'
- SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2/status\'
- DOMAIN_NAMESPACE = \'http://postnl\.nl/\'
Methods
- public Firstred\PostNL\Service\ShippingStatusService::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.- CurrentStatusByPhase:- Fill the Shipment->PhaseCode property, do not pass Barcode or Reference.Optionally add DateFrom and/or DateTo.- CurrentStatusByStatus:- Fill the Shipment->StatusCode 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
- Deprecated:
1.4.0 Use `currentStatus` instead
- public Firstred\PostNL\Service\ShippingStatusService::currentStatusesREST($currentStatuses)
- Get current statuses REST.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.2.0
- Deprecated:
1.4.0 Use `currentStatuses` instead
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0 Use `completeStatus` instead
- public Firstred\PostNL\Service\ShippingStatusService::completeStatusesREST($completeStatuses)
- Get complete statuses REST.
- Parameters:
- Returns:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.2.0
- Deprecated:
1.4.0 Use `completeStatuses` instead
- public Firstred\PostNL\Service\ShippingStatusService::getSignatureREST($getSignature)
- Gets the signature.
- Parameters:
$getSignature (
Firstred\PostNL\Entity\Request\GetSignature)
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature- 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
- Deprecated:
1.4.0 Use `getSignature` instead
- public Firstred\PostNL\Service\ShippingStatusService::getSignaturesREST($getSignatures)
- Get multiple signatures.
- Parameters:
$getSignatures (
Firstred\PostNL\Entity\Request\GetSignature[])
- Returns:
\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.2.0
- Deprecated:
1.4.0 Use `getSignatures` instead
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::buildCompleteStatusRequestREST($completeStatus)
- Build the CompleteStatus request for the REST API.This function auto-detects and adjusts the following requests:- CompleteStatus- CompleteStatusByReference- CompleteStatusByPhase- CompleteStatusByStatus
- Parameters:
$completeStatus (
Firstred\PostNL\Entity\Request\CompleteStatus)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::processCompleteStatusResponseREST($response)
- Process CompleteStatus Response REST.
- Parameters:
$response (mixed)
- Returns:
\Firstred\PostNL\Entity\Response\CompleteStatusResponse| null- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Throws:
- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::buildGetSignatureRequestREST($getSignature)
- Build the GetSignature request for the REST API.
- Parameters:
$getSignature (
Firstred\PostNL\Entity\Request\GetSignature)
- Returns:
\Psr\Http\Message\RequestInterface- Since:
1.0.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::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:
- 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.2.0
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0
- public Firstred\PostNL\Service\ShippingStatusService::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
- Deprecated:
1.4.0