POST api/Ecommerce/WebShopOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserID	integer	Required
OrderNumber	string	Required
OrderDate	date	Required
OrderDueDate	date	Required
OrderNote	string	Required
CustomerName	string	Required
CustomerEmail	string	Required
CustomerMobile	string	Required
CompanyName	string	Required
Discount	decimal number	Required
DeliveryCharges	decimal number	Required
ProductList	Collection of ProductOrderListRequest	Required
ShopID	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "UserID": 1,
  "OrderNumber": "sample string 2",
  "OrderDate": "2025-06-15T06:42:36.9428047+03:00",
  "OrderDueDate": "2025-06-15T06:42:36.9428047+03:00",
  "OrderNote": "sample string 5",
  "CustomerName": "sample string 6",
  "CustomerEmail": "sample string 7",
  "CustomerMobile": "sample string 8",
  "CompanyName": "sample string 9",
  "Discount": 10.0,
  "DeliveryCharges": 11.0,
  "ProductList": [
    {
      "ShopID": 1,
      "ProductID": 2,
      "Quantity": 3.0
    },
    {
      "ShopID": 1,
      "ProductID": 2,
      "Quantity": 3.0
    }
  ],
  "ShopID": 12
}

application/xml, text/xml

Sample:

<EcommerceModels.ShopOrderWebRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <CompanyName>sample string 9</CompanyName>
  <CustomerEmail>sample string 7</CustomerEmail>
  <CustomerMobile>sample string 8</CustomerMobile>
  <CustomerName>sample string 6</CustomerName>
  <DeliveryCharges>11</DeliveryCharges>
  <Discount>10</Discount>
  <OrderDate>2025-06-15T06:42:36.9428047+03:00</OrderDate>
  <OrderDueDate>2025-06-15T06:42:36.9428047+03:00</OrderDueDate>
  <OrderNote>sample string 5</OrderNote>
  <OrderNumber>sample string 2</OrderNumber>
  <ProductList>
    <EcommerceModels.ProductOrderListRequest>
      <ProductID>2</ProductID>
      <Quantity>3</Quantity>
      <ShopID>1</ShopID>
    </EcommerceModels.ProductOrderListRequest>
    <EcommerceModels.ProductOrderListRequest>
      <ProductID>2</ProductID>
      <Quantity>3</Quantity>
      <ShopID>1</ShopID>
    </EcommerceModels.ProductOrderListRequest>
  </ProductList>
  <ShopID>12</ShopID>
  <UserID>1</UserID>
</EcommerceModels.ShopOrderWebRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderResponse

Name	Type	Additional information
OrderPaymentLink	string	None.
OrderID	integer	None.
IsArchive	boolean	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "OrderPaymentLink": "sample string 1",
  "OrderID": 2,
  "IsArchive": true,
  "success": true,
  "code": "sample string 5",
  "message": "sample string 6",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<EcommerceModels.OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <code>sample string 5</code>
  <errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </errors>
  <message>sample string 6</message>
  <success>true</success>
  <IsArchive>true</IsArchive>
  <OrderID>2</OrderID>
  <OrderPaymentLink>sample string 1</OrderPaymentLink>
</EcommerceModels.OrderResponse>