Help Page Home

GET api/public/v2/deliveries?criteria.ApiKey={criteria.ApiKey}&criteria.Filter={criteria.Filter}&criteria.StartDate={criteria.StartDate}&criteria.DriverId={criteria.DriverId}&paging.PageNumber={paging.PageNumber}&paging.PageSize={paging.PageSize}&paging.PagingMaxId={paging.PagingMaxId}

Request Information

URI Parameters

Name	Description	Type	Additional information
ApiKey	Your merchant API key	globally unique identifier	None.
Filter	Used to filter the results, eg: to show only current orders	DeliveryAPIFilter	None.
StartDate	Filters the results to only show deliveries starting at a specific date	date	None.
DriverId	Filters by a single driver identifier	globally unique identifier	None.
PageNumber	The page number of the results. Note the first page is 1 (not 0). Defaults to first page.	integer	None.
PageSize	The amount of items to display in each page. Defaults to 50 records.	integer	None.
PagingMaxId		integer	None.

Body Parameters

None.

Response Information

Resource Description

PagedApiListOfDeliveryDetailsModel

Name	Type	Additional information
CurrentPage	integer	None.
PageCount	integer	None.
PageSize	integer	None.
TotalCount	integer	None.
FirstPageUrl	string	None.
PreviousPageUrl	string	None.
NextPageUrl	string	None.
LastPageUrl	string	None.
Data	Collection of DeliveryDetailsModel	None.

Response Formats

application/json, text/json

Sample:

{
  "currentPage": 1,
  "pageCount": 2,
  "pageSize": 3,
  "totalCount": 4,
  "firstPageUrl": "sample string 5",
  "previousPageUrl": "sample string 6",
  "nextPageUrl": "sample string 7",
  "lastPageUrl": "sample string 8",
  "data": [
    {
      "created": "2023-03-27T04:49:47.7209266+00:00",
      "id": "bd5962a8-09bf-4b36-b284-64097a304795",
      "reference": "sample string 3",
      "pickupLocation": {
        "name": "sample string 1",
        "address": "sample string 2",
        "phone": "sample string 3",
        "postcode": "sample string 4",
        "suburb": "sample string 5"
      },
      "dropoffLocation": {
        "name": "sample string 1",
        "address": "sample string 2",
        "phone": "sample string 3",
        "postcode": "sample string 4",
        "suburb": "sample string 5"
      },
      "lastUpdated": "2023-03-27T04:49:47.7209266+00:00",
      "currentStatus": "sample string 5",
      "driver": {
        "identifier": "8d755bb6-ecda-4d4c-b9b3-3c352381de3a",
        "name": "sample string 2",
        "phone": "sample string 3",
        "photoUrl": "sample string 4",
        "email": "sample string 5"
      },
      "driverLocation": {
        "latitude": 1.1,
        "longitude": 2.1
      },
      "modeOfTransport": "sample string 6",
      "jobNotes": [
        "sample string 1",
        "sample string 2"
      ],
      "items": [
        "sample string 1",
        "sample string 2"
      ],
      "constraints": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "capacities": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "pickupTime": "2023-03-27T04:49:47.7209266+00:00",
      "dropoffTime": {
        "earliestTime": "2023-03-27T04:49:47.7209266+00:00",
        "latestTime": "2023-03-27T04:49:47.7209266+00:00"
      },
      "deliveryInstructions": "sample string 7",
      "customerReference": "sample string 8",
      "trackingUrls": {
        "www": "sample string 1",
        "api": "sample string 2"
      },
      "proofOfDelivery": {
        "signatureUrl": "sample string 1",
        "attachments": [
          "sample string 1",
          "sample string 2"
        ],
        "jobTags": [
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          }
        ]
      },
      "driverTip": 9.0,
      "deliveryFee": 1.0,
      "estimatedDistance": {
        "kilometres": 1.1,
        "miles": 2.1
      },
      "stageHistory": [
        {
          "created": "2023-03-27T04:49:47.7365541+00:00",
          "stage": "sample string 2",
          "notes": "sample string 3"
        },
        {
          "created": "2023-03-27T04:49:47.7365541+00:00",
          "stage": "sample string 2",
          "notes": "sample string 3"
        }
      ],
      "payments": {
        "sample string 1": {},
        "sample string 3": {}
      }
    },
    {
      "created": "2023-03-27T04:49:47.7209266+00:00",
      "id": "bd5962a8-09bf-4b36-b284-64097a304795",
      "reference": "sample string 3",
      "pickupLocation": {
        "name": "sample string 1",
        "address": "sample string 2",
        "phone": "sample string 3",
        "postcode": "sample string 4",
        "suburb": "sample string 5"
      },
      "dropoffLocation": {
        "name": "sample string 1",
        "address": "sample string 2",
        "phone": "sample string 3",
        "postcode": "sample string 4",
        "suburb": "sample string 5"
      },
      "lastUpdated": "2023-03-27T04:49:47.7209266+00:00",
      "currentStatus": "sample string 5",
      "driver": {
        "identifier": "8d755bb6-ecda-4d4c-b9b3-3c352381de3a",
        "name": "sample string 2",
        "phone": "sample string 3",
        "photoUrl": "sample string 4",
        "email": "sample string 5"
      },
      "driverLocation": {
        "latitude": 1.1,
        "longitude": 2.1
      },
      "modeOfTransport": "sample string 6",
      "jobNotes": [
        "sample string 1",
        "sample string 2"
      ],
      "items": [
        "sample string 1",
        "sample string 2"
      ],
      "constraints": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "capacities": [
        {
          "name": "sample string 1",
          "value": "sample string 2"
        },
        {
          "name": "sample string 1",
          "value": "sample string 2"
        }
      ],
      "pickupTime": "2023-03-27T04:49:47.7209266+00:00",
      "dropoffTime": {
        "earliestTime": "2023-03-27T04:49:47.7209266+00:00",
        "latestTime": "2023-03-27T04:49:47.7209266+00:00"
      },
      "deliveryInstructions": "sample string 7",
      "customerReference": "sample string 8",
      "trackingUrls": {
        "www": "sample string 1",
        "api": "sample string 2"
      },
      "proofOfDelivery": {
        "signatureUrl": "sample string 1",
        "attachments": [
          "sample string 1",
          "sample string 2"
        ],
        "jobTags": [
          {
            "name": "sample string 1",
            "value": "sample string 2"
          },
          {
            "name": "sample string 1",
            "value": "sample string 2"
          }
        ]
      },
      "driverTip": 9.0,
      "deliveryFee": 1.0,
      "estimatedDistance": {
        "kilometres": 1.1,
        "miles": 2.1
      },
      "stageHistory": [
        {
          "created": "2023-03-27T04:49:47.7365541+00:00",
          "stage": "sample string 2",
          "notes": "sample string 3"
        },
        {
          "created": "2023-03-27T04:49:47.7365541+00:00",
          "stage": "sample string 2",
          "notes": "sample string 3"
        }
      ],
      "payments": {
        "sample string 1": {},
        "sample string 3": {}
      }
    }
  ]
}

