omnibus/dtdc Référence de l’API

Omnibus\Dtdc

Api class

final class Api Api.php:15

DTDC's customer integration APIs (an api-key per customer for consignments and cancellation; a separate access token for tracking, fetched with the tracking username and password).

const LIVE = 'https://dtdcapi.shipsy.io/api/customer/integration'

const TEST = 'https://demodashboardapi.shipsy.in/api/customer/integration'

const TRACKING = 'https://blktracksvc.dtdc.com/dtdc-api/rest/JSONCnTrk/getTrackDetails'

const TRACKING_TOKEN = 'https://blktracksvc.dtdc.com/dtdc-api/api/dtdc/authenticate'

public readonly string $customerCode

public readonly ?string $trackingUsername

public readonly ?string $trackingPassword

public readonly bool $sandbox

Api::__construct()

public function __construct(readonly HttpClientInterface $http, readonly string $apiKey, public readonly string $customerCode, public readonly ?string $trackingUsername = null, public readonly ?string $trackingPassword = null, public readonly bool $sandbox = false, readonly int $timeout = 20)

Api::call()

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

Api::track()

public function track(string $number): array

DtdcGatewayFactory class

final class DtdcGatewayFactory extends GatewayFactory DtdcGatewayFactory.php:24

options: api_key: '%env(DTDC_API_KEY)%' # the customer integration key customer_code: '%env(DTDC_CUSTOMER)%' tracking_username: null # the tracking API's login tracking_password: null sandbox: true rates: [...] # prices from configuration: DTDC quotes by contract

No pickup points: DTDC delivers to the door. Unverified until an account's keys are at hand.

Options

Omnibus\Dtdc\Action

CancelAction class

final class CancelAction implements ActionInterface, ApiAwareInterface CancelAction.php:13

POST /consignment/cancel.

CancelAction::__construct()

public function __construct()

CancelAction::supports()

public function supports(Request $request): bool

CancelAction::execute()

public function execute(Request $request): void

GetSlipAction class

final class GetSlipAction implements ActionInterface, ApiAwareInterface GetSlipAction.php:18

GET /consignment/label by reference number: the label of a consignment booked earlier, as ship() fetches it (label code SHIP_LABEL_4X6, PDF: DTDC prints no other format).

GetSlipAction::__construct()

public function __construct()

GetSlipAction::supports()

public function supports(Request $request): bool

GetSlipAction::execute()

public function execute(Request $request): void

GetSlipAction::fetch()

public static function fetch(Api $api, string $number, string $labelCode): ?string

The consignment's label, base64-decoded, or null when DTDC sends none.

ShippingAction class

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

POST /consignment/softdata: the consignment (service: B2C Priority by default, PTP for Priority, GROUND...), then its label from /consignment/label.

ShippingAction::__construct()

public function __construct()

ShippingAction::supports()

public function supports(Request $request): bool

ShippingAction::execute()

public function execute(Request $request): void

ShippingAction::trackingUrl()

public static function trackingUrl(string $number): string

TrackingAction class

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

The tracking API's getTrackDetails: the consignment's actions, oldest first.

TrackingAction::__construct()

public function __construct()

TrackingAction::supports()

public function supports(Request $request): bool

TrackingAction::execute()

public function execute(Request $request): void