Choose a version:

orderEditAddCustomItem

mutation

Requires write_order_edits access scope. Also: To use the GraphQL Admin API to edit orders, your app needs to request the write_order_edits access scope for a Shopify store.

Adds a custom line item to an existing Order. Custom line items represent products or services not in your catalog, such as gift wrapping, installation fees, or one-off charges.

Creates a CalculatedLineItem with the specified title, price, and quantity. Changes remain in the edit session until you commit them with the orderEditCommit mutation.

Learn more about adding custom line items.

Anchor to Arguments

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 custom item is added.

Anchor to locationIdlocationId

•ID

The ID of the retail location (if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.

Anchor to priceprice

•MoneyInput!

required

The unit price of the custom item. This value can't be negative.

Anchor to quantityquantity

•Int!

required

The quantity of the custom item. This value must be greater than zero.

Anchor to requiresShippingrequiresShipping

•Boolean

Whether the custom item requires shipping. Defaults to false.

Anchor to taxabletaxable

•Boolean

Whether the custom item is taxable. Defaults to true.

Anchor to titletitle

•String!

required

The name of the custom item to add.

Was this section helpful?

Anchor to OrderEditAddCustomItemPayload returnsOrderEditAddCustomItemPayload returns

Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The custom line item that will be added to the order based on the current edits.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

orderEditAddCustomItem reference

Mutation Reference

mutation orderEditAddCustomItem($id: ID!, $title: String!, $locationId: ID, $price: MoneyInput!, $quantity: Int!, $taxable: Boolean, $requiresShipping: Boolean) {

orderEditAddCustomItem(id: $id, title: $title, locationId: $locationId, price: $price, quantity: $quantity, taxable: $taxable, requiresShipping: $requiresShipping) {

calculatedLineItem {

# CalculatedLineItem fields

}

calculatedOrder {

# CalculatedOrder fields

}

orderEditSession {

# OrderEditSession fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"title": "<your-title>",

"locationId": "gid://shopify/<objectName>/10079785100",

"price": {

"amount": "29.99",

"currencyCode": "USD"

"quantity": 1,

"taxable": true,

"requiresShipping": true

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "title": "<your-title>",
  "locationId": "gid://shopify/<objectName>/10079785100",
  "price": {
    "amount": "29.99",
    "currencyCode": "USD"
  },
  "quantity": 1,
  "taxable": true,
  "requiresShipping": true
}

Schema

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}