POST api/Report/GetShipmentDeliveryReport

Request Information

URI Parameters

None.

Body Parameters

ShipmentReportFilterModel
NameDescriptionTypeAdditional information
ShipmentID

integer

None.

IsGetAll

boolean

None.

TrackingCode

string

None.

PageSize

integer

None.

PageNo

integer

None.

RequestedUserID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ShipmentID": 1,
  "IsGetAll": true,
  "TrackingCode": "sample string 2",
  "PageSize": 3,
  "PageNo": 4,
  "RequestedUserID": 1
}

application/xml, text/xml

Sample:
<ShipmentReportFilterModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <RequestedUserID xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">1</RequestedUserID>
  <IsGetAll>true</IsGetAll>
  <PageNo>4</PageNo>
  <PageSize>3</PageSize>
  <ShipmentID>1</ShipmentID>
  <TrackingCode>sample string 2</TrackingCode>
</ShipmentReportFilterModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetShipmentDeliveryReportResponse
NameDescriptionTypeAdditional information
OutletStockHistoryReturnTransferDetails

Collection of OutletStockHistoryReturnTransferDetailModel

None.

ResponseCode

integer

None.

ResponseText

string

None.

Response Formats

application/json, text/json

Sample:
{
  "OutletStockHistoryReturnTransferDetails": [
    {
      "ID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "StockHistoryID": 1,
      "TotalQuantity": 1,
      "PurchasePrice": 1.0,
      "SalePrice": 1.0,
      "CreatedAt": "2025-01-22T20:48:10.5947406-06:00",
      "UpdatedAt": "2025-01-22T20:48:10.5947406-06:00",
      "CreatedByID": 1,
      "OutletStockHistoryID": 1,
      "PurchaseID": 1,
      "ShipmentDetailID": 1,
      "TrackingCode": "sample string 2",
      "Product": "sample string 3",
      "ProductVariant": "sample string 4"
    },
    {
      "ID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "StockHistoryID": 1,
      "TotalQuantity": 1,
      "PurchasePrice": 1.0,
      "SalePrice": 1.0,
      "CreatedAt": "2025-01-22T20:48:10.5947406-06:00",
      "UpdatedAt": "2025-01-22T20:48:10.5947406-06:00",
      "CreatedByID": 1,
      "OutletStockHistoryID": 1,
      "PurchaseID": 1,
      "ShipmentDetailID": 1,
      "TrackingCode": "sample string 2",
      "Product": "sample string 3",
      "ProductVariant": "sample string 4"
    }
  ],
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:
<GetShipmentDeliveryReportResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Response">
  <ResponseCode xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">1</ResponseCode>
  <ResponseText xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">sample string 2</ResponseText>
  <OutletStockHistoryReturnTransferDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
    <d2p1:OutletStockHistoryReturnTransferDetailModel>
      <d2p1:CreatedAt>2025-01-22T20:48:10.5947406-06:00</d2p1:CreatedAt>
      <d2p1:CreatedByID>1</d2p1:CreatedByID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:OutletStockHistoryID>1</d2p1:OutletStockHistoryID>
      <d2p1:Product>sample string 3</d2p1:Product>
      <d2p1:ProductID>1</d2p1:ProductID>
      <d2p1:ProductVariant>sample string 4</d2p1:ProductVariant>
      <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
      <d2p1:PurchaseID>1</d2p1:PurchaseID>
      <d2p1:PurchasePrice>1</d2p1:PurchasePrice>
      <d2p1:SalePrice>1</d2p1:SalePrice>
      <d2p1:ShipmentDetailID>1</d2p1:ShipmentDetailID>
      <d2p1:StockHistoryID>1</d2p1:StockHistoryID>
      <d2p1:TotalQuantity>1</d2p1:TotalQuantity>
      <d2p1:TrackingCode>sample string 2</d2p1:TrackingCode>
      <d2p1:UpdatedAt>2025-01-22T20:48:10.5947406-06:00</d2p1:UpdatedAt>
    </d2p1:OutletStockHistoryReturnTransferDetailModel>
    <d2p1:OutletStockHistoryReturnTransferDetailModel>
      <d2p1:CreatedAt>2025-01-22T20:48:10.5947406-06:00</d2p1:CreatedAt>
      <d2p1:CreatedByID>1</d2p1:CreatedByID>
      <d2p1:ID>1</d2p1:ID>
      <d2p1:OutletStockHistoryID>1</d2p1:OutletStockHistoryID>
      <d2p1:Product>sample string 3</d2p1:Product>
      <d2p1:ProductID>1</d2p1:ProductID>
      <d2p1:ProductVariant>sample string 4</d2p1:ProductVariant>
      <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
      <d2p1:PurchaseID>1</d2p1:PurchaseID>
      <d2p1:PurchasePrice>1</d2p1:PurchasePrice>
      <d2p1:SalePrice>1</d2p1:SalePrice>
      <d2p1:ShipmentDetailID>1</d2p1:ShipmentDetailID>
      <d2p1:StockHistoryID>1</d2p1:StockHistoryID>
      <d2p1:TotalQuantity>1</d2p1:TotalQuantity>
      <d2p1:TrackingCode>sample string 2</d2p1:TrackingCode>
      <d2p1:UpdatedAt>2025-01-22T20:48:10.5947406-06:00</d2p1:UpdatedAt>
    </d2p1:OutletStockHistoryReturnTransferDetailModel>
  </OutletStockHistoryReturnTransferDetails>
</GetShipmentDeliveryReportResponse>