POST api/Orders

Through the API user can place an order by passig values as sample format, API return order object with detail as givin sample response format

Request Information

URI Parameters

None.

Body Parameters

Order view model is used to place an order, it contail user, formula and content detail

OrderVM

Name	Description	Type	Additional information
type	Is this an Order or a Quote	integer	None.
id	Order Id generated by system	integer	None.
UserName	UserName, order for this perticular user	string	None.
UserEmail	UserEmail, order's user email	string	None.
trans	Transaction id, received from authorize.net, in case of paymentmethod is target	string	None.
status	Order status	string	None.
statusid	Order status id	integer	None.
date	Order Date	date	None.
shipping	Order shipping charges	decimal number	None.
subtotal	Order sub total	decimal number	None.
total	Total cost of the order	decimal number	None.
custref	Customer ref	string	None.
shipmethod	Shipping method by Name	string	None.
fullname	User Full name	string	None.
shipaddr1	Shipping address 1	string	None.
shipaddr2	Shipping address 2	string	None.
shipaddr3		string	None.
shipcity	Shipping city	string	None.
shipcountry	Shipping country	string	None.
shipstate	Shipping state	string	None.
shipzip	Shipping zip code	string	None.
shipphone	Shipping phone number	string	None.
cardtype	Payment card type	string	None.
cardnum	Payment card number	string	None.
expmonth	Payment card expiry month	string	None.
expyear	Payment card expiry year	string	None.
billfirst	Billing first name	string	None.
billlast	Billing last name	string	None.
billaddr1	Billing address 1	string	None.
billaddr2	Billing address 2	string	None.
billaddr3		string	None.
billcity	Billing city	string	None.
billcountry	Billing country	string	None.
billstate	Billing state	string	None.
billzip	Billing zip code	string	None.
billphone	Billing phone number	string	None.
tracking	Order tracking	string	None.
paymentmethod	Payment method name like 'credit'	string	None.
shippingnote	Shippping note	string	None.
ShippingMethodID	shipping method id Shipping charges calculate as per shipping method	integer	None.
vip	VIP, for marking the order is VIP	boolean	None.
Details	Order detail, means formula/material detail	Collection of DetailVM	None.

Request Formats

application/json, text/json

Sample:

{
  "type": 0,
  "id": 2,
  "userName": "Akash",
  "userEmail": "srivastavaa@gmail.com",
  "trans": "40045498182",
  "status": "true",
  "statusid": 1,
  "date": "2026-05-23T21:42:17.0627424-07:00",
  "shipping": 9.0,
  "subtotal": 10.0,
  "total": 11.0,
  "custref": "Customer reference",
  "shipmethod": "",
  "fullname": "Alec",
  "shipaddr1": "200 Pacific Coast Highway",
  "shipaddr2": "Unit 411",
  "shipaddr3": null,
  "shipcity": "Huntington Beach",
  "shipcountry": "US",
  "shipstate": "CA",
  "shipzip": "92648",
  "shipphone": "111-222-3333",
  "cardtype": "Credit Card",
  "cardnum": "34634656546546",
  "expmonth": "11",
  "expyear": "2019",
  "billfirst": "Alec",
  "billlast": "Effrat",
  "billaddr1": "200 Pacific Coast Highway",
  "billaddr2": "Unit 411",
  "billaddr3": "",
  "billcity": "Huntington Beach",
  "billcountry": "US",
  "billstate": "CA",
  "billzip": "92648",
  "billphone": "111-222-3333",
  "tracking": "Sample 36",
  "paymentmethod": "credit",
  "shippingnote": "Shipping note",
  "shippingMethodID": 1,
  "vip": true,
  "details": [
    {
      "bottleQTY": 0,
      "name": "Formula name",
      "forid": 123,
      "price": 100.12,
      "basecost": 0.0,
      "notes": "Notes",
      "type": 0,
      "supply": 90,
      "filleridnumber": "PN94203",
      "exactserving": "1",
      "numberofdoses": "1",
      "totalvolume": "30",
      "totalweight": "12.345",
      "totalservings": "90",
      "contents": [
        {
          "weight": 12.23,
          "name": "analine diphosphorus",
          "activecomponent": "analine",
          "idnumber": "PN79809",
          "unit": "mg"
        },
        {
          "weight": 12.23,
          "name": "Ethnamide",
          "activecomponent": "actamide",
          "idnumber": "PN79889",
          "unit": "mg"
        }
      ],
      "protocols": [
        {
          "id": 1,
          "name": "Elevated/upper range 3-MT",
          "quantity": 1.0
        },
        {
          "id": 2,
          "name": "Elevated/upper range DOPAC",
          "quantity": 1.0
        }
      ],
      "flavors": null,
      "locked": true,
      "isOrderable": false,
      "validateErrorMessage": ""
    }
  ]
}

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 'OrderVM'.

