{"id":25839796,"url":"https://github.com/netresearch/dhl-sdk-api-bcs-returns","last_synced_at":"2025-07-03T03:05:40.443Z","repository":{"id":36496371,"uuid":"227625360","full_name":"netresearch/dhl-sdk-api-bcs-returns","owner":"netresearch","description":"Library package encapsulating API communication to the DHL Paket Retoure  web service.","archived":false,"fork":false,"pushed_at":"2025-02-19T12:51:28.000Z","size":72,"stargazers_count":2,"open_issues_count":2,"forks_count":7,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-06-05T21:50:52.614Z","etag":null,"topics":["api-client","dhl-api","dhl-paket-retoure","dhl-sdk","php","php-library","sdk"],"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":"2019-12-12T14:27:37.000Z","updated_at":"2025-02-19T10:06:19.000Z","dependencies_parsed_at":"2025-02-19T11:33:21.194Z","dependency_job_id":null,"html_url":"https://github.com/netresearch/dhl-sdk-api-bcs-returns","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/netresearch/dhl-sdk-api-bcs-returns","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-bcs-returns","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-bcs-returns/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-bcs-returns/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-bcs-returns/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/dhl-sdk-api-bcs-returns/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Fdhl-sdk-api-bcs-returns/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263250602,"owners_count":23437288,"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":["api-client","dhl-api","dhl-paket-retoure","dhl-sdk","php","php-library","sdk"],"created_at":"2025-03-01T04:34:26.748Z","updated_at":"2025-07-03T03:05:40.387Z","avatar_url":"https://github.com/netresearch.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DHL Paket Retoure API SDK\n\nThe DHL Paket Retoure API SDK package offers an interface to the following web services:\n\n- API Retoure\n\n## Requirements\n\n### System Requirements\n\n- PHP 7.2+ with JSON extension\n\n### Package Requirements\n\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- `squizlabs/php_codesniffer`: Static analysis tool\n\n## Installation\n\n```bash\n$ composer require dhl/sdk-api-bcs-returns\n```\n\n## Uninstallation\n\n```bash\n$ composer remove dhl/sdk-api-bcs-returns\n```\n\n## Testing\n\n```bash\n$ ./vendor/bin/phpunit -c test/phpunit.xml\n```\n\n## Features\n\nThe DHL Paket Retoure API SDK supports the following features:\n\n* Book return labels ([`BookLabel`](https://entwickler.dhl.de/group/ep/wsapis/retouren))\n\n### Return Label Service\n\nCreate a return label PDF or QR code to be scanned by a place of committal (e.g. post office).\nFor return shipments from outside of the EU, a customs document can also be requested.\n\n#### Public API\n\nThe library's components suitable for consumption comprise of\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\\Paket\\Retoure\\Auth\\AuthenticationStorage(\n    'applicationId',\n    'applicationToken',\n    'user',\n    'signature'\n);\n$logger = new \\Psr\\Log\\NullLogger();\n\n$serviceFactory = new \\Dhl\\Sdk\\Paket\\Retoure\\Service\\ServiceFactory();\n$service = $serviceFactory-\u003ecreateReturnLabelService($authStorage, $logger, $sandbox = true);\n\n$requestBuilder = new \\Dhl\\Sdk\\Paket\\Retoure\\Model\\ReturnLabelRequestBuilder();\n$requestBuilder-\u003esetAccountDetails($receiverId = 'deu');\n$requestBuilder-\u003esetShipperAddress(\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-\u003ebookLabel($returnOrder);\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-bcs-returns","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-bcs-returns","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Fdhl-sdk-api-bcs-returns/lists"}