POST api/reports/parcel/ShipmentsByOrderIdsExport

Gets a excel list of shipments by order ids Parameters: none Body: List of order ids, startDate, endDate

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Description	Additional information
StartDate	date
EndDate	date
OrderIds	Collection of string

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2024-10-13T13:41:41.99003+00:00",
  "EndDate": "2024-10-13T13:41:41.99003+00:00",
  "OrderIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<ShipmentsExportRequest xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2024-10-13T13:41:41.99003+00:00</StartDate>
  <EndDate>2024-10-13T13:41:41.99003+00:00</EndDate>
  <OrderIds>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </OrderIds>
</ShipmentsExportRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Json with url to excel file

ShipmentReportModel

Name	Type	Description	Additional information
Value	string
ShipmentDetail	Collection of ReportShipment
PagingParameterResponseModel	PagingParameterResponseModel

Response Formats

application/json, text/json

Sample:

{
  "Value": "sample string 1",
  "ShipmentDetail": [
    {
      "Id": 1,
      "ClientName": "sample string 2",
      "OrderNumber": "sample string 3",
      "ShipCarrierName": "sample string 4",
      "ShipCarrierServiceName": "sample string 5",
      "ShippingLicensePlate": "sample string 6",
      "ShipDate": "2024-10-13T13:41:42.0056565+00:00",
      "ImportDate": "2024-10-13T13:41:42.0056565+00:00",
      "TrackingNumber": "sample string 7",
      "TransactionNumber": "sample string 8",
      "TransactionDate": "2024-10-13T13:41:42.0056565+00:00",
      "Zone": "sample string 9",
      "TotalShippingCharge": 1.0,
      "PackageType": "sample string 10",
      "FromPostalCode": "sample string 11",
      "FromCountry": "sample string 12",
      "ShipFromLocation": "sample string 13",
      "ToAddress1": "sample string 14",
      "ToAddress2": "sample string 15",
      "ToCity": "sample string 16",
      "ToState": "sample string 17",
      "ToPostalCode": "sample string 18",
      "ToCountry": "sample string 19",
      "ToCountryISO3": "sample string 20",
      "ReturnPostalCode": "sample string 21",
      "SubClientName": "sample string 22",
      "EstimatedDeliveryDate": "2024-10-13T13:41:42.0056565+00:00",
      "DeliveryDate": "2024-10-13T13:41:42.0056565+00:00",
      "CarrierReceivedDate": "2024-10-13T13:41:42.0056565+00:00",
      "CreatedDate": "2024-10-13T13:41:42.0056565+00:00",
      "Status": "sample string 23",
      "StatusDate": "2024-10-13T13:41:42.0056565+00:00",
      "Charges": [
        {
          "ChargeName": "sample string 1",
          "ChargeAmount": 2.0
        },
        {
          "ChargeName": "sample string 1",
          "ChargeAmount": 2.0
        }
      ],
      "BusinessDaysFromShipDateToDeliverDate": 1,
      "BusinessDaysFromShipDateToFirstScan": 1,
      "BusinessDaysFromShipDateToStopClock": 1,
      "CalendarDaysFromShipDateToDeliverDate": 1,
      "CalendarDaysFromShipDateToFirstScan": 1,
      "CalendarDaysFromShipDateToStopClock": 1,
      "CalendarDaysFromFirstScanToStopClock": 1,
      "CalendarDaysFromStopClockToDeliveryDate": 1,
      "DaysFromReturnDateToCustomerReceived": 1,
      "WeekOfTheYear": 1,
      "PackageReturnsInitiatedDate": "2024-10-13T13:41:42.0056565+00:00",
      "PackageReturnedToWarehouseDate": "2024-10-13T13:41:42.0056565+00:00",
      "PackageReturnedToClientDate": "2024-10-13T13:41:42.0056565+00:00",
      "StopClockDate": "2024-10-13T13:41:42.0056565+00:00",
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "Weight": 1.0,
      "WeightUnitOfMeasure": "sample string 24",
      "DimensionUnitOfMeasure": "sample string 25",
      "TargetNettedStopClock": 26,
      "Voided": true,
      "CurrentTrackingEventDescription": "sample string 28",
      "CurrentTrackingStatus": "sample string 29",
      "CurrentEventDate": "2024-10-13T13:41:42.0056565+00:00",
      "TrackingSummary": "sample string 30",
      "InductionZipCode": "sample string 31",
      "IsReturn": true,
      "ProductReference": "sample string 33",
      "MerchantReference": "sample string 34"
    },
    {
      "Id": 1,
      "ClientName": "sample string 2",
      "OrderNumber": "sample string 3",
      "ShipCarrierName": "sample string 4",
      "ShipCarrierServiceName": "sample string 5",
      "ShippingLicensePlate": "sample string 6",
      "ShipDate": "2024-10-13T13:41:42.0056565+00:00",
      "ImportDate": "2024-10-13T13:41:42.0056565+00:00",
      "TrackingNumber": "sample string 7",
      "TransactionNumber": "sample string 8",
      "TransactionDate": "2024-10-13T13:41:42.0056565+00:00",
      "Zone": "sample string 9",
      "TotalShippingCharge": 1.0,
      "PackageType": "sample string 10",
      "FromPostalCode": "sample string 11",
      "FromCountry": "sample string 12",
      "ShipFromLocation": "sample string 13",
      "ToAddress1": "sample string 14",
      "ToAddress2": "sample string 15",
      "ToCity": "sample string 16",
      "ToState": "sample string 17",
      "ToPostalCode": "sample string 18",
      "ToCountry": "sample string 19",
      "ToCountryISO3": "sample string 20",
      "ReturnPostalCode": "sample string 21",
      "SubClientName": "sample string 22",
      "EstimatedDeliveryDate": "2024-10-13T13:41:42.0056565+00:00",
      "DeliveryDate": "2024-10-13T13:41:42.0056565+00:00",
      "CarrierReceivedDate": "2024-10-13T13:41:42.0056565+00:00",
      "CreatedDate": "2024-10-13T13:41:42.0056565+00:00",
      "Status": "sample string 23",
      "StatusDate": "2024-10-13T13:41:42.0056565+00:00",
      "Charges": [
        {
          "ChargeName": "sample string 1",
          "ChargeAmount": 2.0
        },
        {
          "ChargeName": "sample string 1",
          "ChargeAmount": 2.0
        }
      ],
      "BusinessDaysFromShipDateToDeliverDate": 1,
      "BusinessDaysFromShipDateToFirstScan": 1,
      "BusinessDaysFromShipDateToStopClock": 1,
      "CalendarDaysFromShipDateToDeliverDate": 1,
      "CalendarDaysFromShipDateToFirstScan": 1,
      "CalendarDaysFromShipDateToStopClock": 1,
      "CalendarDaysFromFirstScanToStopClock": 1,
      "CalendarDaysFromStopClockToDeliveryDate": 1,
      "DaysFromReturnDateToCustomerReceived": 1,
      "WeekOfTheYear": 1,
      "PackageReturnsInitiatedDate": "2024-10-13T13:41:42.0056565+00:00",
      "PackageReturnedToWarehouseDate": "2024-10-13T13:41:42.0056565+00:00",
      "PackageReturnedToClientDate": "2024-10-13T13:41:42.0056565+00:00",
      "StopClockDate": "2024-10-13T13:41:42.0056565+00:00",
      "Height": 1.0,
      "Length": 1.0,
      "Width": 1.0,
      "Weight": 1.0,
      "WeightUnitOfMeasure": "sample string 24",
      "DimensionUnitOfMeasure": "sample string 25",
      "TargetNettedStopClock": 26,
      "Voided": true,
      "CurrentTrackingEventDescription": "sample string 28",
      "CurrentTrackingStatus": "sample string 29",
      "CurrentEventDate": "2024-10-13T13:41:42.0056565+00:00",
      "TrackingSummary": "sample string 30",
      "InductionZipCode": "sample string 31",
      "IsReturn": true,
      "ProductReference": "sample string 33",
      "MerchantReference": "sample string 34"
    }
  ],
  "PagingParameterResponseModel": {
    "TotalCount": 1,
    "PageSize": 2,
    "CurrentPage": 3,
    "TotalPages": 4,
    "PreviousPage": true,
    "NextPage": true
  }
}

