AddDeliveryLog

post

https://{yourlidiaurl}/delivery/deliveries/deliverylog/create

Executes the adddeliverylog delivery workflow execution.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input command payload containing target properties.

Command request payload containing variables required to execute delivery log command.

entryId

string

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

The unique database identifier linking this record to the target entry.

orderId

string | null

The unique database identifier linking this record to the target order.

deliveryId

string

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

The unique database identifier linking this record to the target delivery.

packageId

string

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

The unique database identifier linking this record to the target package.

summary

string | null

Gets or sets the summary configuration value.

details

string | null

Gets or sets the details configuration value.

change

string | null

Gets or sets the change configuration value.

eventType

string

enum

Allowed values: Initiated (101), AtOrigin (102), InTransit (103), AtDestinationHub (104), OutForDelivery (105), PartialDelivery (106), Undelivered (107), UndeliveredAndInTransit (108), UndeliveredAndAtDestinationHub (109), UndeliveredAndOutForDelivery (110), UndeliveredAndReturned (111), Lost (112), Progress (301), Completed (401), Returning (501), BarcodeCreate (601), Deleted (-999), Unknown (-301), Error (-201), Cancelled (-101).

fromState

toState

string

enum

Allowed values: Pending (0), Ready (10), Delivery (20), Returning (21), Returned (30), Delivered (40), Cancelled (-10).

Allowed:

eventDate

date-time | null

Gets or sets the event date configuration value.

notes

string | null

Gets or sets the notes configuration value.

activityDate

date-time | null

Gets or sets the activity date configuration value.

data

string | null

Gets or sets the data configuration value.

rollbackData

string | null

Gets or sets the rollback data configuration value.

applicationIP

string | null

Gets or sets the application ip configuration value.

userToken

string | null

Gets or sets the user token configuration value.

sessionId

string | null

The unique database identifier linking this record to the target session.

userId

string

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

The unique database identifier linking this record to the target user.

userIP

string | null

Gets or sets the user ip configuration value.

threadId

string | null

A correlation token used to track logs across async thread transitions.

status

string

enum

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

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

200

An IActionResult indicating the operation outcome.

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here!