POST api/PostSale/Sale
Request Information
URI Parameters
None.
Body Parameters
SalesName | Description | Type | Additional information |
---|---|---|---|
AppId | string |
None. |
|
AppKey | string |
None. |
|
Products | Collection of SaleAndReturnItems |
None. |
|
MasterSale | Sale |
None. |
Request Formats
application/json, text/json
Sample:
{ "MasterSale": { "ShopEmployeeID": 1, "ShopId": 2, "MemberId": 3, "MemberName": "sample string 4", "SaleID": 5, "UserID": 6, "SaleDateTime": "sample string 7", "GrossTotal": 8.1, "isCreditSale": true, "isMixedSale": true, "CustomerDiscount": 11.1, "MarketingDiscount": 12.1, "AdjustmentAmount": 13.1, "VATAmount": 14.1, "CashAmount": 15.1, "CreditCardAmount": 16.1, "BalanceAmount": 17.1, "NetTotal": 18.1, "Comments": "sample string 19", "CustomerShopID": 20, "AllowCutPieceDiscount": true, "NoOfCopies": 22, "ExternalRefType": "sample string 23", "ExternalRefID": "sample string 24", "BackEndConfiguration": true, "ExchangeRate": 26.1, "OfflineTillSaleID": 27, "IsMultiplePyaments": true, "CreditAmount": 29.1, "CustomerPrevBalance": 30.1, "TableId": 31, "OrderIdHomeDel": 32, "deliveryManId": 33, "SaleReturningNo": 34, "SaleReturningShopId": 35, "ShowTagPrice": true, "CouponNO": "sample string 37", "ByPassUserId": 38, "SerialNumber": 39, "InvoiceNo": 40, "TableStatus": "sample string 41", "AdditionalComments": "sample string 42", "CustomerMobileNo": "sample string 43", "POSCode": "sample string 44", "CustomerEmailAddress": "sample string 45", "TransactionId": "sample string 46", "IsManual": true, "Vendor": "sample string 48", "PaymentID": "sample string 49", "RespCode": "sample string 50", "RespMessage": "sample string 51", "ReferenceNum": "sample string 52", "IsWebSale": true, "IsWebProvisionalPoints": true, "TableDesc": "sample string 55", "AdditionalTables": "sample string 56", "giftCardAmount": 57.1, "giftCardID": 58, "GiftCardNo": "sample string 59", "TourID": 60, "TouristID": 61, "Nationality": "sample string 62", "City": "sample string 63", "ReturnReason": "sample string 64", "ReturnType": "sample string 65", "CustomerNo": "sample string 66", "pointsEarned": 67.1, "PointsEarnedValue": 68.1, "PointsRedeemed": 69.1, "PointsRedeemedValue": 70.1, "TransactionType": "sample string 71", "DispatchShopCode": "sample string 72", "CurrencyId": "sample string 73", "OrderId": "sample string 74", "ReturnReasonID": 1, "PaymentMethod": "sample string 75" }, "AppId": "sample string 1", "AppKey": "sample string 2", "Products": [ { "SaleDetailID": 1, "ProductItemID": 2, "RetailPrice": 3.1, "TaggedPrice": 4.1, "Qty": 5.1, "VATValue": 6.1, "AvgCost": 7.1, "DiscountPerc": 8.1, "ProductDiscountID": 9, "CustomerDiscountPerUnit": 10.1, "MarketingDiscountOnProduct": 11.1, "AdjustmentOnProduct": 12.1, "AdditionalTaxpercent": 13.1, "AdditionalTax": 14.1, "ExchangeRate": 15.1, "VatFactor": 16.1, "PriceIncludeVat": 17.1, "DiscountFromTagPrice": 18.1, "VatOnRetailPrice": 19.1, "PriceForDiscount": 20.1, "PriceAfterDiscount": 21.1, "VatChargedPerUnit": 22.1, "IsOneLoadItem": true, "CardCode": "sample string 24", "LoyalityEarnedPoints": 25.1, "LoyalityCashDiscount": true, "Con_Unit": "sample string 27", "PackSize": 28.1, "ReasonID": 29, "ReasonDescription": "sample string 30", "IsCancelled": true, "VatType": "sample string 32", "DiscCategory": "sample string 33", "ProductCode": "sample string 34", "UnitPrice": 35.1, "ProductBatchNo": "sample string 36", "Con_Factor": 37.1, "VendorId": 38, "NestedItemId": 39, "Total": 40.1, "CouponDisc": 41.1, "TaxCode": "sample string 42", "TaxId": 43, "Pro_vat": 44.1, "shipment_status": "sample string 45" }, { "SaleDetailID": 1, "ProductItemID": 2, "RetailPrice": 3.1, "TaggedPrice": 4.1, "Qty": 5.1, "VATValue": 6.1, "AvgCost": 7.1, "DiscountPerc": 8.1, "ProductDiscountID": 9, "CustomerDiscountPerUnit": 10.1, "MarketingDiscountOnProduct": 11.1, "AdjustmentOnProduct": 12.1, "AdditionalTaxpercent": 13.1, "AdditionalTax": 14.1, "ExchangeRate": 15.1, "VatFactor": 16.1, "PriceIncludeVat": 17.1, "DiscountFromTagPrice": 18.1, "VatOnRetailPrice": 19.1, "PriceForDiscount": 20.1, "PriceAfterDiscount": 21.1, "VatChargedPerUnit": 22.1, "IsOneLoadItem": true, "CardCode": "sample string 24", "LoyalityEarnedPoints": 25.1, "LoyalityCashDiscount": true, "Con_Unit": "sample string 27", "PackSize": 28.1, "ReasonID": 29, "ReasonDescription": "sample string 30", "IsCancelled": true, "VatType": "sample string 32", "DiscCategory": "sample string 33", "ProductCode": "sample string 34", "UnitPrice": 35.1, "ProductBatchNo": "sample string 36", "Con_Factor": 37.1, "VendorId": 38, "NestedItemId": 39, "Total": 40.1, "CouponDisc": 41.1, "TaxCode": "sample string 42", "TaxId": 43, "Pro_vat": 44.1, "shipment_status": "sample string 45" } ] }
text/xml
Sample:
<Sales xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EConnect.Models"> <AppId>sample string 1</AppId> <AppKey>sample string 2</AppKey> <MasterSale> <AdditionalComments>sample string 42</AdditionalComments> <AdditionalTables>sample string 56</AdditionalTables> <AdjustmentAmount>13.1</AdjustmentAmount> <AllowCutPieceDiscount>true</AllowCutPieceDiscount> <BackEndConfiguration>true</BackEndConfiguration> <BalanceAmount>17.1</BalanceAmount> <ByPassUserId>38</ByPassUserId> <CashAmount>15.1</CashAmount> <City>sample string 63</City> <Comments>sample string 19</Comments> <CouponNO>sample string 37</CouponNO> <CreditAmount>29.1</CreditAmount> <CreditCardAmount>16.1</CreditCardAmount> <CurrencyId>sample string 73</CurrencyId> <CustomerDiscount>11.1</CustomerDiscount> <CustomerEmailAddress>sample string 45</CustomerEmailAddress> <CustomerMobileNo>sample string 43</CustomerMobileNo> <CustomerNo>sample string 66</CustomerNo> <CustomerPrevBalance>30.1</CustomerPrevBalance> <CustomerShopID>20</CustomerShopID> <DispatchShopCode>sample string 72</DispatchShopCode> <ExchangeRate>26.1</ExchangeRate> <ExternalRefID>sample string 24</ExternalRefID> <ExternalRefType>sample string 23</ExternalRefType> <GiftCardNo>sample string 59</GiftCardNo> <GrossTotal>8.1</GrossTotal> <InvoiceNo>40</InvoiceNo> <IsManual>true</IsManual> <IsMultiplePyaments>true</IsMultiplePyaments> <IsWebProvisionalPoints>true</IsWebProvisionalPoints> <IsWebSale>true</IsWebSale> <MarketingDiscount>12.1</MarketingDiscount> <MemberId>3</MemberId> <MemberName>sample string 4</MemberName> <Nationality>sample string 62</Nationality> <NetTotal>18.1</NetTotal> <NoOfCopies>22</NoOfCopies> <OfflineTillSaleID>27</OfflineTillSaleID> <OrderId>sample string 74</OrderId> <OrderIdHomeDel>32</OrderIdHomeDel> <POSCode>sample string 44</POSCode> <PaymentID>sample string 49</PaymentID> <PaymentMethod>sample string 75</PaymentMethod> <PointsEarnedValue>68.1</PointsEarnedValue> <PointsRedeemed>69.1</PointsRedeemed> <PointsRedeemedValue>70.1</PointsRedeemedValue> <ReferenceNum>sample string 52</ReferenceNum> <RespCode>sample string 50</RespCode> <RespMessage>sample string 51</RespMessage> <ReturnReason>sample string 64</ReturnReason> <ReturnReasonID>1</ReturnReasonID> <ReturnType>sample string 65</ReturnType> <SaleDateTime>sample string 7</SaleDateTime> <SaleID>5</SaleID> <SaleReturningNo>34</SaleReturningNo> <SaleReturningShopId>35</SaleReturningShopId> <SerialNumber>39</SerialNumber> <ShopEmployeeID>1</ShopEmployeeID> <ShopId>2</ShopId> <ShowTagPrice>true</ShowTagPrice> <TableDesc>sample string 55</TableDesc> <TableId>31</TableId> <TableStatus>sample string 41</TableStatus> <TourID>60</TourID> <TouristID>61</TouristID> <TransactionId>sample string 46</TransactionId> <TransactionType>sample string 71</TransactionType> <UserID>6</UserID> <VATAmount>14.1</VATAmount> <Vendor>sample string 48</Vendor> <deliveryManId>33</deliveryManId> <giftCardAmount>57.1</giftCardAmount> <giftCardID>58</giftCardID> <isCreditSale>true</isCreditSale> <isMixedSale>true</isMixedSale> <pointsEarned>67.1</pointsEarned> </MasterSale> <Products> <SaleAndReturnItems> <AdditionalTax>14.1</AdditionalTax> <AdditionalTaxpercent>13.1</AdditionalTaxpercent> <AdjustmentOnProduct>12.1</AdjustmentOnProduct> <AvgCost>7.1</AvgCost> <CardCode>sample string 24</CardCode> <Con_Factor>37.1</Con_Factor> <Con_Unit>sample string 27</Con_Unit> <CouponDisc>41.1</CouponDisc> <CustomerDiscountPerUnit>10.1</CustomerDiscountPerUnit> <DiscCategory>sample string 33</DiscCategory> <DiscountFromTagPrice>18.1</DiscountFromTagPrice> <DiscountPerc>8.1</DiscountPerc> <ExchangeRate>15.1</ExchangeRate> <IsCancelled>true</IsCancelled> <IsOneLoadItem>true</IsOneLoadItem> <LoyalityCashDiscount>true</LoyalityCashDiscount> <LoyalityEarnedPoints>25.1</LoyalityEarnedPoints> <MarketingDiscountOnProduct>11.1</MarketingDiscountOnProduct> <NestedItemId>39</NestedItemId> <PackSize>28.1</PackSize> <PriceAfterDiscount>21.1</PriceAfterDiscount> <PriceForDiscount>20.1</PriceForDiscount> <PriceIncludeVat>17.1</PriceIncludeVat> <Pro_vat>44.1</Pro_vat> <ProductBatchNo>sample string 36</ProductBatchNo> <ProductCode>sample string 34</ProductCode> <ProductDiscountID>9</ProductDiscountID> <ProductItemID>2</ProductItemID> <Qty>5.1</Qty> <ReasonDescription>sample string 30</ReasonDescription> <ReasonID>29</ReasonID> <RetailPrice>3.1</RetailPrice> <SaleDetailID>1</SaleDetailID> <TaggedPrice>4.1</TaggedPrice> <TaxCode>sample string 42</TaxCode> <TaxId>43</TaxId> <Total>40.1</Total> <UnitPrice>35.1</UnitPrice> <VATValue>6.1</VATValue> <VatChargedPerUnit>22.1</VatChargedPerUnit> <VatFactor>16.1</VatFactor> <VatOnRetailPrice>19.1</VatOnRetailPrice> <VatType>sample string 32</VatType> <VendorId>38</VendorId> <shipment_status>sample string 45</shipment_status> </SaleAndReturnItems> <SaleAndReturnItems> <AdditionalTax>14.1</AdditionalTax> <AdditionalTaxpercent>13.1</AdditionalTaxpercent> <AdjustmentOnProduct>12.1</AdjustmentOnProduct> <AvgCost>7.1</AvgCost> <CardCode>sample string 24</CardCode> <Con_Factor>37.1</Con_Factor> <Con_Unit>sample string 27</Con_Unit> <CouponDisc>41.1</CouponDisc> <CustomerDiscountPerUnit>10.1</CustomerDiscountPerUnit> <DiscCategory>sample string 33</DiscCategory> <DiscountFromTagPrice>18.1</DiscountFromTagPrice> <DiscountPerc>8.1</DiscountPerc> <ExchangeRate>15.1</ExchangeRate> <IsCancelled>true</IsCancelled> <IsOneLoadItem>true</IsOneLoadItem> <LoyalityCashDiscount>true</LoyalityCashDiscount> <LoyalityEarnedPoints>25.1</LoyalityEarnedPoints> <MarketingDiscountOnProduct>11.1</MarketingDiscountOnProduct> <NestedItemId>39</NestedItemId> <PackSize>28.1</PackSize> <PriceAfterDiscount>21.1</PriceAfterDiscount> <PriceForDiscount>20.1</PriceForDiscount> <PriceIncludeVat>17.1</PriceIncludeVat> <Pro_vat>44.1</Pro_vat> <ProductBatchNo>sample string 36</ProductBatchNo> <ProductCode>sample string 34</ProductCode> <ProductDiscountID>9</ProductDiscountID> <ProductItemID>2</ProductItemID> <Qty>5.1</Qty> <ReasonDescription>sample string 30</ReasonDescription> <ReasonID>29</ReasonID> <RetailPrice>3.1</RetailPrice> <SaleDetailID>1</SaleDetailID> <TaggedPrice>4.1</TaggedPrice> <TaxCode>sample string 42</TaxCode> <TaxId>43</TaxId> <Total>40.1</Total> <UnitPrice>35.1</UnitPrice> <VATValue>6.1</VATValue> <VatChargedPerUnit>22.1</VatChargedPerUnit> <VatFactor>16.1</VatFactor> <VatOnRetailPrice>19.1</VatOnRetailPrice> <VatType>sample string 32</VatType> <VendorId>38</VendorId> <shipment_status>sample string 45</shipment_status> </SaleAndReturnItems> </Products> </Sales>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SaleResponceName | Description | Type | Additional information |
---|---|---|---|
code | string |
None. |
|
msg | string |
None. |
|
ReceiptNo | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "code": "sample string 1", "msg": "sample string 2", "ReceiptNo": 3 }
text/xml
Sample:
<SaleResponce xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EConnect.Models"> <ReceiptNo>3</ReceiptNo> <code>sample string 1</code> <msg>sample string 2</msg> </SaleResponce>