POST api/Ecommerce/ArchiveOrder

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OrderId		integer	Required
ShopId		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "OrderId": 1,
  "ShopId": 2
}

application/xml, text/xml

Sample:

<EcommerceModels.ShopOrderArchive xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <OrderId>1</OrderId>
  <ShopId>2</ShopId>
</EcommerceModels.ShopOrderArchive>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ArchiveOrderResponse

Name	Type	Additional information
Archivestatus	boolean	None.
OrderList	Collection of OrderListModel	None.
success	boolean	None.
code	string	None.
message	string	None.
errors	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "Archivestatus": true,
  "OrderList": [
    {
      "Archivestatus": true,
      "OrderID": 2,
      "OrderNumber": "sample string 3",
      "OrderDate": "2025-06-15T06:47:10.6713223+03:00",
      "OrderDueDate": "2025-06-15T06:47:10.6713223+03:00",
      "OrderNote": "sample string 6",
      "CustomerName": "sample string 7",
      "CustomerEmail": "sample string 8",
      "CustomerMobile": "sample string 9",
      "CompanyName": "sample string 10",
      "OrderSubTotal": 11.0,
      "Discount": 12.0,
      "DeliveryCharges": 13.0,
      "OrderTotal": 14.0,
      "OrderStatusID": 15,
      "OrderStatus": "sample string 16",
      "PaymentStatusID": 17,
      "PaymentStatus": "sample string 18",
      "PaymentURL": "sample string 19",
      "OrderDetail": [
        {
          "OrderID": 1,
          "ShopID": 2,
          "ShopName": "sample string 3",
          "ShopLogoLocation": "sample string 4",
          "ProductID": 5,
          "ProductName": "sample string 6",
          "ProductDescription": "sample string 7",
          "Quantity": 8.0,
          "Rate": 9.0,
          "Amount": 10.0,
          "ProductImageLocation": "sample string 11"
        },
        {
          "OrderID": 1,
          "ShopID": 2,
          "ShopName": "sample string 3",
          "ShopLogoLocation": "sample string 4",
          "ProductID": 5,
          "ProductName": "sample string 6",
          "ProductDescription": "sample string 7",
          "Quantity": 8.0,
          "Rate": 9.0,
          "Amount": 10.0,
          "ProductImageLocation": "sample string 11"
        }
      ],
      "ShopID": 20,
      "ShopName": "sample string 21",
      "ShopImage": "sample string 22",
      "ShopBanner": "sample string 23",
      "ShopDescription": "sample string 24"
    },
    {
      "Archivestatus": true,
      "OrderID": 2,
      "OrderNumber": "sample string 3",
      "OrderDate": "2025-06-15T06:47:10.6713223+03:00",
      "OrderDueDate": "2025-06-15T06:47:10.6713223+03:00",
      "OrderNote": "sample string 6",
      "CustomerName": "sample string 7",
      "CustomerEmail": "sample string 8",
      "CustomerMobile": "sample string 9",
      "CompanyName": "sample string 10",
      "OrderSubTotal": 11.0,
      "Discount": 12.0,
      "DeliveryCharges": 13.0,
      "OrderTotal": 14.0,
      "OrderStatusID": 15,
      "OrderStatus": "sample string 16",
      "PaymentStatusID": 17,
      "PaymentStatus": "sample string 18",
      "PaymentURL": "sample string 19",
      "OrderDetail": [
        {
          "OrderID": 1,
          "ShopID": 2,
          "ShopName": "sample string 3",
          "ShopLogoLocation": "sample string 4",
          "ProductID": 5,
          "ProductName": "sample string 6",
          "ProductDescription": "sample string 7",
          "Quantity": 8.0,
          "Rate": 9.0,
          "Amount": 10.0,
          "ProductImageLocation": "sample string 11"
        },
        {
          "OrderID": 1,
          "ShopID": 2,
          "ShopName": "sample string 3",
          "ShopLogoLocation": "sample string 4",
          "ProductID": 5,
          "ProductName": "sample string 6",
          "ProductDescription": "sample string 7",
          "Quantity": 8.0,
          "Rate": 9.0,
          "Amount": 10.0,
          "ProductImageLocation": "sample string 11"
        }
      ],
      "ShopID": 20,
      "ShopName": "sample string 21",
      "ShopImage": "sample string 22",
      "ShopBanner": "sample string 23",
      "ShopDescription": "sample string 24"
    }
  ],
  "success": true,
  "code": "sample string 3",
  "message": "sample string 4",
  "errors": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<EcommerceModels.ArchiveOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QatarPay.Models">
  <code>sample string 3</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 4</message>
  <success>true</success>
  <Archivestatus>true</Archivestatus>
  <OrderList>
    <EcommerceModels.OrderListModel>
      <Archivestatus>true</Archivestatus>
      <CompanyName>sample string 10</CompanyName>
      <CustomerEmail>sample string 8</CustomerEmail>
      <CustomerMobile>sample string 9</CustomerMobile>
      <CustomerName>sample string 7</CustomerName>
      <DeliveryCharges>13</DeliveryCharges>
      <Discount>12</Discount>
      <OrderDate>2025-06-15T06:47:10.6713223+03:00</OrderDate>
      <OrderDetail>
        <EcommerceModels.OrderDetailModel>
          <Amount>10</Amount>
          <OrderID>1</OrderID>
          <ProductDescription>sample string 7</ProductDescription>
          <ProductID>5</ProductID>
          <ProductImageLocation>sample string 11</ProductImageLocation>
          <ProductName>sample string 6</ProductName>
          <Quantity>8</Quantity>
          <Rate>9</Rate>
          <ShopID>2</ShopID>
          <ShopLogoLocation>sample string 4</ShopLogoLocation>
          <ShopName>sample string 3</ShopName>
        </EcommerceModels.OrderDetailModel>
        <EcommerceModels.OrderDetailModel>
          <Amount>10</Amount>
          <OrderID>1</OrderID>
          <ProductDescription>sample string 7</ProductDescription>
          <ProductID>5</ProductID>
          <ProductImageLocation>sample string 11</ProductImageLocation>
          <ProductName>sample string 6</ProductName>
          <Quantity>8</Quantity>
          <Rate>9</Rate>
          <ShopID>2</ShopID>
          <ShopLogoLocation>sample string 4</ShopLogoLocation>
          <ShopName>sample string 3</ShopName>
        </EcommerceModels.OrderDetailModel>
      </OrderDetail>
      <OrderDueDate>2025-06-15T06:47:10.6713223+03:00</OrderDueDate>
      <OrderID>2</OrderID>
      <OrderNote>sample string 6</OrderNote>
      <OrderNumber>sample string 3</OrderNumber>
      <OrderStatus>sample string 16</OrderStatus>
      <OrderStatusID>15</OrderStatusID>
      <OrderSubTotal>11</OrderSubTotal>
      <OrderTotal>14</OrderTotal>
      <PaymentStatus>sample string 18</PaymentStatus>
      <PaymentStatusID>17</PaymentStatusID>
      <PaymentURL>sample string 19</PaymentURL>
      <ShopBanner>sample string 23</ShopBanner>
      <ShopDescription>sample string 24</ShopDescription>
      <ShopID>20</ShopID>
      <ShopImage>sample string 22</ShopImage>
      <ShopName>sample string 21</ShopName>
    </EcommerceModels.OrderListModel>
    <EcommerceModels.OrderListModel>
      <Archivestatus>true</Archivestatus>
      <CompanyName>sample string 10</CompanyName>
      <CustomerEmail>sample string 8</CustomerEmail>
      <CustomerMobile>sample string 9</CustomerMobile>
      <CustomerName>sample string 7</CustomerName>
      <DeliveryCharges>13</DeliveryCharges>
      <Discount>12</Discount>
      <OrderDate>2025-06-15T06:47:10.6713223+03:00</OrderDate>
      <OrderDetail>
        <EcommerceModels.OrderDetailModel>
          <Amount>10</Amount>
          <OrderID>1</OrderID>
          <ProductDescription>sample string 7</ProductDescription>
          <ProductID>5</ProductID>
          <ProductImageLocation>sample string 11</ProductImageLocation>
          <ProductName>sample string 6</ProductName>
          <Quantity>8</Quantity>
          <Rate>9</Rate>
          <ShopID>2</ShopID>
          <ShopLogoLocation>sample string 4</ShopLogoLocation>
          <ShopName>sample string 3</ShopName>
        </EcommerceModels.OrderDetailModel>
        <EcommerceModels.OrderDetailModel>
          <Amount>10</Amount>
          <OrderID>1</OrderID>
          <ProductDescription>sample string 7</ProductDescription>
          <ProductID>5</ProductID>
          <ProductImageLocation>sample string 11</ProductImageLocation>
          <ProductName>sample string 6</ProductName>
          <Quantity>8</Quantity>
          <Rate>9</Rate>
          <ShopID>2</ShopID>
          <ShopLogoLocation>sample string 4</ShopLogoLocation>
          <ShopName>sample string 3</ShopName>
        </EcommerceModels.OrderDetailModel>
      </OrderDetail>
      <OrderDueDate>2025-06-15T06:47:10.6713223+03:00</OrderDueDate>
      <OrderID>2</OrderID>
      <OrderNote>sample string 6</OrderNote>
      <OrderNumber>sample string 3</OrderNumber>
      <OrderStatus>sample string 16</OrderStatus>
      <OrderStatusID>15</OrderStatusID>
      <OrderSubTotal>11</OrderSubTotal>
      <OrderTotal>14</OrderTotal>
      <PaymentStatus>sample string 18</PaymentStatus>
      <PaymentStatusID>17</PaymentStatusID>
      <PaymentURL>sample string 19</PaymentURL>
      <ShopBanner>sample string 23</ShopBanner>
      <ShopDescription>sample string 24</ShopDescription>
      <ShopID>20</ShopID>
      <ShopImage>sample string 22</ShopImage>
      <ShopName>sample string 21</ShopName>
    </EcommerceModels.OrderListModel>
  </OrderList>
</EcommerceModels.ArchiveOrderResponse>