text/xml

Sample:

<PagedApiListOfDeliveryDetailsModelA5vRCwJ4 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2">
  <CurrentPage>1</CurrentPage>
  <Data>
    <DeliveryDetailsModel>
      <Capacities>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
      </Capacities>
      <Constraints>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
      </Constraints>
      <Created>2023-03-27T04:49:47.7209266+00:00</Created>
      <CurrentStatus>sample string 5</CurrentStatus>
      <CustomerReference>sample string 8</CustomerReference>
      <DeliveryFee>1</DeliveryFee>
      <DeliveryInstructions>sample string 7</DeliveryInstructions>
      <Driver>
        <Email>sample string 5</Email>
        <Identifier>8d755bb6-ecda-4d4c-b9b3-3c352381de3a</Identifier>
        <Name>sample string 2</Name>
        <Phone>sample string 3</Phone>
        <PhotoUrl>sample string 4</PhotoUrl>
      </Driver>
      <DriverLocation>
        <Latitude>1.1</Latitude>
        <Longitude>2.1</Longitude>
      </DriverLocation>
      <DriverTip>9</DriverTip>
      <DropoffLocation>
        <Address>sample string 2</Address>
        <Name>sample string 1</Name>
        <Phone>sample string 3</Phone>
        <Postcode>sample string 4</Postcode>
        <Suburb>sample string 5</Suburb>
      </DropoffLocation>
      <DropoffTime>
        <EarliestTime>2023-03-27T04:49:47.7209266+00:00</EarliestTime>
        <LatestTime>2023-03-27T04:49:47.7209266+00:00</LatestTime>
      </DropoffTime>
      <EstimatedDistance>
        <Kilometres>1.1</Kilometres>
        <Miles>2.1</Miles>
      </EstimatedDistance>
      <Id>bd5962a8-09bf-4b36-b284-64097a304795</Id>
      <Items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Items>
      <JobNotes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </JobNotes>
      <LastUpdated>2023-03-27T04:49:47.7209266+00:00</LastUpdated>
      <ModeOfTransport>sample string 6</ModeOfTransport>
      <Payments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Payments>
      <PickupLocation>
        <Address>sample string 2</Address>
        <Name>sample string 1</Name>
        <Phone>sample string 3</Phone>
        <Postcode>sample string 4</Postcode>
        <Suburb>sample string 5</Suburb>
      </PickupLocation>
      <PickupTime>2023-03-27T04:49:47.7209266+00:00</PickupTime>
      <ProofOfDelivery>
        <Attachments xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Attachments>
        <JobTags>
          <CustomPodFieldModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </CustomPodFieldModel>
          <CustomPodFieldModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </CustomPodFieldModel>
        </JobTags>
        <SignatureUrl>sample string 1</SignatureUrl>
      </ProofOfDelivery>
      <Reference>sample string 3</Reference>
      <StageHistory>
        <StageEntryModel>
          <Created>2023-03-27T04:49:47.7365541+00:00</Created>
          <Notes>sample string 3</Notes>
          <Stage>sample string 2</Stage>
        </StageEntryModel>
        <StageEntryModel>
          <Created>2023-03-27T04:49:47.7365541+00:00</Created>
          <Notes>sample string 3</Notes>
          <Stage>sample string 2</Stage>
        </StageEntryModel>
      </StageHistory>
      <TrackingUrls>
        <Api>sample string 2</Api>
        <Www>sample string 1</Www>
      </TrackingUrls>
    </DeliveryDetailsModel>
    <DeliveryDetailsModel>
      <Capacities>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
      </Capacities>
      <Constraints>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
        <CustomPodFieldModel>
          <Name>sample string 1</Name>
          <Value>sample string 2</Value>
        </CustomPodFieldModel>
      </Constraints>
      <Created>2023-03-27T04:49:47.7209266+00:00</Created>
      <CurrentStatus>sample string 5</CurrentStatus>
      <CustomerReference>sample string 8</CustomerReference>
      <DeliveryFee>1</DeliveryFee>
      <DeliveryInstructions>sample string 7</DeliveryInstructions>
      <Driver>
        <Email>sample string 5</Email>
        <Identifier>8d755bb6-ecda-4d4c-b9b3-3c352381de3a</Identifier>
        <Name>sample string 2</Name>
        <Phone>sample string 3</Phone>
        <PhotoUrl>sample string 4</PhotoUrl>
      </Driver>
      <DriverLocation>
        <Latitude>1.1</Latitude>
        <Longitude>2.1</Longitude>
      </DriverLocation>
      <DriverTip>9</DriverTip>
      <DropoffLocation>
        <Address>sample string 2</Address>
        <Name>sample string 1</Name>
        <Phone>sample string 3</Phone>
        <Postcode>sample string 4</Postcode>
        <Suburb>sample string 5</Suburb>
      </DropoffLocation>
      <DropoffTime>
        <EarliestTime>2023-03-27T04:49:47.7209266+00:00</EarliestTime>
        <LatestTime>2023-03-27T04:49:47.7209266+00:00</LatestTime>
      </DropoffTime>
      <EstimatedDistance>
        <Kilometres>1.1</Kilometres>
        <Miles>2.1</Miles>
      </EstimatedDistance>
      <Id>bd5962a8-09bf-4b36-b284-64097a304795</Id>
      <Items xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Items>
      <JobNotes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </JobNotes>
      <LastUpdated>2023-03-27T04:49:47.7209266+00:00</LastUpdated>
      <ModeOfTransport>sample string 6</ModeOfTransport>
      <Payments xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Payments>
      <PickupLocation>
        <Address>sample string 2</Address>
        <Name>sample string 1</Name>
        <Phone>sample string 3</Phone>
        <Postcode>sample string 4</Postcode>
        <Suburb>sample string 5</Suburb>
      </PickupLocation>
      <PickupTime>2023-03-27T04:49:47.7209266+00:00</PickupTime>
      <ProofOfDelivery>
        <Attachments xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </Attachments>
        <JobTags>
          <CustomPodFieldModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </CustomPodFieldModel>
          <CustomPodFieldModel>
            <Name>sample string 1</Name>
            <Value>sample string 2</Value>
          </CustomPodFieldModel>
        </JobTags>
        <SignatureUrl>sample string 1</SignatureUrl>
      </ProofOfDelivery>
      <Reference>sample string 3</Reference>
      <StageHistory>
        <StageEntryModel>
          <Created>2023-03-27T04:49:47.7365541+00:00</Created>
          <Notes>sample string 3</Notes>
          <Stage>sample string 2</Stage>
        </StageEntryModel>
        <StageEntryModel>
          <Created>2023-03-27T04:49:47.7365541+00:00</Created>
          <Notes>sample string 3</Notes>
          <Stage>sample string 2</Stage>
        </StageEntryModel>
      </StageHistory>
      <TrackingUrls>
        <Api>sample string 2</Api>
        <Www>sample string 1</Www>
      </TrackingUrls>
    </DeliveryDetailsModel>
  </Data>
  <FirstPageUrl>sample string 5</FirstPageUrl>
  <LastPageUrl>sample string 8</LastPageUrl>
  <NextPageUrl>sample string 7</NextPageUrl>
  <PageCount>2</PageCount>
  <PageSize>3</PageSize>
  <PreviousPageUrl>sample string 6</PreviousPageUrl>
  <TotalCount>4</TotalCount>
</PagedApiListOfDeliveryDetailsModelA5vRCwJ4>