POST api/Order

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
BranchId	integer	None.
StationId	integer	None.
OrderId	integer	None.
ReceiptNo	string	None.
OrderTime	date	None.
OrderCloseTime	date	None.
Total	decimal number	None.
SubTotal	decimal number	None.
Branch	string	None.
DiscountLabel	string	None.
Discount	decimal number	None.
Cashier	string	None.
Tax	decimal number	None.
ServiceCharge	decimal number	None.
Rounding	decimal number	None.
Status	integer	None.
MemberRefNo	string	None.
TableNo	string	None.
Cover	integer	None.
Payments	Collection of Payment	None.
OrderItems	Collection of OrderItem	None.
DeliveryDetails	DeliveryDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "BranchId": 1,
  "StationId": 2,
  "OrderId": 3,
  "ReceiptNo": "sample string 4",
  "OrderTime": "2025-11-17T01:24:27.5720679+08:00",
  "OrderCloseTime": "2025-11-17T01:24:27.5720679+08:00",
  "Total": 7.0,
  "SubTotal": 8.0,
  "Branch": "sample string 9",
  "DiscountLabel": "sample string 10",
  "Discount": 11.0,
  "Cashier": "sample string 12",
  "Tax": 13.0,
  "ServiceCharge": 14.0,
  "Rounding": 15.0,
  "Status": 16,
  "MemberRefNo": "sample string 17",
  "TableNo": "sample string 18",
  "Cover": 19,
  "Payments": [
    {
      "PaymentMode": "sample string 1",
      "Amount": 2.0,
      "PaymentId": 3
    },
    {
      "PaymentMode": "sample string 1",
      "Amount": 2.0,
      "PaymentId": 3
    }
  ],
  "OrderItems": [
    {
      "OrderItemId": 1,
      "ItemId": 2,
      "ItemNo": "sample string 3",
      "ItemName": "sample string 4",
      "NameChinese": "sample string 5",
      "ReceiptNo": "sample string 6",
      "OrderCloseTime": "2025-11-17T01:24:27.5720679+08:00",
      "Price": 8.0,
      "Quantity": 9,
      "Share": 10.0,
      "Branch": "sample string 11",
      "Cashier": "sample string 12",
      "Discount": 13.0,
      "DiscountLabel": "sample string 14",
      "Staff": "sample string 15",
      "Remarks": "sample string 16",
      "StockOption": 17,
      "ParentItemId": 18,
      "DisplayCategoryId": 19,
      "PacakgeRedemptions": [
        {
          "RedeemBranchId": 1,
          "RedeemBranch": "sample string 2",
          "CourseId": 3,
          "CourseItemId": 4,
          "OrderId": 5,
          "OrderItemId": 6,
          "TransactionTime": "2025-11-17T01:24:27.5720679+08:00",
          "ValueRedeemed": 8.0,
          "IsVoid": true
        },
        {
          "RedeemBranchId": 1,
          "RedeemBranch": "sample string 2",
          "CourseId": 3,
          "CourseItemId": 4,
          "OrderId": 5,
          "OrderItemId": 6,
          "TransactionTime": "2025-11-17T01:24:27.5720679+08:00",
          "ValueRedeemed": 8.0,
          "IsVoid": true
        }
      ]
    },
    {
      "OrderItemId": 1,
      "ItemId": 2,
      "ItemNo": "sample string 3",
      "ItemName": "sample string 4",
      "NameChinese": "sample string 5",
      "ReceiptNo": "sample string 6",
      "OrderCloseTime": "2025-11-17T01:24:27.5720679+08:00",
      "Price": 8.0,
      "Quantity": 9,
      "Share": 10.0,
      "Branch": "sample string 11",
      "Cashier": "sample string 12",
      "Discount": 13.0,
      "DiscountLabel": "sample string 14",
      "Staff": "sample string 15",
      "Remarks": "sample string 16",
      "StockOption": 17,
      "ParentItemId": 18,
      "DisplayCategoryId": 19,
      "PacakgeRedemptions": [
        {
          "RedeemBranchId": 1,
          "RedeemBranch": "sample string 2",
          "CourseId": 3,
          "CourseItemId": 4,
          "OrderId": 5,
          "OrderItemId": 6,
          "TransactionTime": "2025-11-17T01:24:27.5720679+08:00",
          "ValueRedeemed": 8.0,
          "IsVoid": true
        },
        {
          "RedeemBranchId": 1,
          "RedeemBranch": "sample string 2",
          "CourseId": 3,
          "CourseItemId": 4,
          "OrderId": 5,
          "OrderItemId": 6,
          "TransactionTime": "2025-11-17T01:24:27.5720679+08:00",
          "ValueRedeemed": 8.0,
          "IsVoid": true
        }
      ]
    }
  ],
  "DeliveryDetails": {
    "Name": "sample string 1",
    "Address": "sample string 2",
    "Mobile": "sample string 3",
    "Email": "sample string 4",
    "PostalCode": "sample string 5",
    "Note": "sample string 6",
    "DeliveryTime": "sample string 7",
    "DeliveryStatus": "sample string 8"
  }
}

text/xml

Sample:

