Skip to main content
Shopify.devShopify.devDocs
Log inSign up
Anchor to ShippingLineInput

ShippingLineInput

input_object

The input fields for specifying the shipping details for the draft order.

Note

A custom shipping line includes a title and price with shippingRateHandle set to nil. A shipping line with a carrier-provided shipping rate (currently set via the Shopify admin) includes the shipping rate handle.

Anchor to FieldsFields

Anchor to priceWithCurrencypriceWithCurrency
•
MoneyInput

Price of the shipping rate with currency. If provided, price will be ignored.

Anchor to shippingRateHandleshippingRateHandle
•
String

A unique identifier for the shipping rate.

Anchor to titletitle
•
String

Title of the shipping rate.

Anchor to priceprice
•
MoneyDeprecated

Price of the shipping rate in shop currency. priceWithCurrency should be used instead, where currencies can be specified.

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to DraftOrderInput.shippingLineDraftOrderInput.shippingLine
•
INPUT OBJECT

The shipping line object, which details the shipping method used.

Was this section helpful?