orderEditAddCustomItem mutation

Add a custom item to the order.

Required access

write_order_edits access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation orderEditAddCustomItem($id: ID!, $title: String!, $price: MoneyInput!, $quantity: Int!) { orderEditAddCustomItem(id: $id, title: $title, price: $price, quantity: $quantity) { 
  1. <font style="color:#1F61A0;">calculatedLineItem</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">calculatedOrder</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">id</font>
  11. <font style="color:#555555;">}</font>
  13. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  15.   <font style="color:#1F61A0;">field</font>
  17.   <font style="color:#1F61A0;">message</font>
  19. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “title”: “placeholder”, “price”: { 
<font style="color:#8B2BB9;">"amount"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>

<font style="color:#8B2BB9;">"currencyCode"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
}, “quantity”: 1 }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The ID of the calculated order to add an item to.
locationId
(
[ID](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

)		 The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided.
price
(
[MoneyInput!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyinput)

) REQUIRED		 The price of the custom item to add. It cannot be negative.
quantity
(
[Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)

) REQUIRED		 The quantity of the custom item to add. It must be greater than zero.
requiresShipping
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether or not the item requires shipping. Default is false.
taxable
(
[Boolean](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)

)		 Whether or not the item is taxable. Default is true.
title
(
[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)

) REQUIRED		 The name of the custom item to add.

MoneyInput fields

  • amount ([Decimal!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01)) REQUIRED
    Decimal money amount.
  • currencyCode ([CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)) REQUIRED
    Currency of the money.

Return fields

  • calculatedLineItem ([CalculatedLineItem](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedlineitem))
    The added line item.
  • calculatedOrder ([CalculatedOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder))
    An order with the edits calculated.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.