{"id":25839666,"url":"https://github.com/netresearch/dhl-sdk-api-parcel-de-returns","last_synced_at":"2025-07-20T12:36:25.118Z","repository":{"id":210018248,"uuid":"725500608","full_name":"netresearch/dhl-sdk-api-parcel-de-returns","owner":"netresearch","description":"DHL Parcel DE Returns API SDK","archived":false,"fork":false,"pushed_at":"2025-02-25T15:47:36.000Z","size":45,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-07-02T08:44:18.455Z","etag":null,"topics":["gitlab-mirror"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netresearch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-30T09:22:17.000Z","updated_at":"2025-02-25T15:47:40.000Z","dependencies_parsed_at":"2025-02-25T16:28:25.065Z","dependency_job_id":"55c82dcd-1efa-45d1-a1a9-6f6166145978","html_url":"https://github.com/netresearch/dhl-sdk-api-parcel-de-returns","commit_stats":null,"previous_names":["netresearch/dhl-sdk-api-parcel-de-returns"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/netresearch/dhl-sdk-api-parcel-de-returns","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-parcel-de-returns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-parcel-de-returns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-parcel-de-returns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-parcel-de-returns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/dhl-sdk-api-parcel-de-returns/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-parcel-de-returns/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266127267,"owners_count":23880425,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gitlab-mirror"],"created_at":"2025-03-01T04:33:58.643Z","updated_at":"2025-07-20T12:36:25.097Z","avatar_url":"https://github.com/netresearch.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DHL Parcel DE Returns API SDK\n\nThe DHL Parcel DE Returns API SDK package offers an interface to the following web services:\n\n- [Returns API](https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany)\n\n## Requirements\n\n### System Requirements\n\n- PHP 8.1+ with JSON extension\n\n### Package Requirements\n\n- `netresearch/jsonmapper`: Mapper for deserialization of JSON response messages into PHP objects\n- `php-http/discovery`: Discovery service for HTTP client and message factory implementations\n- `php-http/httplug`: Pluggable HTTP client abstraction\n- `php-http/logger-plugin`: HTTP client logger plugin for HTTPlug\n- `psr/http-client`: PSR-18 HTTP client interfaces\n- `psr/http-factory`: PSR-7 HTTP message factory interfaces\n- `psr/http-message`: PSR-7 HTTP message interfaces\n- `psr/log`: PSR-3 logger interfaces\n\n### Virtual Package Requirements\n\n- `psr/http-client-implementation`: Any package that provides a PSR-18 compatible HTTP client\n- `psr/http-factory-implementation`: Any package that provides PSR-7 compatible HTTP message factories\n- `psr/http-message-implementation`: Any package that provides PSR-7 HTTP messages\n\n### Development Package Requirements\n\n- `nyholm/psr7`: PSR-7 HTTP message factory \u0026 message implementation\n- `phpunit/phpunit`: Testing framework\n- `php-http/mock-client`: HTTPlug mock client implementation\n- `phpstan/phpstan`: Static analysis tool\n- `fig/log-test`: PSR-3 logger implementation for testing purposes\n- `squizlabs/php_codesniffer`: Static analysis tool\n- `rector/rector`: Automatic refactoring tool to help with PHP upgrades\n\n## Installation\n\n```bash\ncomposer require dhl/sdk-api-parcel-de-returns\n```\n\n## Uninstallation\n\n```bash\ncomposer remove dhl/sdk-api-parcel-de-returns\n```\n\n## Testing\n\n```bash\n./vendor/bin/phpunit -c test/phpunit.xml\n```\n\n## Features\n\nThe DHL Parcel DE Returns API SDK supports the following features:\n\n* Book return labels ([`POST /orders`](https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany#operations-Orders-createReturnOrder))\n\n### Authentication\n\nThe DHL Parcel DE Returns API requires a two-level authentication\n(see [API User Guide](https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany#get-started-section/user-guide)):\n\n1. The **application** submits a _Consumer Key Header_ (\"API Key\") that must be\n   created in the [DHL API Developer Portal](https://developer.dhl.com/user/apps).\n2. The **user** is identified via _HTTP Basic Authentication_ with credentials\n   configured in the [DHL Business Customer Portal](https://geschaeftskunden.dhl.de/).\n\nThese credentials are passed to the SDK via `\\Dhl\\Sdk\\ParcelDe\\Returns\\Api\\Data\\AuthenticationStorageInterface`.\nUse the default implementation or create your own.\n\n### Book Return Label\n\nCreate a return label PDF, or a QR code to be scanned by a place of committal\n(e.g. post office). For return shipments from outside the EU, a customs document\ncan also be requested.\n\nThe destination address of the return shipment is determined via _Receiver ID_\nparameter. Return recipients and their ID (\"Return recipient's name\") are\nconfigured in the [DHL Business Customer Portal](https://geschaeftskunden.dhl.de/),\n_Returns Settings_ section. More detailed information can be found in the\n[API FAQ](https://developer.dhl.com/api-reference/dhl-parcel-de-returns-post-parcel-germany#additional-information-section/faq--returns-recipients).\n\n#### Public API\n\nThe library's components suitable for consumption comprise\n\n* service:\n    * service factory\n    * return label service\n    * data transfer object builder\n* data transfer objects:\n    * authentication storage\n    * booking confirmation with label data\n\n#### Usage\n\n```php\n$authStorage = new \\Dhl\\Sdk\\ParcelDe\\Returns\\Auth\\AuthenticationStorage(\n    'apiKey',\n    'user',\n    'password'\n);\n$logger = new \\Psr\\Log\\NullLogger();\n\n$serviceFactory = new \\Dhl\\Sdk\\ParcelDe\\Returns\\Service\\ServiceFactory();\n$service = $serviceFactory-\u003ecreateReturnLabelService($authStorage, $logger, $sandbox = true);\n\n$requestBuilder = new \\Dhl\\Sdk\\ParcelDe\\Returns\\Model\\ReturnLabelRequestBuilder();\n$requestBuilder-\u003esetReceiverId($returnRecipient = 'deu');\n$requestBuilder-\u003esetShipper(\n    $name = 'Jane Doe',\n    $countryCode = 'DEU',\n    $postalCode = '53113',\n    $city = 'Bonn',\n    $streetName = 'Sträßchensweg',\n    $streetNumber = '2'\n);\n\n$returnOrder = $requestBuilder-\u003ecreate();\n$confirmation = $service-\u003ecreateReturnOrder($returnOrder);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-parcel-de-returns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-parcel-de-returns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-parcel-de-returns/lists"}