GET api/v1/shipments/domestic?currentPage={currentPage}&pageSize={pageSize}&from={from}&to={to}&sortBy={sortBy}&direction={direction}&weightGroup={weightGroup}&paymentTypes={paymentTypes}&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
term	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of DomesticModel

Name	Type	Additional information
PickupDate	date	None.
PodTime	date	None.
ShipperName	string	None.
ChargeableWeight	WeightModel	None.
Fee70	decimal number	None.
IsCod	boolean	None.
IsDDO	boolean	None.
IsUDR	boolean	None.
IsPallet	boolean	None.
IsSwap	boolean	None.
SwapTrackNumber	string	None.
ConsigneeContactName	string	None.
ActualDate	string	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.
ShipperContactName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ShipperContactName": "sample string 1",
    "PickupDate": "2021-04-23T07:09:36.4888919+03:00",
    "PodTime": "2021-04-23T07:09:36.4888919+03:00",
    "ShipperName": "sample string 1",
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "Fee70": 1.1,
    "IsCod": true,
    "IsDDO": true,
    "IsUDR": true,
    "IsPallet": true,
    "IsSwap": true,
    "SwapTrackNumber": "sample string 7",
    "ConsigneeContactName": "sample string 8",
    "ActualDate": "sample string 9",
    "TrackingNumber": "sample string 10",
    "MasterTrackNumber": "sample string 11",
    "ScannedDocuments": 12,
    "ScannedDocumentsUrl": "sample string 13",
    "PaymentType": "sample string 14",
    "CustomerNumber": 15,
    "ConsigneeName": "sample string 16",
    "NumberOfPackages": 17,
    "ServiceLevel": "sample string 18",
    "LastStatus": "sample string 19",
    "ServiceLevelCode": "sample string 20"
  },
  {
    "ShipperContactName": "sample string 1",
    "PickupDate": "2021-04-23T07:09:36.4888919+03:00",
    "PodTime": "2021-04-23T07:09:36.4888919+03:00",
    "ShipperName": "sample string 1",
    "ChargeableWeight": {
      "Weight": 1.1,
      "Unit": "sample string 1"
    },
    "Fee70": 1.1,
    "IsCod": true,
    "IsDDO": true,
    "IsUDR": true,
    "IsPallet": true,
    "IsSwap": true,
    "SwapTrackNumber": "sample string 7",
    "ConsigneeContactName": "sample string 8",
    "ActualDate": "sample string 9",
    "TrackingNumber": "sample string 10",
    "MasterTrackNumber": "sample string 11",
    "ScannedDocuments": 12,
    "ScannedDocumentsUrl": "sample string 13",
    "PaymentType": "sample string 14",
    "CustomerNumber": 15,
    "ConsigneeName": "sample string 16",
    "NumberOfPackages": 17,
    "ServiceLevel": "sample string 18",
    "LastStatus": "sample string 19",
    "ServiceLevelCode": "sample string 20"
  }
]

application/xml, text/xml

Sample:

<ArrayOfDomesticModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UPS.Ship.API.Models.Ship">
  <DomesticModel>
    <ConsigneeName>sample string 16</ConsigneeName>
    <CustomerNumber>15</CustomerNumber>
    <LastStatus>sample string 19</LastStatus>
    <MasterTrackNumber>sample string 11</MasterTrackNumber>
    <NumberOfPackages>17</NumberOfPackages>
    <PaymentType>sample string 14</PaymentType>
    <ScannedDocuments>12</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 13</ScannedDocumentsUrl>
    <ServiceLevel>sample string 18</ServiceLevel>
    <ServiceLevelCode>sample string 20</ServiceLevelCode>
    <TrackingNumber>sample string 10</TrackingNumber>
    <ActualDate>sample string 9</ActualDate>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <ConsigneeContactName>sample string 8</ConsigneeContactName>
    <Fee70>1.1</Fee70>
    <IsCod>true</IsCod>
    <IsDDO>true</IsDDO>
    <IsPallet>true</IsPallet>
    <IsSwap>true</IsSwap>
    <IsUDR>true</IsUDR>
    <PickupDate>2021-04-23T07:09:36.4888919+03:00</PickupDate>
    <PodTime>2021-04-23T07:09:36.4888919+03:00</PodTime>
    <ShipperContactName>sample string 1</ShipperContactName>
    <ShipperName>sample string 1</ShipperName>
    <SwapTrackNumber>sample string 7</SwapTrackNumber>
  </DomesticModel>
  <DomesticModel>
    <ConsigneeName>sample string 16</ConsigneeName>
    <CustomerNumber>15</CustomerNumber>
    <LastStatus>sample string 19</LastStatus>
    <MasterTrackNumber>sample string 11</MasterTrackNumber>
    <NumberOfPackages>17</NumberOfPackages>
    <PaymentType>sample string 14</PaymentType>
    <ScannedDocuments>12</ScannedDocuments>
    <ScannedDocumentsUrl>sample string 13</ScannedDocumentsUrl>
    <ServiceLevel>sample string 18</ServiceLevel>
    <ServiceLevelCode>sample string 20</ServiceLevelCode>
    <TrackingNumber>sample string 10</TrackingNumber>
    <ActualDate>sample string 9</ActualDate>
    <ChargeableWeight>
      <Unit>sample string 1</Unit>
      <Weight>1.1</Weight>
    </ChargeableWeight>
    <ConsigneeContactName>sample string 8</ConsigneeContactName>
    <Fee70>1.1</Fee70>
    <IsCod>true</IsCod>
    <IsDDO>true</IsDDO>
    <IsPallet>true</IsPallet>
    <IsSwap>true</IsSwap>
    <IsUDR>true</IsUDR>
    <PickupDate>2021-04-23T07:09:36.4888919+03:00</PickupDate>
    <PodTime>2021-04-23T07:09:36.4888919+03:00</PodTime>
    <ShipperContactName>sample string 1</ShipperContactName>
    <ShipperName>sample string 1</ShipperName>
    <SwapTrackNumber>sample string 7</SwapTrackNumber>
  </DomesticModel>
</ArrayOfDomesticModel>