Creates new order as per provided model.
1 min
POST
http://localhost:65349//api/episerver/v2.0/orders
Header Parameters
- acceptstringDescriptionDefaultapplication/jsonAllowedapplication/jsontext/jsonapplication/xmltext/xml
Body Parameters
- bodyOrderInputModelrequiredDescription
- NamestringrequiredDescription
- CustomerIdstring<uuid>ExampleDescriptionFormatuuid
- MarketstringrequiredDescription
- CurrencystringrequiredDescription
- ShipmentsShipmentModel[]Description
- Idstring<uuid>ExampleDescriptionFormatuuid
- ShippingAddressAddressModelDescription
- FirstNamestringDescription
- LastNamestringDescription
- Line1stringDescription
- Line2stringDescription
- CitystringDescription
- CountryNamestringDescription
- PostalCodestringDescription
- RegionNamestringDescription
- EmailstringDescription
- PhoneNumberstringDescription
- ShippingMethodIdstring<uuid>ExampleDescriptionFormatuuid
- LineItemsLineItemModel[]Description
- Idstring<uuid>ExampleDescriptionFormatuuid
- ContentIdstring<uuid>ExampleDescriptionFormatuuid
- CodestringDescription
- PlacedPricenumber<decimal>DescriptionFormatdecimal
- Quantitynumber<decimal>requiredDescriptionFormatdecimal
- DisplayNamestringDescription
- IsGiftbooleanDescription
- CouponCodesstring[]Description
Responses
201
- OrderApiModelDescription
- OrderNumberstringDescription
- CustomerIdstring<uuid>ExampleDescriptionFormatuuid
- MarketstringDescription
- CurrencystringDescription
- ShipmentsShipmentModel[]Description
- Idstring<uuid>ExampleDescriptionFormatuuid
- ShippingAddressAddressModelDescription
- FirstNamestringDescription
- LastNamestringDescription
- Line1stringDescription
- Line2stringDescription
- CitystringDescription
- CountryNamestringDescription
- PostalCodestringDescription
- RegionNamestringDescription
- EmailstringDescription
- PhoneNumberstringDescription
- ShippingMethodIdstring<uuid>ExampleDescriptionFormatuuid
- LineItemsLineItemModel[]Description
- Idstring<uuid>ExampleDescriptionFormatuuid
- ContentIdstring<uuid>ExampleDescriptionFormatuuid
- CodestringDescription
- PlacedPricenumber<decimal>DescriptionFormatdecimal
- Quantitynumber<decimal>requiredDescriptionFormatdecimal
- DisplayNamestringDescription
- IsGiftbooleanDescription
- TotalsTotalsModelDescription
- Totalnumber<decimal>DescriptionFormatdecimal
- SubTotalnumber<decimal>DescriptionFormatdecimal
- ShippingTotalnumber<decimal>DescriptionFormatdecimal
- HandlingTotalnumber<decimal>DescriptionFormatdecimal
- TaxTotalnumber<decimal>DescriptionFormatdecimal
- DiscountTotalnumber<decimal>DescriptionFormatdecimal
- ShippingTotalsShippingTotalsModel[]Description
- ShipmentIdstring<uuid>ExampleDescriptionFormatuuid
- ShippingCostnumber<decimal>DescriptionFormatdecimal
- ShippingTaxnumber<decimal>DescriptionFormatdecimal
- ItemsTotalnumber<decimal>DescriptionFormatdecimal
- LineItemPricesLineItemPricesModel[]Description
- LineItemIdstring<uuid>ExampleDescriptionFormatuuid
- ExtendedPricenumber<decimal>DescriptionFormatdecimal
- DiscountedPricenumber<decimal>DescriptionFormatdecimal
400
403
curl
curl --request POST \
--url http://localhost:65349//api/episerver/v2.0/orders \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '{
"Name": "",
"Market": "",
"Currency": "",
"Shipments": [
{
"LineItems": [
{
"Quantity": ""
}
]
}
]
}'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var raw = JSON.stringify({
"Name": "",
"Market": "",
"Currency": "",
"Shipments": [
{
"LineItems": [
{
"Quantity": ""
}
]
}
]
});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("http://localhost:65349//api/episerver/v2.0/orders", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://localhost:65349//api/episerver/v2.0/orders")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
"Name": "",
"Market": "",
"Currency": "",
"Shipments": [
{
"LineItems": [
{
"Quantity": ""
}
]
}
]
})
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://localhost:65349//api/episerver/v2.0/orders"
payload = json.dumps({
"Name": "",
"Market": "",
"Currency": "",
"Shipments": [
{
"LineItems": [
{
"Quantity": ""
}
]
}
]
})
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
201
// Created
{
"OrderNumber": "",
"CustomerId": "00000000-0000-0000-0000-000000000000",
"Market": "",
"Currency": "",
"Shipments": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"ShippingAddress": {
"FirstName": "",
"LastName": "",
"Line1": "",
"Line2": "",
"City": "",
"CountryName": "",
"PostalCode": "",
"RegionName": "",
"Email": "",
"PhoneNumber": ""
},
"ShippingMethodId": "00000000-0000-0000-0000-000000000000",
"LineItems": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"ContentId": "00000000-0000-0000-0000-000000000000",
"Code": "",
"PlacedPrice": "",
"Quantity": "",
"DisplayName": "",
"IsGift": false
}
]
}
],
"Totals": {
"Total": "",
"SubTotal": "",
"ShippingTotal": "",
"HandlingTotal": "",
"TaxTotal": "",
"DiscountTotal": "",
"ShippingTotals": [
{
"ShipmentId": "00000000-0000-0000-0000-000000000000",
"ShippingCost": "",
"ShippingTax": "",
"ItemsTotal": "",
"LineItemPrices": [
{
"LineItemId": "00000000-0000-0000-0000-000000000000",
"ExtendedPrice": "",
"DiscountedPrice": ""
}
]
}
]
}
}400
// Bad Request
403
// Forbidden