Creates new order as per provided model.

Cannot find corresponding spec file for this API version.

post https://example.com/api/episerver/v3.0/me/orders

New Requests

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

name

string | null

The order name.

orderNumber

string | null

The order number.

customerId

string

The customer the order belongs to.

market

string | null

The market in which the order was placed.

currency

string | null

The currency of the market in which the order was placed.

shipments

array of objects | null

The shipments of the order.

shipments

object

int32

The shipping id.

shippingAddress

object

Represents a customer address
todo: associate with commerce customers via business foundation?
todo: add more properties.

shippingMethodId

string

The shipping method id.

lineItems

array of objects | null

the line items that belong to the cart.

lineItems

object

int32

The line item id.

contentId

string

The content id.

code

string | null

The sku code.

placedPrice

number

The placed price.

quantity

number

required

The quantity.

displayName

string | null

The display name.

isGift

boolean

Indicates whether the line item is a gift item.

payments

array of objects | null

The payments of the order.

payments

object

amount

number

Gets or sets the amount.

authorizationCode

string | null

Gets or sets the authorization code.

billingAddress

object

Represents a customer address
todo: associate with commerce customers via business foundation?
todo: add more properties.

savedBillingAddressName

string | null

Gets or sets the billing address.

customerName

string | null

Gets or sets the name of the customer.

paymentId

int32

Gets the payment identifier.

systemKeyword

string | null

Gets or sets the name of the payment method.

paymentType

string | null

Gets or sets the type of the payment.

providerTransactionID

string | null

Gets or sets the provider transaction identifier.

status

string | null

Gets or sets the status.

transactionID

string | null

Gets or sets the transaction identifier.

transactionType

string | null

Gets or sets the type of the transaction.

validationCode

string | null

Gets or sets the validation code.

extendedProperties

array of objects | null

Custom properties added by partner or customer.

extendedProperties

object

name

string | null

Name of the property

value

string | null

The property value.

totals

object

Represents cart totals.

total

number

The total.

subTotal

number

The subtotal.

shippingTotal

number

The shipping total.

handlingTotal

number

The handling total.

taxTotal

number

The tax total.

discountTotal

number

The order form discount total.

shippingTotals

array of objects | null

The shipping totals.

shippingTotals

object

shipmentId

int32

The shipping id.

shippingCost

number

The shipping cost.

shippingTax

number

The shipping tax.

itemsTotal

number

The extended price total for the line items in the shipment.

lineItemPrices

array of objects | null

The line item prices.

lineItemPrices

object

lineItemId

int32

The line item id.

extendedPrice

number

The extended price.

discountedPrice

number

The discounted price.

lastUpdated

date-time

The last updated timestamp.

orderDate

date-time

The order date

couponCodes

array of strings | null

The coupon codes.

couponCodes

201

Created

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/api/episerver/v3.0/me/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Select from the Examples drop-down list.

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Creates new order as per provided model.

200Success

400Bad Request

403Forbidden