Shipping Management

Sections

Theme switcher

Update Delivery Option

Path Parameters

idstring Required

The unique identifier of the delivery option to be updated, provided as a path parameter

Body Parameters

idstring

The unique identifier of the delivery option to be updated, provided as a path parameter

orderChannelIdstring

The identifier for the sales channel or platform associated with this delivery option

indexinteger

The position or order of the delivery option in a list or sequence for display purposes

Nullable:
True
namestring

The human-readable name of the delivery option displayed to end-users

isEnabledboolean

A boolean flag indicating whether the delivery option is active and available for use

isTestboolean

A boolean flag specifying if the delivery option is in test mode and not available for live transactions

carrierIdstring

The unique identifier of the carrier responsible for the delivery service

serviceIdstring

The identifier of the specific service offered by the carrier under this delivery option

senderIdstring

The unique identifier of the sender entity associated with this delivery option

packingTypeIdstring

The unique identifier for the packing type associated with this delivery option

Nullable:
True
weightUnitstring

The unit of measurement for weight, such as 'kg' or 'lb', used to calculate shipping costs

addonsarray

Additional services or features that can be appended to the delivery option, such as insurance or signature requirements

Show child attributes

zonesarray

List of geographic zones or regions to which this delivery option applies

Show child attributes

Response

200
Object
OK

Response Attributes

idstring

Unique identifier of the delivery option being updated

orderChannelIdstring

Identifier for the sales channel or platform linked to the delivery option

indexinteger

Position or order of the delivery option within a list for display or processing

Nullable:
True
namestring

Descriptive name of the delivery option displayed to users

isEnabledboolean

Indicates whether the delivery option is currently active and available for selection

isTestboolean

Specifies if the delivery option is in test mode and not applicable for live transactions

carrierIdstring

Unique identifier of the carrier responsible for the delivery option

serviceIdstring

Identifier of the specific delivery service used within the option

senderIdstring

Unique identifier of the sender associated with the delivery option

packingTypeIdstring

Identifier representing the type of packaging used for shipments with this delivery option

Nullable:
True
weightUnitinteger

Unit of measurement used for package weight (e.g., kg, lb)

addonsarray

Optional supplementary services or features that can be added to the delivery option

Show child attributes

zonesarray

A list of geographic zones where the delivery option is applicable and can be selected by users

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

PUT

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?

View as Markdown

Ask an AI

Open in ChatGPTOpen in ClaudeOpen in Perplexity

Code with AI

Open in Copilot