Skip to main content
Anchor to CalculatedShippingLine

CalculatedShippingLine

object

Requires read_order_edits access scope.

A shipping line item involved in order editing that may be newly added or have new changes applied.

Anchor to FieldsFields

Anchor to idid
•ID

A globally-unique ID.

Anchor to priceprice
•MoneyBag!
non-null

The price of the shipping line when sold and before applying discounts. This field includes taxes if Order.taxesIncluded is true. Otherwise, this field doesn't include taxes for the shipping line.

Show fields
Anchor to stagedStatusstagedStatus
•CalculatedShippingLineStagedStatus!
non-null

The staged status of the shipping line.

Show enum values
Anchor to titletitle
•String!
non-null

The title of the shipping line.

Was this section helpful?

Anchor to MutationsMutations

Anchor to orderEditAddShippingLineorderEditAddShippingLine
•mutation

Adds a custom shipping line to an Order during an edit session. Specify the shipping title and price to create a new ShippingLine.

Returns a CalculatedOrder showing the order with edits applied but not yet saved. To save your changes, use the orderEditCommit mutation.

Learn more about editing existing orders.

Show payload

Arguments

Anchor to idid
•ID!
required

The ID of the calculated order or the order edit session to edit. This is the edit to which the shipping line is added.

Anchor to shippingLineshippingLine
•OrderEditAddShippingLineInput!
required

The shipping line to be added.

Show input fields
Was this section helpful?