<Order xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CloudSysPOSWeb.Models">
  <Branch>sample string 9</Branch>
  <BranchId>1</BranchId>
  <Cashier>sample string 12</Cashier>
  <Cover>19</Cover>
  <DeliveryDetails>
    <Address>sample string 2</Address>
    <DeliveryStatus>sample string 8</DeliveryStatus>
    <DeliveryTime>sample string 7</DeliveryTime>
    <Email>sample string 4</Email>
    <Mobile>sample string 3</Mobile>
    <Name>sample string 1</Name>
    <Note>sample string 6</Note>
    <PostalCode>sample string 5</PostalCode>
  </DeliveryDetails>
  <Discount>11</Discount>
  <DiscountLabel>sample string 10</DiscountLabel>
  <MemberRefNo>sample string 17</MemberRefNo>
  <OrderCloseTime>2025-11-17T01:24:27.5720679+08:00</OrderCloseTime>
  <OrderId>3</OrderId>
  <OrderItems>
    <OrderItem>
      <Branch>sample string 11</Branch>
      <Cashier>sample string 12</Cashier>
      <Discount>13</Discount>
      <DiscountLabel>sample string 14</DiscountLabel>
      <DisplayCategoryId>19</DisplayCategoryId>
      <ItemId>2</ItemId>
      <ItemName>sample string 4</ItemName>
      <ItemNo>sample string 3</ItemNo>
      <NameChinese>sample string 5</NameChinese>
      <OrderCloseTime>2025-11-17T01:24:27.5720679+08:00</OrderCloseTime>
      <OrderItemId>1</OrderItemId>
      <PacakgeRedemptions>
        <PackageRedemption>
          <CourseId>3</CourseId>
          <CourseItemId>4</CourseItemId>
          <IsVoid>true</IsVoid>
          <OrderId>5</OrderId>
          <OrderItemId>6</OrderItemId>
          <RedeemBranch>sample string 2</RedeemBranch>
          <RedeemBranchId>1</RedeemBranchId>
          <TransactionTime>2025-11-17T01:24:27.5720679+08:00</TransactionTime>
          <ValueRedeemed>8</ValueRedeemed>
        </PackageRedemption>
        <PackageRedemption>
          <CourseId>3</CourseId>
          <CourseItemId>4</CourseItemId>
          <IsVoid>true</IsVoid>
          <OrderId>5</OrderId>
          <OrderItemId>6</OrderItemId>
          <RedeemBranch>sample string 2</RedeemBranch>
          <RedeemBranchId>1</RedeemBranchId>
          <TransactionTime>2025-11-17T01:24:27.5720679+08:00</TransactionTime>
          <ValueRedeemed>8</ValueRedeemed>
        </PackageRedemption>
      </PacakgeRedemptions>
      <ParentItemId>18</ParentItemId>
      <Price>8</Price>
      <Quantity>9</Quantity>
      <ReceiptNo>sample string 6</ReceiptNo>
      <Remarks>sample string 16</Remarks>
      <Share>10</Share>
      <Staff>sample string 15</Staff>
      <StockOption>17</StockOption>
    </OrderItem>
    <OrderItem>
      <Branch>sample string 11</Branch>
      <Cashier>sample string 12</Cashier>
      <Discount>13</Discount>
      <DiscountLabel>sample string 14</DiscountLabel>
      <DisplayCategoryId>19</DisplayCategoryId>
      <ItemId>2</ItemId>
      <ItemName>sample string 4</ItemName>
      <ItemNo>sample string 3</ItemNo>
      <NameChinese>sample string 5</NameChinese>
      <OrderCloseTime>2025-11-17T01:24:27.5720679+08:00</OrderCloseTime>
      <OrderItemId>1</OrderItemId>
      <PacakgeRedemptions>
        <PackageRedemption>
          <CourseId>3</CourseId>
          <CourseItemId>4</CourseItemId>
          <IsVoid>true</IsVoid>
          <OrderId>5</OrderId>
          <OrderItemId>6</OrderItemId>
          <RedeemBranch>sample string 2</RedeemBranch>
          <RedeemBranchId>1</RedeemBranchId>
          <TransactionTime>2025-11-17T01:24:27.5720679+08:00</TransactionTime>
          <ValueRedeemed>8</ValueRedeemed>
        </PackageRedemption>
        <PackageRedemption>
          <CourseId>3</CourseId>
          <CourseItemId>4</CourseItemId>
          <IsVoid>true</IsVoid>
          <OrderId>5</OrderId>
          <OrderItemId>6</OrderItemId>
          <RedeemBranch>sample string 2</RedeemBranch>
          <RedeemBranchId>1</RedeemBranchId>
          <TransactionTime>2025-11-17T01:24:27.5720679+08:00</TransactionTime>
          <ValueRedeemed>8</ValueRedeemed>
        </PackageRedemption>
      </PacakgeRedemptions>
      <ParentItemId>18</ParentItemId>
      <Price>8</Price>
      <Quantity>9</Quantity>
      <ReceiptNo>sample string 6</ReceiptNo>
      <Remarks>sample string 16</Remarks>
      <Share>10</Share>
      <Staff>sample string 15</Staff>
      <StockOption>17</StockOption>
    </OrderItem>
  </OrderItems>
  <OrderTime>2025-11-17T01:24:27.5720679+08:00</OrderTime>
  <Payments>
    <Payment>
      <Amount>2</Amount>
      <PaymentId>3</PaymentId>
      <PaymentMode>sample string 1</PaymentMode>
    </Payment>
    <Payment>
      <Amount>2</Amount>
      <PaymentId>3</PaymentId>
      <PaymentMode>sample string 1</PaymentMode>
    </Payment>
  </Payments>
  <ReceiptNo>sample string 4</ReceiptNo>
  <Rounding>15</Rounding>
  <ServiceCharge>14</ServiceCharge>
  <StationId>2</StationId>
  <Status>16</Status>
  <SubTotal>8</SubTotal>
  <TableNo>sample string 18</TableNo>
  <Tax>13</Tax>
  <Total>7</Total>
</Order>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Order'.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.