OrderShippingMethodDTO

Properties

idstringRequired

The ID of the shipping method

order_idstringRequired

The ID of the associated order

namestringRequired

The name of the shipping method

amountBigNumberValueRequired

The price of the shipping method

raw_amountBigNumberRawValueRequired

The raw price of the shipping method

is_tax_inclusivebooleanRequired

Whether the shipping method price is tax inclusive or not

created_atstring | DateRequired

When the shipping method was created.

updated_atstring | DateRequired

When the shipping method was updated.

original_totalBigNumberValueRequired

The original total of the order shipping method.

original_subtotalBigNumberValueRequired

The original subtotal of the order shipping method.

original_tax_totalBigNumberValueRequired

The original tax total of the order shipping method.

totalBigNumberValueRequired

The total of the order shipping method.

subtotalBigNumberValueRequired

The subtotal of the order shipping method.

tax_totalBigNumberValueRequired

The tax total of the order shipping method.

discount_totalBigNumberValueRequired

The discount total of the order shipping method.

discount_tax_totalBigNumberValueRequired

The discount tax total of the order shipping method.

raw_original_totalBigNumberRawValueRequired

The raw original total of the order shipping method.

raw_original_subtotalBigNumberRawValueRequired

The raw original subtotal of the order shipping method.

raw_original_tax_totalBigNumberRawValueRequired

The raw original tax total of the order shipping method.

raw_totalBigNumberRawValueRequired

The raw total of the order shipping method.

raw_subtotalBigNumberRawValueRequired

The raw subtotal of the order shipping method.

raw_tax_totalBigNumberRawValueRequired

The raw tax total of the order shipping method.

raw_discount_totalBigNumberRawValueRequired

The raw discount total of the order shipping method.

raw_discount_tax_totalBigNumberRawValueRequired

The raw discount tax total of the order shipping method.

descriptionstring

The description of the shipping method

shipping_option_idstring

The ID of the shipping option the method was created from

dataRecord<string, unknown>

Additional data needed for fulfillment.

metadatanull | Record<string, unknown>

Holds custom data in key-value pairs.

tax_linesOrderShippingMethodTaxLineDTO[]

The associated tax lines.

adjustmentsOrderShippingMethodAdjustmentDTO[]

The associated adjustments.