README

Introduction

Overview

Note: This is the specification of the DP-DHL Group Parcel DE Returns API. This web service allows business customers to create return labels on demand.

Scenarios

Main Scenario: Creating a returnlabel

This is achieved by posting a return order to the URI '/rest/orders'. The service will respond with a return label.

Querying to get receiver locations

The single scenario supported by this service is the determination of the receiver's location. This is achieved by getting a location to the URI '/rest/locations'. The service will respond with a Receiver.

Technical Note on Authorization

This API supports two alternative ways to authorize yourself:

1. Combination of Apikey and Basic Authentication which you can provide with every call.
2. OAuth2 Password Flow: After having obtained your access token once, you provide this token as bearer token.

You can try it out here. More details can be found when clicking on "Authorize".

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/nogrod/dhl-retoure-php-sdk.git"
    }
  ],
  "require": {
    "nogrod/dhl-retoure-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Dhl\Rest\Retoure\Api\GeneralApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->rootGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GeneralApi->rootGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api-sandbox.dhl.com/parcel/de/shipping/returns/v1

Models

• Commodity
• ContactAddress
• Country
• CountryOfOrigin
• CustomsDetails
• Document
• JSONStatus
• LabelType
• Receiver
• ReturnOrder
• ReturnOrderConfirmation
• RootGet200Response
• RootGet200ResponseAmp
• VAS
• Value
• Weight

Authorization

BasicAuth

• Type: HTTP basic authentication

ApiKey

• Type: API key
• API key parameter name: dhl-api-key
• Location: HTTP header

OAuth2

• Type: OAuth
• Flow: password
• Authorization URL: ``
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.9
  • Generator version: 7.21.0
• Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen