POST api/Shipment/AddShipmentDelivery

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ShipmentID	integer	None.
TrackingCode	string	None.
OutletID	integer	None.
ToOutletID	integer	None.
CreatedByUserID	integer	None.
ReceivingDate	date	None.
ShipmentDeliveryItems	Collection of ShipmentDeliveryItem	None.
RequestedUserID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "ShipmentID": 1,
  "TrackingCode": "sample string 1",
  "OutletID": 2,
  "ToOutletID": 3,
  "CreatedByUserID": 4,
  "ReceivingDate": "2025-01-22T20:47:28.099173-06:00",
  "ShipmentDeliveryItems": [
    {
      "ShipmentDetailID": 1,
      "ProductID": 1,
      "ProductVariantID": 2,
      "Quantity": 3,
      "OutletStockHistoryID": 4,
      "StockHistoryID": 5,
      "AllTrackableOutletAssignmentItemDetailList": [
        {
          "TrackableForShoppingID": 1
        },
        {
          "TrackableForShoppingID": 1
        }
      ]
    },
    {
      "ShipmentDetailID": 1,
      "ProductID": 1,
      "ProductVariantID": 2,
      "Quantity": 3,
      "OutletStockHistoryID": 4,
      "StockHistoryID": 5,
      "AllTrackableOutletAssignmentItemDetailList": [
        {
          "TrackableForShoppingID": 1
        },
        {
          "TrackableForShoppingID": 1
        }
      ]
    }
  ],
  "RequestedUserID": 1
}

application/xml, text/xml

Sample:

<ShipmentDeliveryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.Request">
  <RequestedUserID>1</RequestedUserID>
  <CreatedByUserID>4</CreatedByUserID>
  <OutletID>2</OutletID>
  <ReceivingDate>2025-01-22T20:47:28.099173-06:00</ReceivingDate>
  <ShipmentDeliveryItems>
    <ShipmentDeliveryItem>
      <AllTrackableOutletAssignmentItemDetailList xmlns:d4p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
        <d4p1:TrackableOutletAssignmentItemDetail>
          <d4p1:TrackableForShoppingID>1</d4p1:TrackableForShoppingID>
        </d4p1:TrackableOutletAssignmentItemDetail>
        <d4p1:TrackableOutletAssignmentItemDetail>
          <d4p1:TrackableForShoppingID>1</d4p1:TrackableForShoppingID>
        </d4p1:TrackableOutletAssignmentItemDetail>
      </AllTrackableOutletAssignmentItemDetailList>
      <OutletStockHistoryID>4</OutletStockHistoryID>
      <ProductID>1</ProductID>
      <ProductVariantID>2</ProductVariantID>
      <Quantity>3</Quantity>
      <ShipmentDetailID>1</ShipmentDetailID>
      <StockHistoryID>5</StockHistoryID>
    </ShipmentDeliveryItem>
    <ShipmentDeliveryItem>
      <AllTrackableOutletAssignmentItemDetailList xmlns:d4p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
        <d4p1:TrackableOutletAssignmentItemDetail>
          <d4p1:TrackableForShoppingID>1</d4p1:TrackableForShoppingID>
        </d4p1:TrackableOutletAssignmentItemDetail>
        <d4p1:TrackableOutletAssignmentItemDetail>
          <d4p1:TrackableForShoppingID>1</d4p1:TrackableForShoppingID>
        </d4p1:TrackableOutletAssignmentItemDetail>
      </AllTrackableOutletAssignmentItemDetailList>
      <OutletStockHistoryID>4</OutletStockHistoryID>
      <ProductID>1</ProductID>
      <ProductVariantID>2</ProductVariantID>
      <Quantity>3</Quantity>
      <ShipmentDetailID>1</ShipmentDetailID>
      <StockHistoryID>5</StockHistoryID>
    </ShipmentDeliveryItem>
  </ShipmentDeliveryItems>
  <ShipmentID>1</ShipmentID>
  <ToOutletID>3</ToOutletID>
  <TrackingCode>sample string 1</TrackingCode>
</ShipmentDeliveryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseDetail

Name	Description	Type	Additional information
ResponseCode		integer	None.
ResponseText		string	None.

Response Formats

application/json, text/json

Sample:

{
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <ResponseCode>1</ResponseCode>
  <ResponseText>sample string 2</ResponseText>
</ResponseDetail>