GET v1/export/delivery-packages

Retrieve all delivery packages created or modified since Today

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ExportDeliveryPackageDTO

Name	Type	Additional information
DeliveryPackageId	EntityKeyOfIDeliveryPackageAndInt32	None.
DeliveryPackageCode	string	None.
PackageName	string	None.
PackageCode	string	None.
Status	DeliveryPackageStatus	None.
Address	AddressDTO	None.
AddressCode	string	None.
CompanyName	string	None.
ClientCode	string	None.
CompanyCode	string	None.
DivisionCode	string	None.
Attention	string	None.
DeliveryRouteCode	string	None.
DeliveryInstructions	string	None.
PackagingInstructions	string	None.
Email	string	None.
Phone	string	None.
ShippingCode	string	None.
CreatedOn	date	None.
ModifiedOn	date	None.
Source	DeliveryPackageSource	None.
ControlNumber	integer	None.
PackageDate	date	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "deliveryPackageId": "<empty>",
    "deliveryPackageCode": "sample string 1",
    "packageName": "sample string 2",
    "packageCode": "sample string 3",
    "status": "Created",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "addressCode": "sample string 4",
    "companyName": "sample string 5",
    "clientCode": "sample string 6",
    "companyCode": "sample string 7",
    "divisionCode": "sample string 8",
    "attention": "sample string 9",
    "deliveryRouteCode": "sample string 10",
    "deliveryInstructions": "sample string 11",
    "packagingInstructions": "sample string 12",
    "email": "sample string 13",
    "phone": "sample string 14",
    "shippingCode": "sample string 15",
    "createdOn": "2025-04-11T17:53:24.1357838Z",
    "modifiedOn": "2025-04-11T17:53:24.1357838Z",
    "source": "Payroll",
    "controlNumber": 1,
    "packageDate": "0001-02-03"
  },
  {
    "deliveryPackageId": "<empty>",
    "deliveryPackageCode": "sample string 1",
    "packageName": "sample string 2",
    "packageCode": "sample string 3",
    "status": "Created",
    "address": {
      "address1": "sample string 1",
      "address2": "sample string 2",
      "city": "sample string 3",
      "state": "sample string 4",
      "zip": "sample string 5",
      "country": "sample string 6",
      "county": "sample string 7"
    },
    "addressCode": "sample string 4",
    "companyName": "sample string 5",
    "clientCode": "sample string 6",
    "companyCode": "sample string 7",
    "divisionCode": "sample string 8",
    "attention": "sample string 9",
    "deliveryRouteCode": "sample string 10",
    "deliveryInstructions": "sample string 11",
    "packagingInstructions": "sample string 12",
    "email": "sample string 13",
    "phone": "sample string 14",
    "shippingCode": "sample string 15",
    "createdOn": "2025-04-11T17:53:24.1357838Z",
    "modifiedOn": "2025-04-11T17:53:24.1357838Z",
    "source": "Payroll",
    "controlNumber": 1,
    "packageDate": "0001-02-03"
  }
]

text/xml

Sample:

<ArrayOfExportDeliveryPackageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportDeliveryPackageDTO>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AddressCode>sample string 4</AddressCode>
    <Attention>sample string 9</Attention>
    <ClientCode>sample string 6</ClientCode>
    <CompanyCode>sample string 7</CompanyCode>
    <CompanyName>sample string 5</CompanyName>
    <ControlNumber>1</ControlNumber>
    <CreatedOn>2025-04-11T13:53:24.1357838-04:00</CreatedOn>
    <DeliveryInstructions>sample string 11</DeliveryInstructions>
    <DeliveryPackageCode>sample string 1</DeliveryPackageCode>
    <DeliveryPackageId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </DeliveryPackageId>
    <DeliveryRouteCode>sample string 10</DeliveryRouteCode>
    <DivisionCode>sample string 8</DivisionCode>
    <Email>sample string 13</Email>
    <ModifiedOn>2025-04-11T13:53:24.1357838-04:00</ModifiedOn>
    <PackageCode>sample string 3</PackageCode>
    <PackageDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PackageDate>
    <PackageName>sample string 2</PackageName>
    <PackagingInstructions>sample string 12</PackagingInstructions>
    <Phone>sample string 14</Phone>
    <ShippingCode>sample string 15</ShippingCode>
    <Source>Payroll</Source>
    <Status>Created</Status>
  </ExportDeliveryPackageDTO>
  <ExportDeliveryPackageDTO>
    <Address xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:Address1>sample string 1</d3p1:Address1>
      <d3p1:Address2>sample string 2</d3p1:Address2>
      <d3p1:City>sample string 3</d3p1:City>
      <d3p1:Country>sample string 6</d3p1:Country>
      <d3p1:County>sample string 7</d3p1:County>
      <d3p1:State>sample string 4</d3p1:State>
      <d3p1:Zip>sample string 5</d3p1:Zip>
    </Address>
    <AddressCode>sample string 4</AddressCode>
    <Attention>sample string 9</Attention>
    <ClientCode>sample string 6</ClientCode>
    <CompanyCode>sample string 7</CompanyCode>
    <CompanyName>sample string 5</CompanyName>
    <ControlNumber>1</ControlNumber>
    <CreatedOn>2025-04-11T13:53:24.1357838-04:00</CreatedOn>
    <DeliveryInstructions>sample string 11</DeliveryInstructions>
    <DeliveryPackageCode>sample string 1</DeliveryPackageCode>
    <DeliveryPackageId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </DeliveryPackageId>
    <DeliveryRouteCode>sample string 10</DeliveryRouteCode>
    <DivisionCode>sample string 8</DivisionCode>
    <Email>sample string 13</Email>
    <ModifiedOn>2025-04-11T13:53:24.1357838-04:00</ModifiedOn>
    <PackageCode>sample string 3</PackageCode>
    <PackageDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </PackageDate>
    <PackageName>sample string 2</PackageName>
    <PackagingInstructions>sample string 12</PackagingInstructions>
    <Phone>sample string 14</Phone>
    <ShippingCode>sample string 15</ShippingCode>
    <Source>Payroll</Source>
    <Status>Created</Status>
  </ExportDeliveryPackageDTO>
</ArrayOfExportDeliveryPackageDTO>