POST api/Order

Order Details

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
CreatedOn	Order Posted Date	date	None.
NetAmount	Net amount refers to the amount remaining after certain adjustments have been made for debts, deductions or expenses	decimal number	None.
Discount	deduction from the usual cost of something	decimal number	None.
TaxAmount	tax amount is the percentage at which an individual or corporation is taxed	decimal number	None.
AmountPaid	The total sum of money due for the purchase of a good or service that must be paid	decimal number	None.
GrossAmount	Gross refers to the total amount before anything is deducted.	decimal number	None.
TransactionMode	Means by which a payment is made, such as cash, check, or credit card.	integer	None.
InvoiceDate	Invoice generated date.	date	None.
CardNo	unique number imprinted on card	string	String length: inclusive between 0 and 100
CardType	To specify which type of card it is	string	String length: inclusive between 0 and 200
AuthCode	A code or password that identifies the user as authorized to complete a transaction	string	String length: inclusive between 0 and 100
TransactiontId	Transaction ID is the value that is returned by the bank to identify a transaction on their system	string	String length: inclusive between 0 and 200
OrderType		string	None.
OrderNo	a number identifying a purchase or order placed by a customer.	string	None.
DeliveryCharges	A delivery charge is the cost of transporting or delivering goods	decimal number	None.
CardHolderName	The Cardholder Name is typically the name of the person on the front of the credit card.	string	None.
CustomerPhone	The Customer Phone is typically the contact of the customer.	string	None.
CustomerName	Name of the customer is someone who buys something	string	None.
CustomerPickup	Customer Pickup, the Customer comes in and picks up the order using their own equipment	string	None.
CustomerAddress	Address of the customer	string	None.
DeliverNote	A document accompanying a shipment of goods that lists the description, and quantity of the goods delivered	string	None.
CashAmount		decimal number	None.
OrderDetails	Order Item Details	Collection of OrderDetailsViewModel	None.

Request Formats

application/json, text/json

Sample:

{
  "CreatedOn": "2024-04-03T21:21:57.3874294+00:00",
  "NetAmount": 1.0,
  "Discount": 1.0,
  "TaxAmount": 1.0,
  "AmountPaid": 1.0,
  "GrossAmount": 1.0,
  "TransactionMode": 1,
  "InvoiceDate": "2024-04-03T21:21:57.3874294+00:00",
  "CardNo": "sample string 1",
  "CardType": "sample string 2",
  "AuthCode": "sample string 3",
  "TransactiontId": "sample string 4",
  "OrderType": "sample string 5",
  "OrderNo": "sample string 6",
  "DeliveryCharges": 1.0,
  "CardHolderName": "sample string 7",
  "CustomerPhone": "sample string 8",
  "CustomerName": "sample string 9",
  "CustomerPickup": "sample string 10",
  "CustomerAddress": "sample string 11",
  "DeliverNote": "sample string 12",
  "CashAmount": 1.0,
  "OrderDetails": [
    {
      "Name": "sample string 1",
      "ItemCode": "sample string 2",
      "Rate": 1.0,
      "Discount": 1.0,
      "Amount": 1.0,
      "Quantity": 1.0,
      "InvoiceBarcode": "sample string 3",
      "TaxAmount": 1.0
    },
    {
      "Name": "sample string 1",
      "ItemCode": "sample string 2",
      "Rate": 1.0,
      "Discount": 1.0,
      "Amount": 1.0,
      "Quantity": 1.0,
      "InvoiceBarcode": "sample string 3",
      "TaxAmount": 1.0
    }
  ]
}

application/xml, text/xml

Sample:

<OrdersViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DolphinOrderManagement.ViewModels">
  <AmountPaid>1</AmountPaid>
  <AuthCode>sample string 3</AuthCode>
  <CardHolderName>sample string 7</CardHolderName>
  <CardNo>sample string 1</CardNo>
  <CardType>sample string 2</CardType>
  <CashAmount>1</CashAmount>
  <CreatedOn>2024-04-03T21:21:57.3874294+00:00</CreatedOn>
  <CustomerAddress>sample string 11</CustomerAddress>
  <CustomerName>sample string 9</CustomerName>
  <CustomerPhone>sample string 8</CustomerPhone>
  <CustomerPickup>sample string 10</CustomerPickup>
  <DeliverNote>sample string 12</DeliverNote>
  <DeliveryCharges>1</DeliveryCharges>
  <Discount>1</Discount>
  <GrossAmount>1</GrossAmount>
  <InvoiceDate>2024-04-03T21:21:57.3874294+00:00</InvoiceDate>
  <NetAmount>1</NetAmount>
  <OrderDetails>
    <OrderDetailsViewModel>
      <Amount>1</Amount>
      <Discount>1</Discount>
      <InvoiceBarcode>sample string 3</InvoiceBarcode>
      <ItemCode>sample string 2</ItemCode>
      <Name>sample string 1</Name>
      <Quantity>1</Quantity>
      <Rate>1</Rate>
      <TaxAmount>1</TaxAmount>
    </OrderDetailsViewModel>
    <OrderDetailsViewModel>
      <Amount>1</Amount>
      <Discount>1</Discount>
      <InvoiceBarcode>sample string 3</InvoiceBarcode>
      <ItemCode>sample string 2</ItemCode>
      <Name>sample string 1</Name>
      <Quantity>1</Quantity>
      <Rate>1</Rate>
      <TaxAmount>1</TaxAmount>
    </OrderDetailsViewModel>
  </OrderDetails>
  <OrderNo>sample string 6</OrderNo>
  <OrderType>sample string 5</OrderType>
  <TaxAmount>1</TaxAmount>
  <TransactionMode>1</TransactionMode>
  <TransactiontId>sample string 4</TransactiontId>
</OrdersViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

OrderResponseViewModal

Name	Description	Type	Additional information
Status	Order posted status	string	None.
ErrorMessage	Error message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "ErrorMessage": "sample string 2"
}

application/xml, text/xml

Sample:

<OrderResponseViewModal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DolphinOrderManagement.ViewModels">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Status>sample string 1</Status>
</OrderResponseViewModal>