POST api/v1/Orders

Create new order with the specified information. Will return HTTP 400 on missing or invalid orderlines, and on invalid order type.

Request Information

URI Parameters

None.

Body Parameters

CreateOrderDto

Name	Description	Type	Additional information
Type	Type of order	string	Required Max length: 32
ExtOrderId	External id of order	string	Max length: 100
ContactId	Id of contact	integer	None.
FirstName	FirstName on the order	string	Max length: 50
LastName	LastName on the order	string	Max length: 50
Address	Address on the order	string	Max length: 250
PostCode	Postcode on the order	string	Max length: 32
City	City on the order	string	Max length: 100
Country	Country on the order	string	Max length: 100
Company	Company on the order	string	Max length: 250
StoreId	Id of store	integer	None.
OriginDate	Date of origin of the order	date	None.
StartDate	Start date of the order	date	None.
EndDate	End date of the order	date	None.
Email	Email of the order	string	Max length: 250
OrderLines	OrderLines of order	Collection of CreateOrderLineDto	None.

Request Formats

application/json, text/json

Sample:

{
  "Type": "sample string 1",
  "ExtOrderId": "sample string 2",
  "ContactId": 1,
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "Address": "sample string 5",
  "PostCode": "sample string 6",
  "City": "sample string 7",
  "Country": "sample string 8",
  "Company": "sample string 9",
  "StoreId": 1,
  "OriginDate": "2024-11-21T06:29:49.9276088+00:00",
  "StartDate": "2024-11-21T06:29:49.9276088+00:00",
  "EndDate": "2024-11-21T06:29:49.9276088+00:00",
  "Email": "sample string 10",
  "OrderLines": [
    {
      "ExtProductId": "sample string 1",
      "ImgUrl": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Quantity": 5.0,
      "Price": 6.0,
      "ContactId": 1
    },
    {
      "ExtProductId": "sample string 1",
      "ImgUrl": "sample string 2",
      "Name": "sample string 3",
      "Description": "sample string 4",
      "Quantity": 5.0,
      "Price": 6.0,
      "ContactId": 1
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReadOrderDto

Name	Description	Type	Additional information
Id	Id of order	integer	None.
Type	Type of order	string	Max length: 32
ExtOrderId	External id of order	string	Max length: 100
ContactId	Id of contact	integer	None.
FirstName	FirstName on the order	string	Max length: 50
LastName	LastName on the order	string	Max length: 50
Address	Address on the order	string	Max length: 250
PostCode	Postcode on the order	string	Max length: 32
City	City on the order	string	Max length: 100
Country	Country on the order	string	Max length: 100
Company	Company on the order	string	Max length: 250
PriceTotal	Total price of order	decimal number	None.
LastModified	Date and time of last modification of order	date	None.
StoreId	Id of store	integer	None.
OriginDate	Date of origin of the order	date	None.
StartDate	Start date of the order	date	None.
EndDate	End date of the order	date	None.
Email	Email of the order	string	Max length: 250
ContactRegistrationSource	Registration source of the order's contact	string	Max length: 50
ContactRegistrationDateTime	Registration datetime of the order's contact	date	None.
OrderLines	Orderlines of order	Collection of ReadOrderLineDto	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "Type": "sample string 2",
  "ExtOrderId": "sample string 3",
  "ContactId": 1,
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "Address": "sample string 6",
  "PostCode": "sample string 7",
  "City": "sample string 8",
  "Country": "sample string 9",
  "Company": "sample string 10",
  "PriceTotal": 11.0,
  "LastModified": "2024-11-21T06:29:49.9431653+00:00",
  "StoreId": 1,
  "OriginDate": "2024-11-21T06:29:49.9431653+00:00",
  "StartDate": "2024-11-21T06:29:49.9431653+00:00",
  "EndDate": "2024-11-21T06:29:49.9431653+00:00",
  "Email": "sample string 13",
  "ContactRegistrationSource": "sample string 14",
  "ContactRegistrationDateTime": "2024-11-21T06:29:49.9431653+00:00",
  "OrderLines": [
    {
      "Id": 1,
      "OrderId": 2,
      "ExtProductId": "sample string 3",
      "ImgUrl": "sample string 4",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Quantity": 7.0,
      "Price": 8.0,
      "PriceTotal": 9.0,
      "LastModified": "2024-11-21T06:29:49.9431653+00:00",
      "ContactRegistrationSource": "sample string 11",
      "ContactRegistrationDateTime": "2024-11-21T06:29:49.9431653+00:00"
    },
    {
      "Id": 1,
      "OrderId": 2,
      "ExtProductId": "sample string 3",
      "ImgUrl": "sample string 4",
      "Name": "sample string 5",
      "Description": "sample string 6",
      "Quantity": 7.0,
      "Price": 8.0,
      "PriceTotal": 9.0,
      "LastModified": "2024-11-21T06:29:49.9431653+00:00",
      "ContactRegistrationSource": "sample string 11",
      "ContactRegistrationDateTime": "2024-11-21T06:29:49.9431653+00:00"
    }
  ]
}