application/xml, text/xml

Sample:

<ShipmentReportModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Value>sample string 1</Value>
  <ShipmentDetail>
    <ReportShipment>
      <Id>1</Id>
      <ClientName>sample string 2</ClientName>
      <OrderNumber>sample string 3</OrderNumber>
      <ShipCarrierName>sample string 4</ShipCarrierName>
      <ShipCarrierServiceName>sample string 5</ShipCarrierServiceName>
      <ShippingLicensePlate>sample string 6</ShippingLicensePlate>
      <ShipDate>2024-10-13T13:41:42.0056565+00:00</ShipDate>
      <ImportDate>2024-10-13T13:41:42.0056565+00:00</ImportDate>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TransactionNumber>sample string 8</TransactionNumber>
      <TransactionDate>2024-10-13T13:41:42.0056565+00:00</TransactionDate>
      <Zone>sample string 9</Zone>
      <TotalShippingCharge>1</TotalShippingCharge>
      <PackageType>sample string 10</PackageType>
      <FromPostalCode>sample string 11</FromPostalCode>
      <FromCountry>sample string 12</FromCountry>
      <ShipFromLocation>sample string 13</ShipFromLocation>
      <ToAddress1>sample string 14</ToAddress1>
      <ToAddress2>sample string 15</ToAddress2>
      <ToCity>sample string 16</ToCity>
      <ToState>sample string 17</ToState>
      <ToPostalCode>sample string 18</ToPostalCode>
      <ToCountry>sample string 19</ToCountry>
      <ToCountryISO3>sample string 20</ToCountryISO3>
      <ReturnPostalCode>sample string 21</ReturnPostalCode>
      <SubClientName>sample string 22</SubClientName>
      <EstimatedDeliveryDate>2024-10-13T13:41:42.0056565+00:00</EstimatedDeliveryDate>
      <DeliveryDate>2024-10-13T13:41:42.0056565+00:00</DeliveryDate>
      <CarrierReceivedDate>2024-10-13T13:41:42.0056565+00:00</CarrierReceivedDate>
      <CreatedDate>2024-10-13T13:41:42.0056565+00:00</CreatedDate>
      <Status>sample string 23</Status>
      <StatusDate>2024-10-13T13:41:42.0056565+00:00</StatusDate>
      <Charges>
        <ShipmentCharge>
          <ChargeName>sample string 1</ChargeName>
          <ChargeAmount>2</ChargeAmount>
        </ShipmentCharge>
        <ShipmentCharge>
          <ChargeName>sample string 1</ChargeName>
          <ChargeAmount>2</ChargeAmount>
        </ShipmentCharge>
      </Charges>
      <BusinessDaysFromShipDateToDeliverDate>1</BusinessDaysFromShipDateToDeliverDate>
      <BusinessDaysFromShipDateToFirstScan>1</BusinessDaysFromShipDateToFirstScan>
      <BusinessDaysFromShipDateToStopClock>1</BusinessDaysFromShipDateToStopClock>
      <CalendarDaysFromShipDateToDeliverDate>1</CalendarDaysFromShipDateToDeliverDate>
      <CalendarDaysFromShipDateToFirstScan>1</CalendarDaysFromShipDateToFirstScan>
      <CalendarDaysFromShipDateToStopClock>1</CalendarDaysFromShipDateToStopClock>
      <CalendarDaysFromFirstScanToStopClock>1</CalendarDaysFromFirstScanToStopClock>
      <CalendarDaysFromStopClockToDeliveryDate>1</CalendarDaysFromStopClockToDeliveryDate>
      <DaysFromReturnDateToCustomerReceived>1</DaysFromReturnDateToCustomerReceived>
      <WeekOfTheYear>1</WeekOfTheYear>
      <PackageReturnsInitiatedDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnsInitiatedDate>
      <PackageReturnedToWarehouseDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnedToWarehouseDate>
      <PackageReturnedToClientDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnedToClientDate>
      <StopClockDate>2024-10-13T13:41:42.0056565+00:00</StopClockDate>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <Weight>1</Weight>
      <WeightUnitOfMeasure>sample string 24</WeightUnitOfMeasure>
      <DimensionUnitOfMeasure>sample string 25</DimensionUnitOfMeasure>
      <TargetNettedStopClock>26</TargetNettedStopClock>
      <Voided>true</Voided>
      <CurrentTrackingEventDescription>sample string 28</CurrentTrackingEventDescription>
      <CurrentTrackingStatus>sample string 29</CurrentTrackingStatus>
      <CurrentEventDate>2024-10-13T13:41:42.0056565+00:00</CurrentEventDate>
      <TrackingSummary>sample string 30</TrackingSummary>
      <InductionZipCode>sample string 31</InductionZipCode>
      <IsReturn>true</IsReturn>
      <ProductReference>sample string 33</ProductReference>
      <MerchantReference>sample string 34</MerchantReference>
    </ReportShipment>
    <ReportShipment>
      <Id>1</Id>
      <ClientName>sample string 2</ClientName>
      <OrderNumber>sample string 3</OrderNumber>
      <ShipCarrierName>sample string 4</ShipCarrierName>
      <ShipCarrierServiceName>sample string 5</ShipCarrierServiceName>
      <ShippingLicensePlate>sample string 6</ShippingLicensePlate>
      <ShipDate>2024-10-13T13:41:42.0056565+00:00</ShipDate>
      <ImportDate>2024-10-13T13:41:42.0056565+00:00</ImportDate>
      <TrackingNumber>sample string 7</TrackingNumber>
      <TransactionNumber>sample string 8</TransactionNumber>
      <TransactionDate>2024-10-13T13:41:42.0056565+00:00</TransactionDate>
      <Zone>sample string 9</Zone>
      <TotalShippingCharge>1</TotalShippingCharge>
      <PackageType>sample string 10</PackageType>
      <FromPostalCode>sample string 11</FromPostalCode>
      <FromCountry>sample string 12</FromCountry>
      <ShipFromLocation>sample string 13</ShipFromLocation>
      <ToAddress1>sample string 14</ToAddress1>
      <ToAddress2>sample string 15</ToAddress2>
      <ToCity>sample string 16</ToCity>
      <ToState>sample string 17</ToState>
      <ToPostalCode>sample string 18</ToPostalCode>
      <ToCountry>sample string 19</ToCountry>
      <ToCountryISO3>sample string 20</ToCountryISO3>
      <ReturnPostalCode>sample string 21</ReturnPostalCode>
      <SubClientName>sample string 22</SubClientName>
      <EstimatedDeliveryDate>2024-10-13T13:41:42.0056565+00:00</EstimatedDeliveryDate>
      <DeliveryDate>2024-10-13T13:41:42.0056565+00:00</DeliveryDate>
      <CarrierReceivedDate>2024-10-13T13:41:42.0056565+00:00</CarrierReceivedDate>
      <CreatedDate>2024-10-13T13:41:42.0056565+00:00</CreatedDate>
      <Status>sample string 23</Status>
      <StatusDate>2024-10-13T13:41:42.0056565+00:00</StatusDate>
      <Charges>
        <ShipmentCharge>
          <ChargeName>sample string 1</ChargeName>
          <ChargeAmount>2</ChargeAmount>
        </ShipmentCharge>
        <ShipmentCharge>
          <ChargeName>sample string 1</ChargeName>
          <ChargeAmount>2</ChargeAmount>
        </ShipmentCharge>
      </Charges>
      <BusinessDaysFromShipDateToDeliverDate>1</BusinessDaysFromShipDateToDeliverDate>
      <BusinessDaysFromShipDateToFirstScan>1</BusinessDaysFromShipDateToFirstScan>
      <BusinessDaysFromShipDateToStopClock>1</BusinessDaysFromShipDateToStopClock>
      <CalendarDaysFromShipDateToDeliverDate>1</CalendarDaysFromShipDateToDeliverDate>
      <CalendarDaysFromShipDateToFirstScan>1</CalendarDaysFromShipDateToFirstScan>
      <CalendarDaysFromShipDateToStopClock>1</CalendarDaysFromShipDateToStopClock>
      <CalendarDaysFromFirstScanToStopClock>1</CalendarDaysFromFirstScanToStopClock>
      <CalendarDaysFromStopClockToDeliveryDate>1</CalendarDaysFromStopClockToDeliveryDate>
      <DaysFromReturnDateToCustomerReceived>1</DaysFromReturnDateToCustomerReceived>
      <WeekOfTheYear>1</WeekOfTheYear>
      <PackageReturnsInitiatedDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnsInitiatedDate>
      <PackageReturnedToWarehouseDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnedToWarehouseDate>
      <PackageReturnedToClientDate>2024-10-13T13:41:42.0056565+00:00</PackageReturnedToClientDate>
      <StopClockDate>2024-10-13T13:41:42.0056565+00:00</StopClockDate>
      <Height>1</Height>
      <Length>1</Length>
      <Width>1</Width>
      <Weight>1</Weight>
      <WeightUnitOfMeasure>sample string 24</WeightUnitOfMeasure>
      <DimensionUnitOfMeasure>sample string 25</DimensionUnitOfMeasure>
      <TargetNettedStopClock>26</TargetNettedStopClock>
      <Voided>true</Voided>
      <CurrentTrackingEventDescription>sample string 28</CurrentTrackingEventDescription>
      <CurrentTrackingStatus>sample string 29</CurrentTrackingStatus>
      <CurrentEventDate>2024-10-13T13:41:42.0056565+00:00</CurrentEventDate>
      <TrackingSummary>sample string 30</TrackingSummary>
      <InductionZipCode>sample string 31</InductionZipCode>
      <IsReturn>true</IsReturn>
      <ProductReference>sample string 33</ProductReference>
      <MerchantReference>sample string 34</MerchantReference>
    </ReportShipment>
  </ShipmentDetail>
  <PagingParameterResponseModel>
    <TotalCount>1</TotalCount>
    <PageSize>2</PageSize>
    <CurrentPage>3</CurrentPage>
    <TotalPages>4</TotalPages>
    <PreviousPage>true</PreviousPage>
    <NextPage>true</NextPage>
  </PagingParameterResponseModel>
</ShipmentReportModel>