logo P4D

The P4D API: ServiceInfo

 
Get detailed information for either one or all of the services we offer.

Input Fields

Field Name Required? Description Example
ShipAction YES This tells our system which function you require ServiceInfo
Username YES You must specify your username joebloggs
APIKey YES This is available from your Shipping Manager account page HJ1E6DOTRDXAOLB
ServiceID   If you would like to get details for only one service option then specify the ServiceID here. DHL24_UKUK

Output Fields
 

Field Name Description Example
ShipAction Confirmation of the function used ServiceInfo
Status Either Success or Error Success
RequestDate The date your request was received (yyyy-mm-dd hh:mm:ss) 2008-01-10 12:15:31
Username The username used to make the request joebloggs
ServiceInfo An array containing all of the service options -
ServiceID The ServiceID for the delivery option
Carrier The carrier this delivery option uses
DeliveryName A description of the delivery option
ServiceLength Description of the time this option takes to arrive after collection
ServiceHours The above but in hours
DeliveryTimes The time of the day that deliveries are made
Paperwork Whether you, as the sender, need to prepare any paperwork for the courier driver
CollectionTimes Description of the collection times available for this delivery option
Insurance Description of the insurance available for this delivery option
InsuranceIncluded Total insurance included in GBP
Notes Any additional notes for this service
PrinterRequired Whether a printer is required to print any paperwork for the courier driver

Example Input

Array
(
    [ShipAction] => ServiceInfo
    [Username] => joebloggs
    [APIKey] => HJ1E6DOTRDXAOLB
    [ServiceID] => DHL24_UKUK
)

Example Output
 
Array
(
    [ShipAction] => ServiceInfo
    [Status] => Success
    [RequestDate] => 2008-07-06 02:13:22
    [Username] => joebloggs
    [ServiceInfo] => Array
        (
            [0] => Array
                (
                    [ServiceID] => DHL24_UKUK
                    [Carrier] => DHL Home
                    [DeliveryName] => Home 24 (UK to UK)
                    [ServiceLength] => Guaranteed next working day delivery ...
                    [ServiceHours] => 24
                    [DeliveryTimes] => Deliveries take place between 7am and 9pm
                    [Paperwork] => The collection van driver will bring the ...
                    [CollectionTimes] => Sameday collection Deadline 12.00pm.  
                    [Insurance] => 50 GBP worth of insurance included free
                    [InsuranceIncluded] => 50
                    [Notes] => Free redelivery can be arranged direct..
                    [PrinterRequired] => No
                )

        )

)