Download the PHP package dhl/sdk-api-parcel-de-returns without Composer
On this page you can find all versions of the php package dhl/sdk-api-parcel-de-returns. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download dhl/sdk-api-parcel-de-returns
More information about dhl/sdk-api-parcel-de-returns
Files in dhl/sdk-api-parcel-de-returns
Package sdk-api-parcel-de-returns
Short Description DHL Parcel DE Returns API SDK
License MIT
Homepage https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany
Informations about the package sdk-api-parcel-de-returns
DHL Parcel DE Returns API SDK
The DHL Parcel DE Returns API SDK package offers an interface to the following web services:
Requirements
System Requirements
- PHP 8.1+ with JSON extension
Package Requirements
netresearch/jsonmapper
: Mapper for deserialization of JSON response messages into PHP objectsphp-http/discovery
: Discovery service for HTTP client and message factory implementationsphp-http/httplug
: Pluggable HTTP client abstractionphp-http/logger-plugin
: HTTP client logger plugin for HTTPlugpsr/http-client
: PSR-18 HTTP client interfacespsr/http-factory
: PSR-7 HTTP message factory interfacespsr/http-message
: PSR-7 HTTP message interfacespsr/log
: PSR-3 logger interfaces
Virtual Package Requirements
psr/http-client-implementation
: Any package that provides a PSR-18 compatible HTTP clientpsr/http-factory-implementation
: Any package that provides PSR-7 compatible HTTP message factoriespsr/http-message-implementation
: Any package that provides PSR-7 HTTP messages
Development Package Requirements
nyholm/psr7
: PSR-7 HTTP message factory & message implementationphpunit/phpunit
: Testing frameworkphp-http/mock-client
: HTTPlug mock client implementationphpstan/phpstan
: Static analysis toolfig/log-test
: PSR-3 logger implementation for testing purposessquizlabs/php_codesniffer
: Static analysis toolrector/rector
: Automatic refactoring tool to help with PHP upgrades
Installation
Uninstallation
Testing
Features
The DHL Parcel DE Returns API SDK supports the following features:
- Book return labels (
POST /orders
)
Authentication
The DHL Parcel DE Returns API requires a two-level authentication (see API User Guide):
- The application submits a Consumer Key Header ("API Key") that must be created in the DHL API Developer Portal.
- The user is identified via HTTP Basic Authentication with credentials configured in the DHL Business Customer Portal.
These credentials are passed to the SDK via \Dhl\Sdk\ParcelDe\Returns\Api\Data\AuthenticationStorageInterface
.
Use the default implementation or create your own.
Book Return Label
Create a return label PDF, or a QR code to be scanned by a place of committal (e.g. post office). For return shipments from outside the EU, a customs document can also be requested.
The destination address of the return shipment is determined via Receiver ID parameter. Return recipients and their ID ("Return recipient's name") are configured in the DHL Business Customer Portal, Returns Settings section. More detailed information can be found in the API FAQ.
Public API
The library's components suitable for consumption comprise
- service:
- service factory
- return label service
- data transfer object builder
- data transfer objects:
- authentication storage
- booking confirmation with label data
Usage
All versions of sdk-api-parcel-de-returns with dependencies
ext-json Version *
netresearch/jsonmapper Version ^4.0.0
php-http/discovery Version ^1.17.0
php-http/httplug Version ^2.2.0
php-http/logger-plugin Version ^1.2.1
psr/http-client Version ^1.0.1
psr/http-client-implementation Version ^1.0.0
psr/http-factory Version ^1.0.0
psr/http-factory-implementation Version ^1.0.0
psr/http-message Version ^1.0.0 || ^2.0.0
psr/http-message-implementation Version ^1.0.0 || ^2.0.0
psr/log Version ^1.0.0 || ^2.0.0 || ^3.0.0