CreateOrder

post

https://{yourlidiaurl}/order/orders/create

Creates a new order with the specified lines, owner, and checkout process information.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The order creation details including lines, owner, and optional checkout process data.

orderId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the order id.

sourceOrderId

string | null

Gets or sets the source order id.

parentOrderId

string | null

Gets or sets the parent order id.

orderRefNumber

string | null

Gets or sets the order ref number.

currency

string | null

Gets or sets the currency.

currencyRate

string

^-?(?:0|[1-9]\d*)$

Currency rate x 100

state

string

enum

Allowed values: Draft (0), Pending (1), New (2), InProgress (3), Collected (4), Invoiced (5), Shipped (6), Delivered (7), Fulfilled (100), Deleted (-999), Not_Delivered (-997), Returned (-995), Cancelled (-992), Expired (-99).

isCalculated

boolean | null

Gets or sets the is calculated.

isTaxIncluded

boolean | null

Gets or sets the is tax included.

total

string

^-?(?:0|[1-9]\d*)$

Order total x 100

orderDate

string | null

Gets or sets the order date.

checkoutProcess

object

owner

object

properties

array of objects | null

Gets or sets the list of custom properties for the order.

properties

tags

lines

array of objects | null

Gets or sets the list of order lines (products/items).

lines

fees

array of objects | null

Gets or sets the list of fees applied to the order.

fees

discounts

array of objects | null

Gets or sets the list of discounts applied to the order.

discounts

transactions

array of objects | null

Gets or sets the list of payment transactions for the order.

transactions

environment

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

Gets or sets the session identifier of the current user session.

userId

string

^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

userEmail

string | null

Gets or sets the email address of the user performing the operation.

threadId

string | null

Gets or sets the thread identifier for request tracing and correlation.

status

string

enum

Allowed values: Draft (0), Active (1), Unknown (-999), Deleted (-99), Blocked (-12), Freezed (-11), Test (-9), Passive (-1).

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

text/plain

application/json

text/json

200The newly created order.