API Reference
  1. Lidia Order
  2. Order > OrderProcesses > InitiateOrderProcess

InitiateOrderProcess

post
https://{yourlidiaurl}/order/orders/processes/initiate

Initiates a new order process (e.g., return, exchange, cancellation).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The process details including type, reason, and affected order lines.

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

Gets or sets the process id.

string | null

Gets or sets the process code.

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

Gets or sets the order id.

string | null

Gets or sets the ref number.

boolean | null

Gets or sets the update delivery.

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

Gets or sets the delivery id.

string | null

Gets or sets the code.

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

Gets or sets the supplier id.

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

Gets or sets the process total.

string
enum

Allowed values: None (0), Needs_State_Update (10), Needs_Refund (20).

Allowed:
boolean

Gets or sets the ignore warning.

date-time | null

Gets or sets the completed.

string
enum

Allowed values: Buyer (0), Seller (1), Platform (2), Network (3).

Allowed:
newDelivery
object
existingDelivery
object
approvedLines
array of objects | null

Gets or sets the list of approved line IDs for this process.

approvedLines
lines
array of objects | null

Gets or sets the list of process lines.

lines
properties
array of objects | null

Gets or sets the list of custom properties.

properties
tags
array of objects | null

Gets or sets the list of tags.

tags
string | null

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

string | null

Gets or sets the IP address of the calling application.

string | null

Gets or sets the user token for authentication context.

string | null

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

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

Gets or sets the numeric user identifier.

string | null

Gets or sets the IP address of the requesting user.

string | null

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

string | null

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

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:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 17 days ago

Did this page help you?