Creates an order.

post https://example.com/episerverapi/commerce/orders

Responses

Response body

object

addressId

string | null

affiliateId

uuid

billingCurrency

string | null

customerId

uuid

customerName

string | null

handlingTotal

double

instanceId

uuid

marketId

string | null

name

string

required

orderAddresses

array of objects | null

orderAddresses

object

orderGroupAddressId

int32

name

string | null

firstName

string | null

lastName

string | null

organization

string | null

line1

string | null

line2

string | null

city

string | null

state

string | null

countryCode

string | null

countryName

string | null

postalCode

string | null

regionCode

string | null

regionName

string | null

daytimePhoneNumber

string | null

eveningPhoneNumber

string | null

faxNumber

string | null

properties

array of objects | null

properties

object

key

string | null

value

string | null

orderForms

array of objects | null

orderForms

object

shipments

array of objects | null

shipments

object

discountsModel

array of objects | null

discountsModel

object

discountId

int32

discountAmount

double

discountCode

string | null

discountName

string | null

displayMessage

string | null

discountValue

double

shipmentId

int32

shippingMethodId

uuid

shippingMethodName

string | null

shippingTax

double

shippingAddressId

string | null

shipmentTrackingNumber

string | null

shippingDiscountAmount

double

shippingSubTotal

double

shippingTotal

double

status

string | null

prevStatus

string | null

pickListId

int32 | null

subTotal

double

warehouseCode

string | null

lineItems

array of objects | null

lineItems

object

lineItemId

int32

code

string | null

displayName

string | null

placedPrice

double

extendedPrice

double

discountedPrice

double

quantity

double

returnQuantity

double

inventoryTrackingStatus

int32

isInventoryAllocated

boolean

isGift

boolean

properties

array of objects | null

properties

object

key

string | null

value

string | null

properties

array of objects | null

properties

object

key

string | null

value

string | null

lineItems

array of objects | null

lineItems

object

lineItemId

int32

code

string | null

displayName

string | null

placedPrice

double

extendedPrice

double

discountedPrice

double

quantity

double

returnQuantity

double

inventoryTrackingStatus

int32

isInventoryAllocated

boolean

isGift

boolean

properties

array of objects | null

properties

object

key

string | null

value

string | null

payments

array of objects | null

payments

object

amount

double

authorizationCode

string | null

billingAddressId

string | null

customerName

string | null

implementationClass

string | null

paymentId

int32

paymentMethodId

uuid

paymentMethodName

string | null

paymentTypeModel

int32

status

string | null

transactionType

string | null

validationCode

string | null

transactionID

string | null

providerTransactionID

string | null

properties

array of objects | null

properties

object

key

string | null

value

string | null

discounts

array of objects | null

discounts

object

discountId

int32

discountAmount

double

discountCode

string | null

discountName

string | null

displayMessage

string | null

discountValue

double

returnComment

string | null

returnType

string | null

returnAuthCode

string | null

orderFormId

int32

name

string | null

billingAddressId

string | null

shippingTotal

double

handlingTotal

double

taxTotal

double

discountAmount

double

subTotal

double

total

double

status

string | null

rmaNumber

string | null

authorizedPaymentTotal

double

capturedPaymentTotal

double

properties

array of objects | null

properties

object

key

string | null

value

string | null

orderGroupId

int32

orderNotes

array of objects | null

orderNotes

object

orderNoteId

int32 | null

created

date-time

customerId

uuid

detail

string | null

title

string | null

type

string | null

lineItemId

int32 | null

owner

string | null

ownerOrg

string | null

providerId

string | null

shippingTotal

double

status

string | null

subTotal

double

taxTotal

double

total

double

modified

date-time

created

date-time

properties

array of objects | null

properties

object

key

string | null

value

string | null

orderNumber

string | null

returnForms

array of objects | null

returnForms

object

shipments

array of objects | null

shipments

object

discountsModel

array of objects | null

discountsModel

object

discountId

int32

discountAmount

double

discountCode

string | null

discountName

string | null

displayMessage

string | null

discountValue

double

shipmentId

int32

shippingMethodId

uuid

shippingMethodName

string | null

shippingTax

double

shippingAddressId

string | null

shipmentTrackingNumber

string | null

shippingDiscountAmount

double

shippingSubTotal

double

shippingTotal

double

status

string | null

prevStatus

string | null

pickListId

int32 | null

subTotal

double

warehouseCode

string | null

lineItems

array of objects | null

lineItems

object

lineItemId

int32

code

string | null

displayName

string | null

placedPrice

double

extendedPrice

double

discountedPrice

double

quantity

double

returnQuantity

double

inventoryTrackingStatus

int32

isInventoryAllocated

boolean

isGift

boolean

properties

array of objects | null

properties

object

key

string | null

value

string | null

properties

array of objects | null

properties

object

key

string | null

value

string | null

lineItems

array of objects | null

lineItems

object

lineItemId

int32

code

string | null

displayName

string | null

placedPrice

double

extendedPrice

double

discountedPrice

double

quantity

double

returnQuantity

double

inventoryTrackingStatus

int32

isInventoryAllocated

boolean

isGift

boolean

properties

array of objects | null

properties

object

key

string | null

value

string | null

payments

array of objects | null

payments

object

amount

double

authorizationCode

string | null

billingAddressId

string | null

customerName

string | null

implementationClass

string | null

paymentId

int32

paymentMethodId

uuid

paymentMethodName

string | null

paymentTypeModel

int32

status

string | null

transactionType

string | null

validationCode

string | null

transactionID

string | null

providerTransactionID

string | null

properties

array of objects | null

properties

object

key

string | null

value

string | null

discounts

array of objects | null

discounts

object

discountId

int32

discountAmount

double

discountCode

string | null

discountName

string | null

displayMessage

string | null

discountValue

double

returnComment

string | null

returnType

string | null

returnAuthCode

string | null

orderFormId

int32

name

string | null

billingAddressId

string | null

shippingTotal

double

handlingTotal

double

taxTotal

double

discountAmount

double

subTotal

double

total

double

status

string | null

rmaNumber

string | null

authorizedPaymentTotal

double

capturedPaymentTotal

double

properties

array of objects | null

properties

object

key

string | null

value

string | null

originalOrderFormId

int32 | null

exchangeOrderGroupId

int32 | null

400

401

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/episerverapi/commerce/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/*+json'

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Creates an order.

200