UpdateDelivery

post

https://{yourlidiaurl}/delivery/deliveries/update

Updates the shipping address, package contents, or instructions for an existing delivery record.

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 command.

deliveryId

string

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

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

deliveryCode

string | null

Gets or sets the delivery code configuration value.

orderId

string

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

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

trackingNumber

string | null

Gets or sets the tracking number configuration value.

cancelationDescription

string | null

Gets or sets the cancelation description configuration value.

notes

string | null

Gets or sets the notes configuration value.

trackingUrl

string | null

Gets or sets the tracking url configuration value.

providerId

string

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

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

channelId

string

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

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

warehouseId

string

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

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

channelCode

string | null

Gets or sets the channel code configuration value.

senderAddressId

string | null

The unique database identifier linking this record to the target sender address.

recipientAddressId

string | null

The unique database identifier linking this record to the target recipient address.

isReset

boolean

Gets or sets the is reset configuration value.

expirationDate

string

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

Gets or sets the expiration date configuration value.

paymentType

string

enum

Allowed values: Sender (10), Receiver (20), Consignee (30).

Allowed:

type

string

enum

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

state

string

enum

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

Allowed:

deliveryDate

date-time

Gets or sets the delivery date configuration value.

processType

string

enum

Allowed values: OnlySplit (0), CreateDelivery (1), CreateWithIntegration (2).

Allowed:

businnesType

string

enum

Allowed values: Standard (0), Marketplace (1).

Allowed:

sender

object

receiver

object

params

object | null

organizationId

string

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

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

merchantName

string | null

Gets or sets the merchant name 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

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

200An IActionResult indicating the operation outcome.