omnibus/dhl API reference

Omnibus\Dhl

Api class

final class Api Api.php:11

DHL Express's MyDHL API (basic auth, API key and secret), and DHL's location finder (its own key).

const LIVE = 'https://express.api.dhl.com/mydhlapi'

const TEST = 'https://express.api.dhl.com/mydhlapi/test'

const LOCATIONS = 'https://api.dhl.com/location-finder/v1/find-by-address'

public readonly string $accountNumber

public readonly bool $sandbox

public readonly ?string $locationApiKey

Api::__construct()

public function __construct(readonly HttpClientInterface $http, readonly string $apiKey, readonly string $apiSecret, public readonly string $accountNumber, public readonly bool $sandbox = false, public readonly ?string $locationApiKey = null, readonly int $timeout = 20)

Api::call()

public function call(string $method, string $path, ?array $body = null, array $query = []): array

Api::locations()

public function locations(array $query): array

DhlGatewayFactory class

final class DhlGatewayFactory extends GatewayFactory DhlGatewayFactory.php:22

options: api_key: '%env(DHL_API_KEY)%' # a MyDHL API app (developer.dhl.com) api_secret: '%env(DHL_API_SECRET)%' account_number: '%env(DHL_ACCOUNT)%' # the export account sandbox: true location_api_key: null # optional, DHL's Location Finder (service points) rates: [...] # optional: configured prices instead of the rates API

Options

Mapping class

final class Mapping Mapping.php:10

MyDHL's shapes for ours.

Mapping::details()

public static function details(Address $a): array

Mapping::package()

public static function package(Parcel $p): array

Mapping::status()

public static function status(?string $code): TrackingStatus

Omnibus\Dhl\Action

PickupAction class

final class PickupAction implements ActionInterface, ApiAwareInterface PickupAction.php:15

DHL's Location Finder: service points near an address (its own API key).

PickupAction::__construct()

public function __construct()

PickupAction::supports()

public function supports(Request $request): bool

PickupAction::execute()

public function execute(Request $request): void

RatingAction class

final class RatingAction implements ActionInterface, ApiAwareInterface RatingAction.php:15

POST /rates: every product DHL Express offers for the shipment, priced with the account's rates.

RatingAction::__construct()

public function __construct()

RatingAction::supports()

public function supports(Request $request): bool

RatingAction::execute()

public function execute(Request $request): void

ShippingAction class

final class ShippingAction implements ActionInterface, ApiAwareInterface ShippingAction.php:16

POST /shipments: the shipment booked with the product chosen (service: a product code, "P" by default), its label as PDF.

ShippingAction::__construct()

public function __construct()

ShippingAction::supports()

public function supports(Request $request): bool

ShippingAction::execute()

public function execute(Request $request): void

TrackingAction class

final class TrackingAction implements ActionInterface, ApiAwareInterface TrackingAction.php:17

GET /shipments/{id}/tracking: the shipment's events, oldest first.

TrackingAction::__construct()

public function __construct()

TrackingAction::supports()

public function supports(Request $request): bool

TrackingAction::execute()

public function execute(Request $request): void