The DeliveryPickupStatus endpoint enables users to retrieve detailed delivery address information associated with a specific Booking or Invoice using the Invoice Number. This document outlines the necessary steps to utilise this endpoint effectively.

The DeliveryPickupStatus endpoint can be accessed via the following URL:

GET https://api.hirepos.com/DeliveryPickupStatus

To authenticate your request, you must include the following headers:

• AuthKey: {YourAPIKey}

• AuthSecret: {YourAPISecret}

When making a GET request, you need to include an InvoiceNo parameter:

GET https://api.hirepos.com/DeliveryPickupStatus?InvoiceNo=1234

Below is an example of a successful request and the expected response format:

GET https://api.hirepos.com/DeliveryPickupStatus?InvoiceNo=1234

Headers:
AuthKey={YourAPIKey}
AuthSecret={YourAPISecret}


// Example Request...


{
    "ErrorRaised": "False",
    "ErrorType": null,
    "ErrorMessage": null,
    "Invoice": {
        "Id": 911455,
        "InvoiceNo": 1234,
        "DeliveryAddressLine1": "321 Hunter St",
        "DeliveryCity": "Newcastle",
        "DeliveryState": "NSW",
        "DeliveryPostcode": "2300",
        "DeliveryContactName": "Mia Baker",
        "DeliveryPhone1": "+61 2 3456 7890",
        "DeliveryRequired": false,
        "Items": [
            {
                "Code": "HIRE-016",
                "Description": "Case Model-169 Loader",
                "QtyItems": 1.0,
                "IsHire": true,
                "IsNonStock": false
            }
        ]
    }
}