Response Information

Resource Description

OrderVM

Name	Description	Type	Additional information
type	Is this an Order or a Quote	integer	None.
id	Order Id generated by system	integer	None.
UserName	UserName, order for this perticular user	string	None.
UserEmail	UserEmail, order's user email	string	None.
trans	Transaction id, received from authorize.net, in case of paymentmethod is target	string	None.
status	Order status	string	None.
statusid	Order status id	integer	None.
date	Order Date	date	None.
shipping	Order shipping charges	decimal number	None.
subtotal	Order sub total	decimal number	None.
total	Total cost of the order	decimal number	None.
custref	Customer ref	string	None.
shipmethod	Shipping method by Name	string	None.
fullname	User Full name	string	None.
shipaddr1	Shipping address 1	string	None.
shipaddr2	Shipping address 2	string	None.
shipaddr3		string	None.
shipcity	Shipping city	string	None.
shipcountry	Shipping country	string	None.
shipstate	Shipping state	string	None.
shipzip	Shipping zip code	string	None.
shipphone	Shipping phone number	string	None.
cardtype	Payment card type	string	None.
cardnum	Payment card number	string	None.
expmonth	Payment card expiry month	string	None.
expyear	Payment card expiry year	string	None.
billfirst	Billing first name	string	None.
billlast	Billing last name	string	None.
billaddr1	Billing address 1	string	None.
billaddr2	Billing address 2	string	None.
billaddr3		string	None.
billcity	Billing city	string	None.
billcountry	Billing country	string	None.
billstate	Billing state	string	None.
billzip	Billing zip code	string	None.
billphone	Billing phone number	string	None.
tracking	Order tracking	string	None.
paymentmethod	Payment method name like 'credit'	string	None.
shippingnote	Shippping note	string	None.
ShippingMethodID	shipping method id Shipping charges calculate as per shipping method	integer	None.
vip	VIP, for marking the order is VIP	boolean	None.
Details	Order detail, means formula/material detail	Collection of DetailVM	None.

Response Formats

application/json, text/json

Sample:

{
  "type": 0,
  "id": 2,
  "userName": "Akash",
  "userEmail": "srivastavaa@gmail.com",
  "trans": "40045498182",
  "status": "true",
  "statusid": 1,
  "date": "2026-05-23T21:42:17.0627424-07:00",
  "shipping": 9.0,
  "subtotal": 10.0,
  "total": 11.0,
  "custref": "Customer reference",
  "shipmethod": "",
  "fullname": "Alec",
  "shipaddr1": "200 Pacific Coast Highway",
  "shipaddr2": "Unit 411",
  "shipaddr3": null,
  "shipcity": "Huntington Beach",
  "shipcountry": "US",
  "shipstate": "CA",
  "shipzip": "92648",
  "shipphone": "111-222-3333",
  "cardtype": "Credit Card",
  "cardnum": "34634656546546",
  "expmonth": "11",
  "expyear": "2019",
  "billfirst": "Alec",
  "billlast": "Effrat",
  "billaddr1": "200 Pacific Coast Highway",
  "billaddr2": "Unit 411",
  "billaddr3": "",
  "billcity": "Huntington Beach",
  "billcountry": "US",
  "billstate": "CA",
  "billzip": "92648",
  "billphone": "111-222-3333",
  "tracking": "Sample 36",
  "paymentmethod": "credit",
  "shippingnote": "Shipping note",
  "shippingMethodID": 1,
  "vip": true,
  "details": [
    {
      "bottleQTY": 0,
      "name": "Formula name",
      "forid": 123,
      "price": 100.12,
      "basecost": 0.0,
      "notes": "Notes",
      "type": 0,
      "supply": 90,
      "filleridnumber": "PN94203",
      "exactserving": "1",
      "numberofdoses": "1",
      "totalvolume": "30",
      "totalweight": "12.345",
      "totalservings": "90",
      "contents": [
        {
          "weight": 12.23,
          "name": "analine diphosphorus",
          "activecomponent": "analine",
          "idnumber": "PN79809",
          "unit": "mg"
        },
        {
          "weight": 12.23,
          "name": "Ethnamide",
          "activecomponent": "actamide",
          "idnumber": "PN79889",
          "unit": "mg"
        }
      ],
      "protocols": [
        {
          "id": 1,
          "name": "Elevated/upper range 3-MT",
          "quantity": 1.0
        },
        {
          "id": 2,
          "name": "Elevated/upper range DOPAC",
          "quantity": 1.0
        }
      ],
      "flavors": null,
      "locked": true,
      "isOrderable": false,
      "validateErrorMessage": ""
    }
  ]
}