POST api/Sale/AddOnlineOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ID	integer	None.
CustomerID	integer	None.
SaleDate	date	None.
DueDate	date	None.
PaymentModeID	integer	None.
dDiscountPercentage	decimal number	None.
dDiscountValue	decimal number	None.
dTotalSaleValue	decimal number	None.
dTotalPaidValue	decimal number	None.
dDiscountValueString	string	None.
dTotalSaleValueString	string	None.
dTotalPaidValueString	string	None.
ReturnedTyped	integer	None.
IsReturned	boolean	None.
IsOnlineOrder	boolean	None.
IsPrinted	boolean	None.
IsLabelCreated	boolean	None.
sRemarks	string	None.
CreatedAt	date	None.
UpdatedAt	date	None.
CreatedByUserID	integer	None.
dtDate	date	None.
CreatedAtString	string	None.
CashRegisterHistoryID	integer	None.
OutletID	integer	None.
CashRegister	string	None.
Outlet	string	None.
IsAssignedToDeliveryPerson	boolean	None.
Customer	string	None.
PaymentMode	string	None.
isReturnVisible	string	None.
SaleDetails	Collection of SaleDetailModel	None.
IsInvoiceCreated	boolean	None.
IsTraceable	boolean	None.
IsRefundable	boolean	None.
IsShipped	boolean	None.
PaymentConditionID	integer	None.
PaymentCondition	string	None.
DeliveredToID	integer	None.
DeliveredTo	string	None.
TypeID	integer	None.
Type	string	None.
ShippingMethodID	integer	None.
ShippingCost	decimal number	None.
ShippingMethod	string	None.
SaleInvoiceNo	string	None.
DeliveryAddressID	integer	None.
SlipUrl	string	None.
InvoiceUrl	string	None.
DeliveryAddress	string	None.
InvoiceAddressID	integer	None.
InvoiceAddress	string	None.
NGB	decimal number	None.
PerfomaSaleID	integer	None.
IsFromPerfomaSale	boolean	None.
isInvoiceSelected	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "CustomerID": 1,
  "SaleDate": "2025-01-22T20:52:58.9995325-06:00",
  "DueDate": "2025-01-22T20:52:58.9995325-06:00",
  "PaymentModeID": 1,
  "dDiscountPercentage": 1.0,
  "dDiscountValue": 1.0,
  "dTotalSaleValue": 1.0,
  "dTotalPaidValue": 1.0,
  "dDiscountValueString": "sample string 2",
  "dTotalSaleValueString": "sample string 3",
  "dTotalPaidValueString": "sample string 4",
  "ReturnedTyped": 1,
  "IsReturned": true,
  "IsOnlineOrder": true,
  "IsPrinted": true,
  "IsLabelCreated": true,
  "sRemarks": "sample string 5",
  "CreatedAt": "2025-01-22T20:52:58.9995325-06:00",
  "UpdatedAt": "2025-01-22T20:52:58.9995325-06:00",
  "CreatedByUserID": 1,
  "dtDate": "2025-01-22T20:52:58.9995325-06:00",
  "CreatedAtString": "sample string 6",
  "CashRegisterHistoryID": 1,
  "OutletID": 1,
  "CashRegister": "sample string 7",
  "Outlet": "sample string 8",
  "IsAssignedToDeliveryPerson": true,
  "Customer": "sample string 9",
  "PaymentMode": "sample string 10",
  "isReturnVisible": "sample string 11",
  "SaleDetails": [
    {
      "ID": 1,
      "SaleID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "Quantity": 1,
      "TaxAmount": 1.0,
      "dTotalValue": 1.0,
      "dTotalDiscount": 1.0,
      "ReturnedTyped": 1,
      "IsReturned": true,
      "ReturnedQuantity": 1,
      "Keenland": "sample string 2",
      "IsKeenlandExists": true,
      "TaxPer": 1.0,
      "dTotalUnitValue": 1.0,
      "dDiscountPer": 1.0,
      "Product": "sample string 3",
      "ProductVariant": "sample string 4",
      "ProductPrice": 1.0,
      "ProductPriceString": "sample string 5",
      "isReturnProductChecked": true,
      "ProductVarientBarCode": "sample string 7",
      "ProductQRCode": "sample string 8",
      "BLabel": "sample string 9",
      "ProductImage": "sample string 10",
      "TrackableProductsSaleDetails": [
        {
          "ID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "SaleDetailID": 1,
          "TrackableCode": "sample string 2",
          "IsReturned": true,
          "CreatedAt": "2025-01-22T20:52:58.9995325-06:00",
          "Product": "sample string 3",
          "ProductVariant": "sample string 4"
        },
        {
          "ID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "SaleDetailID": 1,
          "TrackableCode": "sample string 2",
          "IsReturned": true,
          "CreatedAt": "2025-01-22T20:52:58.9995325-06:00",
          "Product": "sample string 3",
          "ProductVariant": "sample string 4"
        }
      ],
      "SaleDetailNonTrackableLocations": [
        {
          "ID": 1,
          "SaleDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2",
          "NonTrackableProductsLocationID": 1
        },
        {
          "ID": 1,
          "SaleDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2",
          "NonTrackableProductsLocationID": 1
        }
      ],
      "dTotalAmount": 1.0,
      "OriginalQuantity": 1,
      "ManufacturerCode": "sample string 11"
    },
    {
      "ID": 1,
      "SaleID": 1,
      "ProductID": 1,
      "ProductVariantID": 1,
      "Quantity": 1,
      "TaxAmount": 1.0,
      "dTotalValue": 1.0,
      "dTotalDiscount": 1.0,
      "ReturnedTyped": 1,
      "IsReturned": true,
      "ReturnedQuantity": 1,
      "Keenland": "sample string 2",
      "IsKeenlandExists": true,
      "TaxPer": 1.0,
      "dTotalUnitValue": 1.0,
      "dDiscountPer": 1.0,
      "Product": "sample string 3",
      "ProductVariant": "sample string 4",
      "ProductPrice": 1.0,
      "ProductPriceString": "sample string 5",
      "isReturnProductChecked": true,
      "ProductVarientBarCode": "sample string 7",
      "ProductQRCode": "sample string 8",
      "BLabel": "sample string 9",
      "ProductImage": "sample string 10",
      "TrackableProductsSaleDetails": [
        {
          "ID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "SaleDetailID": 1,
          "TrackableCode": "sample string 2",
          "IsReturned": true,
          "CreatedAt": "2025-01-22T20:52:58.9995325-06:00",
          "Product": "sample string 3",
          "ProductVariant": "sample string 4"
        },
        {
          "ID": 1,
          "ProductID": 1,
          "ProductVariantID": 1,
          "SaleDetailID": 1,
          "TrackableCode": "sample string 2",
          "IsReturned": true,
          "CreatedAt": "2025-01-22T20:52:58.9995325-06:00",
          "Product": "sample string 3",
          "ProductVariant": "sample string 4"
        }
      ],
      "SaleDetailNonTrackableLocations": [
        {
          "ID": 1,
          "SaleDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2",
          "NonTrackableProductsLocationID": 1
        },
        {
          "ID": 1,
          "SaleDetailID": 1,
          "LevelID": 1,
          "Quantity": 1,
          "Location": "sample string 2",
          "NonTrackableProductsLocationID": 1
        }
      ],
      "dTotalAmount": 1.0,
      "OriginalQuantity": 1,
      "ManufacturerCode": "sample string 11"
    }
  ],
  "IsInvoiceCreated": true,
  "IsTraceable": true,
  "IsRefundable": true,
  "IsShipped": true,
  "PaymentConditionID": 1,
  "PaymentCondition": "sample string 12",
  "DeliveredToID": 1,
  "DeliveredTo": "sample string 13",
  "TypeID": 1,
  "Type": "sample string 14",
  "ShippingMethodID": 1,
  "ShippingCost": 1.0,
  "ShippingMethod": "sample string 15",
  "SaleInvoiceNo": "sample string 16",
  "DeliveryAddressID": 1,
  "SlipUrl": "sample string 17",
  "InvoiceUrl": "sample string 18",
  "DeliveryAddress": "sample string 19",
  "InvoiceAddressID": 1,
  "InvoiceAddress": "sample string 20",
  "NGB": 21.0,
  "PerfomaSaleID": 1,
  "IsFromPerfomaSale": true,
  "isInvoiceSelected": true
}

