Download the PHP package pfandie/dhl-php-sdk without Composer
On this page you can find all versions of the php package pfandie/dhl-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package dhl-php-sdk
DHL PHP SDK
This unofficial library is wrapping some functions of the DHL SOAP API in order to easy create/delete shipments and labels.
Installation
You can use Composer to install the package to your project:
The classes are then added to the autoloader automatically.
Motivation
I had a lot of pain studying and programming the DHL SOAP API - just to wrap some bits in a lot of XML. There is a lot, but not very helpful, documentation to the API. So I decided to create some functions in an easy to use and understand library.
There is also a lot of old stuff in the Documentation, so that you can not sure if it is right...
Requirements
- You need a DHL developer account and - as long as you want to use the API in production systems - a DHL Intraship Account.
- PHP-SOAP-Client installed + enabled on your Server
Compatibility
This Project is written for the DHL-SOAP-API Version 2 or higher.
It barely supports Version 1, feel free to complete the missing functions for Version 1. They are named usually {functionname}_v1. They are also marked with "todo" if they are not implemented
I can't find a Documentation for Version 1 anymore, so its hard to implement them properly...
Usage
-
You need to include the SDK by requiring the
\Petschko\DHL\BusinessShipment.php-File, it requires the rest for you. - You need to setup your DHL-Credentials:
TEST-Credentials:
LIVE-Credentials
You've set all of the Required Information so far. Now you can Perform several Actions.
Create a Shipment
Please note, that you need the \Petschko\DHL\Credentials Object with Valid Login-Information for that.
Classes used:
\Petschko\DHL\Credentials(Req) - Login Information\Petschko\DHL\ShipmentDetails(Req) - Details of the Shipment\Petschko\DHL\Sender(Req) - Sender Details\Petschko\DHL\SendPerson(Parent)\Petschko\DHL\Address(Parent)
\Petschko\DHL\ReturnReceiver(Optional) - Return Receiver Details\Petschko\DHL\SendPerson(Parent)\Petschko\DHL\Address(Parent)
\Petschko\DHL\Service(Optional) - Service Details (Many Configurations for the Shipment)\Petschko\DHL\IdentCheck(Very Optional) - Ident-Check Details, only needed if turned on in Service\Petschko\DHL\BankData(Optional) - Bank-Information\Petschko\DHL\BusinessShipment(Req) - Manages all Actions + Information\Petschko\DHL\Version(Parent)
\Petschko\DHL\Response(Req|Auto) - Response Information\Petschko\DHL\Version(Parent)
One of them:
\Petschko\DHL\Receiver(Req) - Receiver Details\Petschko\DHL\SendPerson(Parent)\Petschko\DHL\Address(Parent)
\Petschko\DHL\Filial(Optional) - Receiver-Details (Post-Filial)\Petschko\DHL\Receiver(Req|Parent) - Receiver Details\Petschko\DHL\SendPerson(Parent)\Petschko\DHL\Address(Parent)
\Petschko\DHL\PackStation(Optional) - Receiver-Details (Pack-Station)\Petschko\DHL\Receiver(Req|Parent) - Receiver Details\Petschko\DHL\SendPerson(Parent)\Petschko\DHL\Address(Parent)
How to create
\Petschko\DHL\ShipmentDetails Object
You need to setup the Shipment-Details for your Shipment (like Size/Weight etc). You can do that with the \Petschko\DHL\ShipmentDetails Object.
You can setup details for that, if you need. If you don't set them, it use the default values (This Part is Optional)
\Petschko\DHL\Sender, \Petschko\DHL\Receiver + \Petschko\DHL\ReturnReceiver Object(s)
Now you have to create a Sender and a Receiver. They are similar to set, just the XML creation is different so you have to use different Objects for that.
If you want to lookup all values, you can search trough the \Petschko\DHL\SendPerson + \Petschko\DHL\Address Classes.
Lets start with the Sender, in the most cases you =). Create a \Petschko\DHL\Sender Object:
Setup all Required Information
You can also add more Information, but they are Optional:
This was the sender Object, you can set all the same Information with the \Petschko\DHL\Receiver + \Petschko\DHL\ReturnReceiver Class.
Note: You can also use \Petschko\DHL\PackStation or \Petschko\DHL\Filial instead of \Petschko\DHL\Receiver.
Please note, that they need some extra information.
You don't need to create the \Petschko\DHL\ReturnReceiver Object if you don't want a return Label.
\Petschko\DHL\Service Object
You can also setup more details for your Shipment by using the \Petschko\DHL\Service Object. It's an optional Object but may you should look, what you can set to this Object.
I'll not explain the Service-Object because there are too many settings. Please look into the Service-PHP-File by yourself. The fields are well documented.
\Petschko\DHL\BankData Object
You can also use the \Petschko\DHL\BankData Object. Bank data can be provided for different purposes. E.g. if COD is booked as service, bank data must be provided by DHL customer (mandatory server logic). The collected money will be transferred to specified bank account.
You can look to the PHP-File of the \Petschko\DHL\BankData-Object, and checkout what you can set there. I will not explain it here.
\Petschko\DHL\BusinessShipment Object
Finally you can add all together. You have to create the \Petschko\DHL\BusinessShipment Object
If you want to use a specific WSDL-File (or remote), you can set it: (Else you don't need this part)
Here you can add the previous created classes:
``
Now you can set how the Label should get returned and some other stuff:
Create the Request
All set? Fine, now you can finally made the Create-Shipment-Order-Request. Save the Response to a var ``
Handling the response
First you have to check if the Value is not false
You can get several Information from the \Petschko\DHL\Response Object. Please have a look down where I describe the \Petschko\DHL\Response Class.
Delete a Shipment
Please note, that you need the \Petschko\DHL\Credentials Object with Valid Login-Information for that.
You also need the Shipment-Number, from the Shipment, that you want to cancel/delete.
Classes used
\Petschko\DHL\Credentials(Req) - Login Information\Petschko\DHL\BusinessShipment(Req) - Manages all Actions + Information\Petschko\DHL\Version(Parent)
\Petschko\DHL\Response(Req|Auto) - Response Information\Petschko\DHL\Version(Parent)
How to create
Deleting a Shipment is not very hard it just work like this:
Same like when creating a Shipment-Order, the Response is false if the Request failed.
For more Information about the Response, look down where I describe the \Petschko\DHL\Response Class.
Re-Get a Label
Please note, that you need the \Petschko\DHL\Credentials Object with Valid Login-Information for that.
You also need the Shipment-Number, from the Shipment, where you want to Re-Get a Label.
Classes used
\Petschko\DHL\Credentials(Req) - Login Information\Petschko\DHL\BusinessShipment(Req) - Manages all Actions + Information\Petschko\DHL\Version(Parent)
\Petschko\DHL\Response(Req|Auto) - Response Information\Petschko\DHL\Version(Parent)
How to create
Same like deleting, re-get a Label is not this hard. You can simply re-get a label:
If the request failed, you get false as usual else a \Petschko\DHL\Response Object.
DoManifest
Please note, that you need the \Petschko\DHL\Credentials Object with Valid Login-Information for that.
You also need the Shipment-Number for the Manifest (If you need it, you will know how to use this).
I personally don't know for what is this for, but it works!
Classes used
\Petschko\DHL\Credentials(Req) - Login Information\Petschko\DHL\BusinessShipment(Req) - Manages all Actions + Information\Petschko\DHL\Version(Parent)
\Petschko\DHL\Response(Req|Auto) - Response Information\Petschko\DHL\Version(Parent)
How to create
It works like deleting a Shipment:
If the request failed, you get false else a \Petschko\DHL\Response Object.
\Petschko\DHL\Response Object
If you get a Response that is not false, you have to mess with the \Petschko\DHL\Response Object.
This Object helps you, to get easier to your Goal. You can easily get the Values you need by using the getters. (IDEs will detect them automatic)
I will explain which values you can get from the Response-Object
If a value is not set you get usually null as result. Not every Action fills out all of these values!
You can also take a look at the Class Constance's, they are helping you to identify the Status-Codes:
That's all so far
Contact
- You can E-Mail me if you have Questions or whatever (No Bug-Reporting please!): [email protected]
- You can Report Bugs here in the "Issue"-Section of the Project.
- Of course you can also ask any stuff there, feel free for that!
- If you want to use German, you can do it. Please keep in mind that not everybody can speak German, so it's better to use english =)
Version 1 Code
You can find my old Version here: Download old Code
You can also look at the Tobias Redmann's Code, I initially forked that repo. There are not a lot of his code left in my current Version, but you can find his Code better than mine... (His Version supports just DHL-SOAP-Version 1)
He also Build several Plugins for Wordpress + Woocommerce in the past. Check his GitHub-Page or his Homepage
