POST api/Shipment/GetShipmentSummary

Request Information

Parameters

Name	Description	Additional information
sp	No documentation available.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "Query": "sample string 1",
  "TenantId": "sample string 2",
  "PageSize": 3,
  "Index": 4,
  "Type": "sample string 5",
  "Column": "sample string 6",
  "SortOrder": "sample string 7",
  "SortColumn": "sample string 8",
  "StartRecord": 9,
  "ShowingRecord": 10,
  "TotalRecord": 11,
  "RecipientSaveId": "3a2c298b-2b5b-43ba-9adb-ad231d5b6db2"
}

application/xml, text/xml

Sample:

<SearchParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data.Common">
  <Column>sample string 6</Column>
  <Index>4</Index>
  <PageSize>3</PageSize>
  <Query>sample string 1</Query>
  <RecipientSaveId>3a2c298b-2b5b-43ba-9adb-ad231d5b6db2</RecipientSaveId>
  <ShowingRecord>10</ShowingRecord>
  <SortColumn>sample string 8</SortColumn>
  <SortOrder>sample string 7</SortOrder>
  <StartRecord>9</StartRecord>
  <TenantId>sample string 2</TenantId>
  <TotalRecord>11</TotalRecord>
  <Type>sample string 5</Type>
</SearchParams>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SearchParams'.

Response Information

ShipmentSummary

Response body formats

application/json, text/json

Sample:

{
  "SummmaryList": {
    "$id": "2",
    "$values": [
      {
        "$id": "3",
        "QuickSaleSummaryId": "7f71f11c-1b7e-49dc-b5d0-eea8a7a4e383",
        "TrackingId": "sample string 2",
        "ShippingDateTime": "2025-05-09T20:09:43.9732938+00:00",
        "Direction": "sample string 4",
        "Type": "sample string 5",
        "RecipientId": "e114734d-a8cb-4153-a9a9-f4d9cad69364",
        "RecipientCity": "sample string 6",
        "RecipientCountryId": "sample string 7",
        "RecipientName": "sample string 8",
        "RecipientCompany": "sample string 9",
        "ShipperCity": "sample string 10",
        "ShipperCountryId": "sample string 11",
        "ShipperName": "sample string 12",
        "ShipperCompany": "sample string 13",
        "Carrier": "sample string 14",
        "Service": "sample string 15",
        "Status": "sample string 16",
        "DeliverArrivedDatetime": "2025-05-09T20:09:43.9732938+00:00",
        "SalesOrderId": "sample string 18",
        "CreatedBy": "sample string 19",
        "CreatedOn": "2025-05-09T20:09:43.9732938+00:00",
        "TenantId": "sample string 21",
        "LastModifiedBy": "sample string 22",
        "LastModifiedOn": "2025-05-09T20:09:43.9732938+00:00"
      },
      {
        "$ref": "3"
      },
      {
        "$ref": "3"
      }
    ]
  },
  "TotalRecord": 1
}

application/xml, text/xml

Sample:

<ShipmentSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data.Shipment">
  <SummmaryList xmlns:d2p1="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data.QuickSale">
    <d2p1:QuickSaleSummary>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 19</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</CreatedOn>
      <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 22</LastModifiedBy>
      <LastModifiedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</LastModifiedOn>
      <TenantId xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 21</TenantId>
      <d2p1:Carrier>sample string 14</d2p1:Carrier>
      <d2p1:DeliverArrivedDatetime>2025-05-09T20:09:43.9732938+00:00</d2p1:DeliverArrivedDatetime>
      <d2p1:Direction>sample string 4</d2p1:Direction>
      <d2p1:QuickSaleSummaryId>7f71f11c-1b7e-49dc-b5d0-eea8a7a4e383</d2p1:QuickSaleSummaryId>
      <d2p1:RecipientCity>sample string 6</d2p1:RecipientCity>
      <d2p1:RecipientCompany>sample string 9</d2p1:RecipientCompany>
      <d2p1:RecipientCountryId>sample string 7</d2p1:RecipientCountryId>
      <d2p1:RecipientId>e114734d-a8cb-4153-a9a9-f4d9cad69364</d2p1:RecipientId>
      <d2p1:RecipientName>sample string 8</d2p1:RecipientName>
      <d2p1:SalesOrderId>sample string 18</d2p1:SalesOrderId>
      <d2p1:Service>sample string 15</d2p1:Service>
      <d2p1:ShipperCity>sample string 10</d2p1:ShipperCity>
      <d2p1:ShipperCompany>sample string 13</d2p1:ShipperCompany>
      <d2p1:ShipperCountryId>sample string 11</d2p1:ShipperCountryId>
      <d2p1:ShipperName>sample string 12</d2p1:ShipperName>
      <d2p1:ShippingDateTime>2025-05-09T20:09:43.9732938+00:00</d2p1:ShippingDateTime>
      <d2p1:Status>sample string 16</d2p1:Status>
      <d2p1:TrackingId>sample string 2</d2p1:TrackingId>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:QuickSaleSummary>
    <d2p1:QuickSaleSummary>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 19</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</CreatedOn>
      <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 22</LastModifiedBy>
      <LastModifiedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</LastModifiedOn>
      <TenantId xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 21</TenantId>
      <d2p1:Carrier>sample string 14</d2p1:Carrier>
      <d2p1:DeliverArrivedDatetime>2025-05-09T20:09:43.9732938+00:00</d2p1:DeliverArrivedDatetime>
      <d2p1:Direction>sample string 4</d2p1:Direction>
      <d2p1:QuickSaleSummaryId>7f71f11c-1b7e-49dc-b5d0-eea8a7a4e383</d2p1:QuickSaleSummaryId>
      <d2p1:RecipientCity>sample string 6</d2p1:RecipientCity>
      <d2p1:RecipientCompany>sample string 9</d2p1:RecipientCompany>
      <d2p1:RecipientCountryId>sample string 7</d2p1:RecipientCountryId>
      <d2p1:RecipientId>e114734d-a8cb-4153-a9a9-f4d9cad69364</d2p1:RecipientId>
      <d2p1:RecipientName>sample string 8</d2p1:RecipientName>
      <d2p1:SalesOrderId>sample string 18</d2p1:SalesOrderId>
      <d2p1:Service>sample string 15</d2p1:Service>
      <d2p1:ShipperCity>sample string 10</d2p1:ShipperCity>
      <d2p1:ShipperCompany>sample string 13</d2p1:ShipperCompany>
      <d2p1:ShipperCountryId>sample string 11</d2p1:ShipperCountryId>
      <d2p1:ShipperName>sample string 12</d2p1:ShipperName>
      <d2p1:ShippingDateTime>2025-05-09T20:09:43.9732938+00:00</d2p1:ShippingDateTime>
      <d2p1:Status>sample string 16</d2p1:Status>
      <d2p1:TrackingId>sample string 2</d2p1:TrackingId>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:QuickSaleSummary>
    <d2p1:QuickSaleSummary>
      <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 19</CreatedBy>
      <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</CreatedOn>
      <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 22</LastModifiedBy>
      <LastModifiedOn xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">2025-05-09T20:09:43.9732938+00:00</LastModifiedOn>
      <TenantId xmlns="http://schemas.datacontract.org/2004/07/EdgeQuickSale.Data">sample string 21</TenantId>
      <d2p1:Carrier>sample string 14</d2p1:Carrier>
      <d2p1:DeliverArrivedDatetime>2025-05-09T20:09:43.9732938+00:00</d2p1:DeliverArrivedDatetime>
      <d2p1:Direction>sample string 4</d2p1:Direction>
      <d2p1:QuickSaleSummaryId>7f71f11c-1b7e-49dc-b5d0-eea8a7a4e383</d2p1:QuickSaleSummaryId>
      <d2p1:RecipientCity>sample string 6</d2p1:RecipientCity>
      <d2p1:RecipientCompany>sample string 9</d2p1:RecipientCompany>
      <d2p1:RecipientCountryId>sample string 7</d2p1:RecipientCountryId>
      <d2p1:RecipientId>e114734d-a8cb-4153-a9a9-f4d9cad69364</d2p1:RecipientId>
      <d2p1:RecipientName>sample string 8</d2p1:RecipientName>
      <d2p1:SalesOrderId>sample string 18</d2p1:SalesOrderId>
      <d2p1:Service>sample string 15</d2p1:Service>
      <d2p1:ShipperCity>sample string 10</d2p1:ShipperCity>
      <d2p1:ShipperCompany>sample string 13</d2p1:ShipperCompany>
      <d2p1:ShipperCountryId>sample string 11</d2p1:ShipperCountryId>
      <d2p1:ShipperName>sample string 12</d2p1:ShipperName>
      <d2p1:ShippingDateTime>2025-05-09T20:09:43.9732938+00:00</d2p1:ShippingDateTime>
      <d2p1:Status>sample string 16</d2p1:Status>
      <d2p1:TrackingId>sample string 2</d2p1:TrackingId>
      <d2p1:Type>sample string 5</d2p1:Type>
    </d2p1:QuickSaleSummary>
  </SummmaryList>
  <TotalRecord>1</TotalRecord>
</ShipmentSummary>