logo P4D

The P4D API: QuoteInformation

 
Obtain information back from our system with the details of any quote you have generated but yet to book.

Input Fields

Field Name Required? Description Example
ShipAction YES This tells our system which function you require QuoteInformation
Username YES You must specify your username joebloggs
APIKey YES This is available from your Shipping Manager account page HJ1E6DOTRDXAOLB
QuoteID YES The QuoteID obtained from GetQuote QUOTESSWIRHSIX6EXH
ServiceID YES The ItemID obtained from GetQuote 950

Output Fields
 

Field Name Description Example
ShipAction Confirmation of the function used QuoteInformation
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
QuoteID The QuoteID specified QUOTESSWIRHSIX6EXH
QuoteExpires The date that this quote expires (14 days after GetQuote requested) 2008-01-11 08:00:00
Username The username used to make the request joebloggs
Collection An array containing the collection details -
CollectionName The name of the person sending the parcel
CollectionCompany Company name of the parcel sender
CollectionAddress1 Address parcel should be collected from
CollectionAddress2 Address parcel should be collected from
CollectionAddress3 Address parcel should be collected from
CollectionTown Town parcel should be collected from
CollectionCounty County parcel should be collected from
CollectionPostcode Postcode parcel should be collected from
CollectionCountry Country parcel should be collected from
CollectionTelephone Telephone number of collection contact person
Delivery An array containing the delivery details -
DeliveryName Name of the person parcel should be sent to
DeliveryCompany Company that the parcel should be sent to
DeliveryAddress1 Address that the parcel should be sent to
DeliveryAddress2 Address that the parcel should be sent to
DeliveryAddress3 Address that the parcel should be sent to
DeliveryTown Town that the parcel should be sent to
DeliveryCounty County that the parcel should be sent to
DeliveryPostcode Postcode that the parcel should be sent to
DeliveryCountry Country code that the parcel should be sent to
DeliveryTelephone Telephone number of the delivery contact person
Parcel An array containg information about the parcel -
ParcelContents Brief summary of parcel contents Clothes
EstimatedValue Estimated value of the parcel contents £25
ServiceName The delivery option for this parcel Home 48 (UK to UK)
ServiceID The ServiceID for the selected parcel delivery option DHL48_UKUK
Carrier The carrier that this parcel will be sent using DHL Home
Weight Weight of the parcels in KG 5
Length Width of the parcel in CM 10
Width Height of the parcel in CM 20
Height Length of the parcel in CM 30

Example Input

Array
(
    [ShipAction] => QuoteInformation
    [QuoteID] => QUOTESSWIRHSIX6EXH
    [ItemID] => 632
    [Username] => joebloggs
    [APIKey] => HJ1E6DOTRDXAOL4LWAA
)

Example Output
 
Array
(
    [ShipAction] => QuoteInformation
    [Status] => Success
    [RequestDate] => 2008-07-06 02:24:16
    [Username] => joebloggs
    [QuoteID] => QUOTESSWIRHSIX6EXH
    [QuoteExpires] => 2008-07-20 02:24:16
    [Collection] => Array
        (
            [CollectionName] => Collection Name
            [CollectionCompany] => Collection Address
            [CollectionAddress1] => 
            [CollectionAddress2] => 
            [CollectionAddress3] => 
            [CollectionTown] => Collection Time
            [CollectionPostcode] => C1 2AA
            [CollectionCounty] => Collection County
            [CollectionCountry] => uk
            [CollectionTelephone] => 01234 567899
        )

    [Delivery] => Array
        (
            [DeliveryName] => Delivery Name
            [DeliveryCompany] => 
            [DeliveryAddress1] => Delivery Address
            [DeliveryAddress2] => 
            [DeliveryAddress3] => 
            [DeliveryTown] => Delivery County
            [DeliveryPostcode] => D1 2BB
            [DeliveryCounty] => Delivery County
            [DeliveryCountry] => uk
            [DeliveryTelephone] => 01456 000999
        )

    [Parcel] => Array
        (
            [ParcelContents] => Clothes
            [EstimatedValue] => £24
            [ServiceName] => Home 48 (UK to UK)
            [ServiceID] => DHL48_UKUK
            [Carrier] => DHL Home
            [Weight] => 10
            [Length] => 5
            [Width] => 5
            [Height] => 5
        )

    [Pricing] => Array
        (
            [SubTotal] => 5.99
            [VAT] => 1.05
            [TotalPrice] => 7.04
        )

)