GET api/v1/shipments/history/import/ocean?currentPage={currentPage}&pageSize={pageSize}&from={from}&to={to}&sortBy={sortBy}&direction={direction}&weightGroup={weightGroup}&paymentTypes={paymentTypes}&serviceLevels={serviceLevels}&originContinents={originContinents}&term={term}&trackNumber={trackNumber}&countryCode={countryCode}

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
originContinents	string	Required
term	string	None.
trackNumber	string	None.
countryCode	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of FrieghtImportModel

Name	Type	Additional information
ArrivalDate	date	None.
IsOcean	boolean	None.
ForeignPortDesc	string	None.
DimensionalWeight	decimal number	None.
FileNumber	string	None.
TEU	string	None.
CarrierDesc	string	None.
FullContainerLoad	decimal number	None.
OriginPortDesc	string	None.
ConfirmedArrivalDate	date	None.
ForeignPortCode	string	None.
ShiperName	string	None.
OriginCountry	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.
BookingNo	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ArrivalDate": "2021-09-10T02:18:01.3139113+03:00",
    "IsOcean": true,
    "ForeignPortDesc": "sample string 2",
    "DimensionalWeight": 1.1,
    "FileNumber": "sample string 3",
    "TEU": "sample string 4",
    "CarrierDesc": "sample string 5",
    "FullContainerLoad": 1.1,
    "OriginPortDesc": "sample string 6",
    "ConfirmedArrivalDate": "2021-09-10T02:18:01.3139113+03:00",
    "ForeignPortCode": "sample string 7",
    "ShiperName": "sample string 8",
    "OriginCountry": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "TrackingNumber": "sample string 9",
    "MasterTrackNumber": "sample string 10",
    "ScannedDocuments": 11,
    "ScannedDocumentsUrl": "sample string 12",
    "PaymentType": "sample string 13",
    "CustomerNumber": 14,
    "ConsigneeName": "sample string 15",
    "NumberOfPackages": 16,
    "ServiceLevel": "sample string 17",
    "LastStatus": "sample string 18",
    "ServiceLevelCode": "sample string 19",
    "BookingNo": "sample string 20"
  },
  {
    "ArrivalDate": "2021-09-10T02:18:01.3139113+03:00",
    "IsOcean": true,
    "ForeignPortDesc": "sample string 2",
    "DimensionalWeight": 1.1,
    "FileNumber": "sample string 3",
    "TEU": "sample string 4",
    "CarrierDesc": "sample string 5",
    "FullContainerLoad": 1.1,
    "OriginPortDesc": "sample string 6",
    "ConfirmedArrivalDate": "2021-09-10T02:18:01.3139113+03:00",
    "ForeignPortCode": "sample string 7",
    "ShiperName": "sample string 8",
    "OriginCountry": {
      "Name": "sample string 1",
      "Flag": "sample string 2"
    },
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "TrackingNumber": "sample string 9",
    "MasterTrackNumber": "sample string 10",
    "ScannedDocuments": 11,
    "ScannedDocumentsUrl": "sample string 12",
    "PaymentType": "sample string 13",
    "CustomerNumber": 14,
    "ConsigneeName": "sample string 15",
    "NumberOfPackages": 16,
    "ServiceLevel": "sample string 17",
    "LastStatus": "sample string 18",
    "ServiceLevelCode": "sample string 19",
    "BookingNo": "sample string 20"
  }
]

application/xml, text/xml

Sample:

<ArrayOfFrieghtImportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Ship">
  <FrieghtImportModel>
    <BookingNo>sample string 20</BookingNo>
    <ConsigneeName>sample string 15</ConsigneeName>
    <CustomerNumber>14</CustomerNumber>
    <LastStatus>sample string 18</LastStatus>
    <MasterTrackNumber>sample string 10</MasterTrackNumber>
    <NumberOfPackages>16</NumberOfPackages>
    <PaymentType>sample string 13</PaymentType>
    <ScannedDocuments>11</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 12</ScannedDocumentsUrl>
    <ServiceLevel>sample string 17</ServiceLevel>
    <ServiceLevelCode>sample string 19</ServiceLevelCode>
    <TrackingNumber>sample string 9</TrackingNumber>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <OriginCountry>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </OriginCountry>
    <ShiperName>sample string 8</ShiperName>
    <ArrivalDate>2021-09-10T02:18:01.3139113+03:00</ArrivalDate>
    <CarrierDesc>sample string 5</CarrierDesc>
    <ConfirmedArrivalDate>2021-09-10T02:18:01.3139113+03:00</ConfirmedArrivalDate>
    <DimensionalWeight>1.1</DimensionalWeight>
    <FileNumber>sample string 3</FileNumber>
    <ForeignPortCode>sample string 7</ForeignPortCode>
    <ForeignPortDesc>sample string 2</ForeignPortDesc>
    <FullContainerLoad>1.1</FullContainerLoad>
    <IsOcean>true</IsOcean>
    <OriginPortDesc>sample string 6</OriginPortDesc>
    <TEU>sample string 4</TEU>
  </FrieghtImportModel>
  <FrieghtImportModel>
    <BookingNo>sample string 20</BookingNo>
    <ConsigneeName>sample string 15</ConsigneeName>
    <CustomerNumber>14</CustomerNumber>
    <LastStatus>sample string 18</LastStatus>
    <MasterTrackNumber>sample string 10</MasterTrackNumber>
    <NumberOfPackages>16</NumberOfPackages>
    <PaymentType>sample string 13</PaymentType>
    <ScannedDocuments>11</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 12</ScannedDocumentsUrl>
    <ServiceLevel>sample string 17</ServiceLevel>
    <ServiceLevelCode>sample string 19</ServiceLevelCode>
    <TrackingNumber>sample string 9</TrackingNumber>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <OriginCountry>
      <Flag>sample string 2</Flag>
      <Name>sample string 1</Name>
    </OriginCountry>
    <ShiperName>sample string 8</ShiperName>
    <ArrivalDate>2021-09-10T02:18:01.3139113+03:00</ArrivalDate>
    <CarrierDesc>sample string 5</CarrierDesc>
    <ConfirmedArrivalDate>2021-09-10T02:18:01.3139113+03:00</ConfirmedArrivalDate>
    <DimensionalWeight>1.1</DimensionalWeight>
    <FileNumber>sample string 3</FileNumber>
    <ForeignPortCode>sample string 7</ForeignPortCode>
    <ForeignPortDesc>sample string 2</ForeignPortDesc>
    <FullContainerLoad>1.1</FullContainerLoad>
    <IsOcean>true</IsOcean>
    <OriginPortDesc>sample string 6</OriginPortDesc>
    <TEU>sample string 4</TEU>
  </FrieghtImportModel>
</ArrayOfFrieghtImportModel>