application/xml, text/xml

Sample:

<SaleModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <CashRegister>sample string 7</CashRegister>
  <CashRegisterHistoryID>1</CashRegisterHistoryID>
  <CreatedAt>2025-01-22T20:52:58.9995325-06:00</CreatedAt>
  <CreatedAtString>sample string 6</CreatedAtString>
  <CreatedByUserID>1</CreatedByUserID>
  <Customer>sample string 9</Customer>
  <CustomerID>1</CustomerID>
  <DeliveredTo>sample string 13</DeliveredTo>
  <DeliveredToID>1</DeliveredToID>
  <DeliveryAddress>sample string 19</DeliveryAddress>
  <DeliveryAddressID>1</DeliveryAddressID>
  <DueDate>2025-01-22T20:52:58.9995325-06:00</DueDate>
  <ID>1</ID>
  <InvoiceAddress>sample string 20</InvoiceAddress>
  <InvoiceAddressID>1</InvoiceAddressID>
  <InvoiceUrl>sample string 18</InvoiceUrl>
  <IsAssignedToDeliveryPerson>true</IsAssignedToDeliveryPerson>
  <IsFromPerfomaSale>true</IsFromPerfomaSale>
  <IsInvoiceCreated>true</IsInvoiceCreated>
  <IsLabelCreated>true</IsLabelCreated>
  <IsOnlineOrder>true</IsOnlineOrder>
  <IsPrinted>true</IsPrinted>
  <IsRefundable>true</IsRefundable>
  <IsReturned>true</IsReturned>
  <IsShipped>true</IsShipped>
  <IsTraceable>true</IsTraceable>
  <NGB>21</NGB>
  <Outlet>sample string 8</Outlet>
  <OutletID>1</OutletID>
  <PaymentCondition>sample string 12</PaymentCondition>
  <PaymentConditionID>1</PaymentConditionID>
  <PaymentMode>sample string 10</PaymentMode>
  <PaymentModeID>1</PaymentModeID>
  <PerfomaSaleID>1</PerfomaSaleID>
  <ReturnedTyped>1</ReturnedTyped>
  <SaleDate>2025-01-22T20:52:58.9995325-06:00</SaleDate>
  <SaleDetails>
    <SaleDetailModel>
      <BLabel>sample string 9</BLabel>
      <ID>1</ID>
      <IsKeenlandExists>true</IsKeenlandExists>
      <IsReturned>true</IsReturned>
      <Keenland>sample string 2</Keenland>
      <ManufacturerCode>sample string 11</ManufacturerCode>
      <OriginalQuantity>1</OriginalQuantity>
      <Product>sample string 3</Product>
      <ProductID>1</ProductID>
      <ProductImage>sample string 10</ProductImage>
      <ProductPrice>1</ProductPrice>
      <ProductPriceString>sample string 5</ProductPriceString>
      <ProductQRCode>sample string 8</ProductQRCode>
      <ProductVariant>sample string 4</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <ProductVarientBarCode>sample string 7</ProductVarientBarCode>
      <Quantity>1</Quantity>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ReturnedTyped>1</ReturnedTyped>
      <SaleDetailNonTrackableLocations>
        <SaleDetailNonTrackableLocationModel>
          <ID>1</ID>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductsLocationID>1</NonTrackableProductsLocationID>
          <Quantity>1</Quantity>
          <SaleDetailID>1</SaleDetailID>
        </SaleDetailNonTrackableLocationModel>
        <SaleDetailNonTrackableLocationModel>
          <ID>1</ID>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductsLocationID>1</NonTrackableProductsLocationID>
          <Quantity>1</Quantity>
          <SaleDetailID>1</SaleDetailID>
        </SaleDetailNonTrackableLocationModel>
      </SaleDetailNonTrackableLocations>
      <SaleID>1</SaleID>
      <TaxAmount>1</TaxAmount>
      <TaxPer>1</TaxPer>
      <TrackableProductsSaleDetails>
        <TrackableProductsSaleDetailModel>
          <CreatedAt>2025-01-22T20:52:58.9995325-06:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <Product>sample string 3</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 4</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <SaleDetailID>1</SaleDetailID>
          <TrackableCode>sample string 2</TrackableCode>
        </TrackableProductsSaleDetailModel>
        <TrackableProductsSaleDetailModel>
          <CreatedAt>2025-01-22T20:52:58.9995325-06:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <Product>sample string 3</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 4</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <SaleDetailID>1</SaleDetailID>
          <TrackableCode>sample string 2</TrackableCode>
        </TrackableProductsSaleDetailModel>
      </TrackableProductsSaleDetails>
      <dDiscountPer>1</dDiscountPer>
      <dTotalAmount>1</dTotalAmount>
      <dTotalDiscount>1</dTotalDiscount>
      <dTotalUnitValue>1</dTotalUnitValue>
      <dTotalValue>1</dTotalValue>
      <isReturnProductChecked>true</isReturnProductChecked>
    </SaleDetailModel>
    <SaleDetailModel>
      <BLabel>sample string 9</BLabel>
      <ID>1</ID>
      <IsKeenlandExists>true</IsKeenlandExists>
      <IsReturned>true</IsReturned>
      <Keenland>sample string 2</Keenland>
      <ManufacturerCode>sample string 11</ManufacturerCode>
      <OriginalQuantity>1</OriginalQuantity>
      <Product>sample string 3</Product>
      <ProductID>1</ProductID>
      <ProductImage>sample string 10</ProductImage>
      <ProductPrice>1</ProductPrice>
      <ProductPriceString>sample string 5</ProductPriceString>
      <ProductQRCode>sample string 8</ProductQRCode>
      <ProductVariant>sample string 4</ProductVariant>
      <ProductVariantID>1</ProductVariantID>
      <ProductVarientBarCode>sample string 7</ProductVarientBarCode>
      <Quantity>1</Quantity>
      <ReturnedQuantity>1</ReturnedQuantity>
      <ReturnedTyped>1</ReturnedTyped>
      <SaleDetailNonTrackableLocations>
        <SaleDetailNonTrackableLocationModel>
          <ID>1</ID>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductsLocationID>1</NonTrackableProductsLocationID>
          <Quantity>1</Quantity>
          <SaleDetailID>1</SaleDetailID>
        </SaleDetailNonTrackableLocationModel>
        <SaleDetailNonTrackableLocationModel>
          <ID>1</ID>
          <LevelID>1</LevelID>
          <Location>sample string 2</Location>
          <NonTrackableProductsLocationID>1</NonTrackableProductsLocationID>
          <Quantity>1</Quantity>
          <SaleDetailID>1</SaleDetailID>
        </SaleDetailNonTrackableLocationModel>
      </SaleDetailNonTrackableLocations>
      <SaleID>1</SaleID>
      <TaxAmount>1</TaxAmount>
      <TaxPer>1</TaxPer>
      <TrackableProductsSaleDetails>
        <TrackableProductsSaleDetailModel>
          <CreatedAt>2025-01-22T20:52:58.9995325-06:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <Product>sample string 3</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 4</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <SaleDetailID>1</SaleDetailID>
          <TrackableCode>sample string 2</TrackableCode>
        </TrackableProductsSaleDetailModel>
        <TrackableProductsSaleDetailModel>
          <CreatedAt>2025-01-22T20:52:58.9995325-06:00</CreatedAt>
          <ID>1</ID>
          <IsReturned>true</IsReturned>
          <Product>sample string 3</Product>
          <ProductID>1</ProductID>
          <ProductVariant>sample string 4</ProductVariant>
          <ProductVariantID>1</ProductVariantID>
          <SaleDetailID>1</SaleDetailID>
          <TrackableCode>sample string 2</TrackableCode>
        </TrackableProductsSaleDetailModel>
      </TrackableProductsSaleDetails>
      <dDiscountPer>1</dDiscountPer>
      <dTotalAmount>1</dTotalAmount>
      <dTotalDiscount>1</dTotalDiscount>
      <dTotalUnitValue>1</dTotalUnitValue>
      <dTotalValue>1</dTotalValue>
      <isReturnProductChecked>true</isReturnProductChecked>
    </SaleDetailModel>
  </SaleDetails>
  <SaleInvoiceNo>sample string 16</SaleInvoiceNo>
  <ShippingCost>1</ShippingCost>
  <ShippingMethod>sample string 15</ShippingMethod>
  <ShippingMethodID>1</ShippingMethodID>
  <SlipUrl>sample string 17</SlipUrl>
  <Type>sample string 14</Type>
  <TypeID>1</TypeID>
  <UpdatedAt>2025-01-22T20:52:58.9995325-06:00</UpdatedAt>
  <dDiscountPercentage>1</dDiscountPercentage>
  <dDiscountValue>1</dDiscountValue>
  <dDiscountValueString>sample string 2</dDiscountValueString>
  <dTotalPaidValue>1</dTotalPaidValue>
  <dTotalPaidValueString>sample string 4</dTotalPaidValueString>
  <dTotalSaleValue>1</dTotalSaleValue>
  <dTotalSaleValueString>sample string 3</dTotalSaleValueString>
  <dtDate>2025-01-22T20:52:58.9995325-06:00</dtDate>
  <isInvoiceSelected>true</isInvoiceSelected>
  <isReturnVisible>sample string 11</isReturnVisible>
  <sRemarks>sample string 5</sRemarks>
</SaleModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OnlineOrderResponse

Name	Type	Additional information
ShopOrderID	integer	None.
OrderID	integer	None.
OnlineOrderDetails	Collection of OnlineOrderDetail	None.
ResponseCode	integer	None.
ResponseText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ShopOrderID": 1,
  "OrderID": 2,
  "OnlineOrderDetails": [
    {
      "OrderDetailID": 1,
      "ShopProductID": 2,
      "Quantity": 3,
      "LocationDetails": [
        {
          "OrderLocationID": 1,
          "Location": "sample string 2",
          "Quantity": 3
        },
        {
          "OrderLocationID": 1,
          "Location": "sample string 2",
          "Quantity": 3
        }
      ]
    },
    {
      "OrderDetailID": 1,
      "ShopProductID": 2,
      "Quantity": 3,
      "LocationDetails": [
        {
          "OrderLocationID": 1,
          "Location": "sample string 2",
          "Quantity": 3
        },
        {
          "OrderLocationID": 1,
          "Location": "sample string 2",
          "Quantity": 3
        }
      ]
    }
  ],
  "ResponseCode": 3,
  "ResponseText": "sample string 4"
}

application/xml, text/xml

Sample:

<OnlineOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POS.DTO.DataModel">
  <ResponseCode>3</ResponseCode>
  <ResponseText>sample string 4</ResponseText>
  <OnlineOrderDetails>
    <OnlineOrderDetail>
      <LocationDetails>
        <OnlineOrderLocationDetail>
          <Location>sample string 2</Location>
          <OrderLocationID>1</OrderLocationID>
          <Quantity>3</Quantity>
        </OnlineOrderLocationDetail>
        <OnlineOrderLocationDetail>
          <Location>sample string 2</Location>
          <OrderLocationID>1</OrderLocationID>
          <Quantity>3</Quantity>
        </OnlineOrderLocationDetail>
      </LocationDetails>
      <OrderDetailID>1</OrderDetailID>
      <Quantity>3</Quantity>
      <ShopProductID>2</ShopProductID>
    </OnlineOrderDetail>
    <OnlineOrderDetail>
      <LocationDetails>
        <OnlineOrderLocationDetail>
          <Location>sample string 2</Location>
          <OrderLocationID>1</OrderLocationID>
          <Quantity>3</Quantity>
        </OnlineOrderLocationDetail>
        <OnlineOrderLocationDetail>
          <Location>sample string 2</Location>
          <OrderLocationID>1</OrderLocationID>
          <Quantity>3</Quantity>
        </OnlineOrderLocationDetail>
      </LocationDetails>
      <OrderDetailID>1</OrderDetailID>
      <Quantity>3</Quantity>
      <ShopProductID>2</ShopProductID>
    </OnlineOrderDetail>
  </OnlineOrderDetails>
  <OrderID>2</OrderID>
  <ShopOrderID>1</ShopOrderID>
</OnlineOrderResponse>