ChangeDeliveryState

post

https://{yourlidiaurl}/order/orders/deliveries/update/state

Changes the state of an existing delivery.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The delivery identifier and the new state.

deliveryId

string

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

Gets or sets the delivery id.

orderId

string

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

Gets or sets the order id.

refNumber

string | null

Gets or sets the ref number.

orderCode

string | null

Gets or sets the order code.

orderLineId

string

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

Gets or sets the order line id.

orderLineCode

string | null

Gets or sets the order line code.

processId

string

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

Gets or sets the process id.

processCode

string | null

Gets or sets the process code.

deliveryChannel

string | null

Gets or sets the delivery channel.

deliveryCode

string | null

Gets or sets the delivery code.

sourceDeliveryCode

string | null

Gets or sets the source delivery code.

trackingNumber

string | null

Gets or sets the tracking number.

trackingUrl

string | null

Gets or sets the tracking url.

state

type

string

enum

Allowed values: Cargo (10), MerchantCargo (11), Logistic (20), MerchantLogistic (21), SelfDelivery (30), DeliveryWithIntegration (31), Return (40), MerchantReturn (41), BuyerReturn (42).

eventDetails

string | null

Gets or sets the event details.

streetAddress

string | null

Gets or sets the street address.

neighborhood

string | null

Gets or sets the neighborhood.

district

string | null

Gets or sets the district.

postalCode

string | null

Gets or sets the postal code.

city

string | null

Gets or sets the city.

country

string | null

Gets or sets the country.

recipient

string | null

Gets or sets the recipient.

contactPhone

string | null

Gets or sets the contact phone.

sender

object

receiver

object

properties

array of objects | null

Gets or sets the list of custom properties for this delivery.

properties

tags

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 delivery with the updated state.