README

This documentations describes what the GeoAPI is and how to use it properly.

What is GeoAPI

The GeoAPI allows DPD customers to manage (CRUD) their shipments and shipment related data.

The main purpose of the API is to provide the customer the means for:

Creating and managing new shipments
Ordering pickups for parcels
Printing parcel labels
Listing all available shipping services
Validating shipping routes

It also provides methods for listing your pickup addresses and the details of individual parcels.

Each user is assigned a user account under which he is able to track multiple customer DSWs (customer numbers).
You as a customer can use a single GeoAPI account to send shipments under multiple DPD customer numbers.

For more information, please visit https://www.dpd.com/cz/cs/.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/wpify/dpd-geo-php-sdk.git"
    }
  ],
  "require": {
    "wpify/dpd-geo-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');



// Configure API key authorization: ApiKeyAuth
$config = DpdGeoSdk\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = DpdGeoSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');


$apiInstance = new DpdGeoSdk\Api\DefaultApi(
    // 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(),
    $config
);

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

API Endpoints

All URIs are relative to https://geoapi.dpd.cz/v1

Class	Method	HTTP request	Description
DefaultApi	countriesGet	GET /countries	List all available countries for your account
DefaultApi	customersCustomerDSWAddressesGet	GET /customers/{customerDSW}/addresses	List all addresses associated with the specified customer
DefaultApi	customersGet	GET /customers	List all customers associated with the active user account
DefaultApi	meGet	GET /me	Get the active customers of the user account and their list of addresses.
DefaultApi	parcelsGet	GET /parcels	List all parcels for the current active user account
DefaultApi	parcelsLabelsPost	POST /parcels/labels	Print the labels for multiple parcels
DefaultApi	parcelsParcelIdentLabelsPost	POST /parcels/{parcelIdent}/labels	Print the parcel labels
DefaultApi	parcelsParcelNoTrackingGet	GET /parcels/{parcelNo}/tracking	Get parcel tracking info
DefaultApi	parcelsTrackingPost	POST /parcels/tracking	Get the tracking info for multiple parcels
DefaultApi	pickupOrdersPickupOrderIdDelete	DELETE /pickup-orders/{pickupOrderId}	Cancel pickup order by pickupOrderId
DefaultApi	pickupOrdersPickupOrderIdGet	GET /pickup-orders/{pickupOrderId}	Show information about a specific pickup order.
DefaultApi	pickupOrdersPost	POST /pickup-orders	Create a new pickup order.
DefaultApi	shipmentsPost	POST /shipments	Create new shipments
DefaultApi	shippingServicesGet	GET /shipping-services	List of all available shipping services in JSON.

Models

Authorization

ApiKeyAuth

Type: API key
API key parameter name: x-api-key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

info@dpd.cz

About this package

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

API version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

wpify / dpd-geo-php-sdk

Maintainers

Details