POST api/Shipment/Add

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
TrackingCode	string	None.
TrackingWebsite	string	None.
sRemarks	string	None.
CreatedAt	date	None.
UpdatedAt	date	None.
CreatedByUserID	integer	None.
dtDate	date	None.
dtDateString	string	None.
OutletID	integer	None.
ShippingMethodID	integer	None.
IsActive	boolean	None.
IsReceived	boolean	None.
ToOutletID	integer	None.
ReceivedDate	date	None.
Outlet	string	None.
Outlet1	string	None.
ShippingMethod	string	None.
ShipmentDetails	Collection of ShipmentDetailModel	None.
ShipmentDocuments	Collection of ShipmentDocumentModel	None.
Attachments	Collection of ImageModel	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "TrackingCode": "sample string 2",
  "TrackingWebsite": "sample string 3",
  "sRemarks": "sample string 4",
  "CreatedAt": "2025-01-22T21:04:40.5912805-06:00",
  "UpdatedAt": "2025-01-22T21:04:40.5912805-06:00",
  "CreatedByUserID": 1,
  "dtDate": "2025-01-22T21:04:40.5912805-06:00",
  "dtDateString": "sample string 5",
  "OutletID": 1,
  "ShippingMethodID": 1,
  "IsActive": true,
  "IsReceived": true,
  "ToOutletID": 1,
  "ReceivedDate": "2025-01-22T21:04:40.5912805-06:00",
  "Outlet": "sample string 6",
  "Outlet1": "sample string 7",
  "ShippingMethod": "sample string 8",
  "ShipmentDetails": [
    {
      "ID": 1,
      "ShipmentID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "Quantity": 1,
      "ReceivedQuantity": 1,
      "ProductModel": "sample string 2",
      "ArticalNo": "sample string 3",
      "BLabel": "sample string 4",
      "IsTrackable": true,
      "CurrencyID": 1,
      "Price": 1.0,
      "Product": "sample string 5",
      "ProductVariant": "sample string 6"
    },
    {
      "ID": 1,
      "ShipmentID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "Quantity": 1,
      "ReceivedQuantity": 1,
      "ProductModel": "sample string 2",
      "ArticalNo": "sample string 3",
      "BLabel": "sample string 4",
      "IsTrackable": true,
      "CurrencyID": 1,
      "Price": 1.0,
      "Product": "sample string 5",
      "ProductVariant": "sample string 6"
    }
  ],
  "ShipmentDocuments": [
    {
      "ID": 1,
      "sDocument": "sample string 2",
      "ShipmentID": 1,
      "IsActive": true,
      "CreatedAt": "2025-01-22T21:04:40.5912805-06:00"
    },
    {
      "ID": 1,
      "sDocument": "sample string 2",
      "ShipmentID": 1,
      "IsActive": true,
      "CreatedAt": "2025-01-22T21:04:40.5912805-06:00"
    }
  ],
  "Attachments": [
    {
      "Base64String": "sample string 1",
      "Extention": "sample string 2"
    },
    {
      "Base64String": "sample string 1",
      "Extention": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<ShipmentModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <Attachments>
    <ImageModel>
      <Base64String>sample string 1</Base64String>
      <Extention>sample string 2</Extention>
    </ImageModel>
    <ImageModel>
      <Base64String>sample string 1</Base64String>
      <Extention>sample string 2</Extention>
    </ImageModel>
  </Attachments>
  <CreatedAt>2025-01-22T21:04:40.5912805-06:00</CreatedAt>
  <CreatedByUserID>1</CreatedByUserID>
  <ID>1</ID>
  <IsActive>true</IsActive>
  <IsReceived>true</IsReceived>
  <Outlet>sample string 6</Outlet>
  <Outlet1>sample string 7</Outlet1>
  <OutletID>1</OutletID>
  <ReceivedDate>2025-01-22T21:04:40.5912805-06:00</ReceivedDate>
  <ShipmentDetails>
    <ShipmentDetailModel>
      <ArticalNo>sample string 3</ArticalNo>
      <BLabel>sample string 4</BLabel>
      <CurrencyID>1</CurrencyID>
      <ID>1</ID>
      <IsTrackable>true</IsTrackable>
      <Price>1</Price>
      <Product>sample string 5</Product>
      <ProductID>1</ProductID>
      <ProductModel>sample string 2</ProductModel>
      <ProductVariant>sample string 6</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <Quantity>1</Quantity>
      <ReceivedQuantity>1</ReceivedQuantity>
      <ShipmentID>1</ShipmentID>
    </ShipmentDetailModel>
    <ShipmentDetailModel>
      <ArticalNo>sample string 3</ArticalNo>
      <BLabel>sample string 4</BLabel>
      <CurrencyID>1</CurrencyID>
      <ID>1</ID>
      <IsTrackable>true</IsTrackable>
      <Price>1</Price>
      <Product>sample string 5</Product>
      <ProductID>1</ProductID>
      <ProductModel>sample string 2</ProductModel>
      <ProductVariant>sample string 6</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <Quantity>1</Quantity>
      <ReceivedQuantity>1</ReceivedQuantity>
      <ShipmentID>1</ShipmentID>
    </ShipmentDetailModel>
  </ShipmentDetails>
  <ShipmentDocuments>
    <ShipmentDocumentModel>
      <CreatedAt>2025-01-22T21:04:40.5912805-06:00</CreatedAt>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <ShipmentID>1</ShipmentID>
      <sDocument>sample string 2</sDocument>
    </ShipmentDocumentModel>
    <ShipmentDocumentModel>
      <CreatedAt>2025-01-22T21:04:40.5912805-06:00</CreatedAt>
      <ID>1</ID>
      <IsActive>true</IsActive>
      <ShipmentID>1</ShipmentID>
      <sDocument>sample string 2</sDocument>
    </ShipmentDocumentModel>
  </ShipmentDocuments>
  <ShippingMethod>sample string 8</ShippingMethod>
  <ShippingMethodID>1</ShippingMethodID>
  <ToOutletID>1</ToOutletID>
  <TrackingCode>sample string 2</TrackingCode>
  <TrackingWebsite>sample string 3</TrackingWebsite>
  <UpdatedAt>2025-01-22T21:04:40.5912805-06:00</UpdatedAt>
  <dtDate>2025-01-22T21:04:40.5912805-06:00</dtDate>
  <dtDateString>sample string 5</dtDateString>
  <sRemarks>sample string 4</sRemarks>
</ShipmentModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ShipmentResponse

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

Response Formats

application/json, text/json

Sample:

{
  "ShipmentModel": {
    "ID": 1,
    "TrackingCode": "sample string 2",
    "TrackingWebsite": "sample string 3",
    "sRemarks": "sample string 4",
    "CreatedAt": "2025-01-22T21:04:40.5912805-06:00",
    "UpdatedAt": "2025-01-22T21:04:40.5912805-06:00",
    "CreatedByUserID": 1,
    "dtDate": "2025-01-22T21:04:40.5912805-06:00",
    "dtDateString": "sample string 5",
    "OutletID": 1,
    "ShippingMethodID": 1,
    "IsActive": true,
    "IsReceived": true,
    "ToOutletID": 1,
    "ReceivedDate": "2025-01-22T21:04:40.5912805-06:00",
    "Outlet": "sample string 6",
    "Outlet1": "sample string 7",
    "ShippingMethod": "sample string 8",
    "ShipmentDetails": [
      {
        "ID": 1,
        "ShipmentID": 1,
        "ProductID": 1,
        "ProductVariantID": 1,
        "Quantity": 1,
        "ReceivedQuantity": 1,
        "ProductModel": "sample string 2",
        "ArticalNo": "sample string 3",
        "BLabel": "sample string 4",
        "IsTrackable": true,
        "CurrencyID": 1,
        "Price": 1.0,
        "Product": "sample string 5",
        "ProductVariant": "sample string 6"
      },
      {
        "ID": 1,
        "ShipmentID": 1,
        "ProductID": 1,
        "ProductVariantID": 1,
        "Quantity": 1,
        "ReceivedQuantity": 1,
        "ProductModel": "sample string 2",
        "ArticalNo": "sample string 3",
        "BLabel": "sample string 4",
        "IsTrackable": true,
        "CurrencyID": 1,
        "Price": 1.0,
        "Product": "sample string 5",
        "ProductVariant": "sample string 6"
      }
    ],
    "ShipmentDocuments": [
      {
        "ID": 1,
        "sDocument": "sample string 2",
        "ShipmentID": 1,
        "IsActive": true,
        "CreatedAt": "2025-01-22T21:04:40.5912805-06:00"
      },
      {
        "ID": 1,
        "sDocument": "sample string 2",
        "ShipmentID": 1,
        "IsActive": true,
        "CreatedAt": "2025-01-22T21:04:40.5912805-06:00"
      }
    ],
    "Attachments": [
      {
        "Base64String": "sample string 1",
        "Extention": "sample string 2"
      },
      {
        "Base64String": "sample string 1",
        "Extention": "sample string 2"
      }
    ]
  },
  "ResponseCode": 1,
  "ResponseText": "sample string 2"
}

application/xml, text/xml

Sample:

<ShipmentResponse 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>
  <ShipmentModel xmlns:d2p1="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
    <d2p1:Attachments>
      <d2p1:ImageModel>
        <d2p1:Base64String>sample string 1</d2p1:Base64String>
        <d2p1:Extention>sample string 2</d2p1:Extention>
      </d2p1:ImageModel>
      <d2p1:ImageModel>
        <d2p1:Base64String>sample string 1</d2p1:Base64String>
        <d2p1:Extention>sample string 2</d2p1:Extention>
      </d2p1:ImageModel>
    </d2p1:Attachments>
    <d2p1:CreatedAt>2025-01-22T21:04:40.5912805-06:00</d2p1:CreatedAt>
    <d2p1:CreatedByUserID>1</d2p1:CreatedByUserID>
    <d2p1:ID>1</d2p1:ID>
    <d2p1:IsActive>true</d2p1:IsActive>
    <d2p1:IsReceived>true</d2p1:IsReceived>
    <d2p1:Outlet>sample string 6</d2p1:Outlet>
    <d2p1:Outlet1>sample string 7</d2p1:Outlet1>
    <d2p1:OutletID>1</d2p1:OutletID>
    <d2p1:ReceivedDate>2025-01-22T21:04:40.5912805-06:00</d2p1:ReceivedDate>
    <d2p1:ShipmentDetails>
      <d2p1:ShipmentDetailModel>
        <d2p1:ArticalNo>sample string 3</d2p1:ArticalNo>
        <d2p1:BLabel>sample string 4</d2p1:BLabel>
        <d2p1:CurrencyID>1</d2p1:CurrencyID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsTrackable>true</d2p1:IsTrackable>
        <d2p1:Price>1</d2p1:Price>
        <d2p1:Product>sample string 5</d2p1:Product>
        <d2p1:ProductID>1</d2p1:ProductID>
        <d2p1:ProductModel>sample string 2</d2p1:ProductModel>
        <d2p1:ProductVariant>sample string 6</d2p1:ProductVariant>
        <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
        <d2p1:Quantity>1</d2p1:Quantity>
        <d2p1:ReceivedQuantity>1</d2p1:ReceivedQuantity>
        <d2p1:ShipmentID>1</d2p1:ShipmentID>
      </d2p1:ShipmentDetailModel>
      <d2p1:ShipmentDetailModel>
        <d2p1:ArticalNo>sample string 3</d2p1:ArticalNo>
        <d2p1:BLabel>sample string 4</d2p1:BLabel>
        <d2p1:CurrencyID>1</d2p1:CurrencyID>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsTrackable>true</d2p1:IsTrackable>
        <d2p1:Price>1</d2p1:Price>
        <d2p1:Product>sample string 5</d2p1:Product>
        <d2p1:ProductID>1</d2p1:ProductID>
        <d2p1:ProductModel>sample string 2</d2p1:ProductModel>
        <d2p1:ProductVariant>sample string 6</d2p1:ProductVariant>
        <d2p1:ProductVariantID>1</d2p1:ProductVariantID>
        <d2p1:Quantity>1</d2p1:Quantity>
        <d2p1:ReceivedQuantity>1</d2p1:ReceivedQuantity>
        <d2p1:ShipmentID>1</d2p1:ShipmentID>
      </d2p1:ShipmentDetailModel>
    </d2p1:ShipmentDetails>
    <d2p1:ShipmentDocuments>
      <d2p1:ShipmentDocumentModel>
        <d2p1:CreatedAt>2025-01-22T21:04:40.5912805-06:00</d2p1:CreatedAt>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ShipmentID>1</d2p1:ShipmentID>
        <d2p1:sDocument>sample string 2</d2p1:sDocument>
      </d2p1:ShipmentDocumentModel>
      <d2p1:ShipmentDocumentModel>
        <d2p1:CreatedAt>2025-01-22T21:04:40.5912805-06:00</d2p1:CreatedAt>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:IsActive>true</d2p1:IsActive>
        <d2p1:ShipmentID>1</d2p1:ShipmentID>
        <d2p1:sDocument>sample string 2</d2p1:sDocument>
      </d2p1:ShipmentDocumentModel>
    </d2p1:ShipmentDocuments>
    <d2p1:ShippingMethod>sample string 8</d2p1:ShippingMethod>
    <d2p1:ShippingMethodID>1</d2p1:ShippingMethodID>
    <d2p1:ToOutletID>1</d2p1:ToOutletID>
    <d2p1:TrackingCode>sample string 2</d2p1:TrackingCode>
    <d2p1:TrackingWebsite>sample string 3</d2p1:TrackingWebsite>
    <d2p1:UpdatedAt>2025-01-22T21:04:40.5912805-06:00</d2p1:UpdatedAt>
    <d2p1:dtDate>2025-01-22T21:04:40.5912805-06:00</d2p1:dtDate>
    <d2p1:dtDateString>sample string 5</d2p1:dtDateString>
    <d2p1:sRemarks>sample string 4</d2p1:sRemarks>
  </ShipmentModel>
</ShipmentResponse>