shipping_method

Properties

Anchor to

discount_allocations

array of discount_allocation

The discount allocations that apply to the shipping method.

Anchor to

handle

string

The handle of the shipping method.

Note

The price of the shipping method is appended to handle.

Anchor to

id

string

The ID of the shipping method.

Anchor to

original_price

number

The price of the shipping method in the currency's subunit, before discounts have been applied.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted price.

Anchor to

price_with_discounts

number

The price of the shipping method in the currency's subunit, after discounts have been applied, including order level discounts.

The value is output in the customer's local (presentment) currency.

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted price.

Anchor to

tax_lines

array of tax_line

The tax lines for the shipping method.

Anchor to

title

string

The title of the shipping method.

In most contexts, the shipping method title appears in the customer's preferred language. However, in the context of an order, the shipping method title appears in the language that the customer checked out in.