GET api/v1/shipments/export?currentPage={currentPage}&pageSize={pageSize}&from={from}&to={to}&sortBy={sortBy}&direction={direction}&weightGroup={weightGroup}&paymentTypes={paymentTypes}&serviceLevels={serviceLevels}&shipmentTypes={shipmentTypes}&destinationContinents={destinationContinents}&term={term}

Request Information

URI Parameters

Name	Type	Additional information
currentPage	integer	Required
pageSize	integer	Required
from	date	Required
to	date	Required
sortBy	string	Required
direction	boolean	Required
weightGroup	string	Required
paymentTypes	string	Required
serviceLevels	string	Required
shipmentTypes	string	Required
destinationContinents	string	Required
term	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PackageExportModel

Name	Type	Additional information
Fee1	decimal number	None.
ActualDate	string	None.
Reference2	string	None.
Reference1	string	None.
IsDDO	boolean	None.
PickUpTime	date	None.
Country	TrackInfoCountryModel	None.
ChargeableWeight	WeightModel	None.
TrackingNumber	string	None.
MasterTrackNumber	string	None.
ScannedDocuments	integer	None.
ScannedDocumentsUrl	string	None.
PaymentType	string	None.
CustomerNumber	integer	None.
ConsigneeName	string	None.
NumberOfPackages	integer	None.
ServiceLevel	string	None.
LastStatus	string	None.
ServiceLevelCode	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Fee1": 1.1,
    "ActualDate": "sample string 2",
    "Reference2": "sample string 3",
    "Reference1": "sample string 4",
    "IsDDO": true,
    "PickUpTime": "2021-04-23T07:09:45.9888684+03:00",
    "Country": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "TrackingNumber": "sample string 6",
    "MasterTrackNumber": "sample string 7",
    "ScannedDocuments": 8,
    "ScannedDocumentsUrl": "sample string 9",
    "PaymentType": "sample string 10",
    "CustomerNumber": 11,
    "ConsigneeName": "sample string 12",
    "NumberOfPackages": 13,
    "ServiceLevel": "sample string 14",
    "LastStatus": "sample string 15",
    "ServiceLevelCode": "sample string 16"
  },
  {
    "Fee1": 1.1,
    "ActualDate": "sample string 2",
    "Reference2": "sample string 3",
    "Reference1": "sample string 4",
    "IsDDO": true,
    "PickUpTime": "2021-04-23T07:09:45.9888684+03:00",
    "Country": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "TrackingNumber": "sample string 6",
    "MasterTrackNumber": "sample string 7",
    "ScannedDocuments": 8,
    "ScannedDocumentsUrl": "sample string 9",
    "PaymentType": "sample string 10",
    "CustomerNumber": 11,
    "ConsigneeName": "sample string 12",
    "NumberOfPackages": 13,
    "ServiceLevel": "sample string 14",
    "LastStatus": "sample string 15",
    "ServiceLevelCode": "sample string 16"
  }
]

application/xml, text/xml

Sample:

<ArrayOfPackageExportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Ship">
  <PackageExportModel>
    <ConsigneeName>sample string 12</ConsigneeName>
    <CustomerNumber>11</CustomerNumber>
    <LastStatus>sample string 15</LastStatus>
    <MasterTrackNumber>sample string 7</MasterTrackNumber>
    <NumberOfPackages>13</NumberOfPackages>
    <PaymentType>sample string 10</PaymentType>
    <ScannedDocuments>8</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 9</ScannedDocumentsUrl>
    <ServiceLevel>sample string 14</ServiceLevel>
    <ServiceLevelCode>sample string 16</ServiceLevelCode>
    <TrackingNumber>sample string 6</TrackingNumber>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <Country>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </Country>
    <ActualDate>sample string 2</ActualDate>
    <Fee1>1.1</Fee1>
    <IsDDO>true</IsDDO>
    <PickUpTime>2021-04-23T07:09:45.9888684+03:00</PickUpTime>
    <Reference1>sample string 4</Reference1>
    <Reference2>sample string 3</Reference2>
  </PackageExportModel>
  <PackageExportModel>
    <ConsigneeName>sample string 12</ConsigneeName>
    <CustomerNumber>11</CustomerNumber>
    <LastStatus>sample string 15</LastStatus>
    <MasterTrackNumber>sample string 7</MasterTrackNumber>
    <NumberOfPackages>13</NumberOfPackages>
    <PaymentType>sample string 10</PaymentType>
    <ScannedDocuments>8</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 9</ScannedDocumentsUrl>
    <ServiceLevel>sample string 14</ServiceLevel>
    <ServiceLevelCode>sample string 16</ServiceLevelCode>
    <TrackingNumber>sample string 6</TrackingNumber>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <Country>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </Country>
    <ActualDate>sample string 2</ActualDate>
    <Fee1>1.1</Fee1>
    <IsDDO>true</IsDDO>
    <PickUpTime>2021-04-23T07:09:45.9888684+03:00</PickUpTime>
    <Reference1>sample string 4</Reference1>
    <Reference2>sample string 3</Reference2>
  </PackageExportModel>
</ArrayOfPackageExportModel>