orderEditAddCustomItem
Requires access scope. Also: To use the GraphQL Admin API to edit orders, your app needs to request the access scope for a Shopify store.
Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.
Arguments
- •ID!required
The ID of the calculated order to which the custom item is added.
- Anchor to locationIdlocation•
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•Money
Input! 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 requiresShippingrequires•
Shipping Whether the custom item requires shipping. Defaults to
false.- Anchor to taxabletaxable•
Whether the custom item is taxable. Defaults to
true.- Anchor to titletitle•String!required
The name of the custom item to add.
Anchor to OrderEditAddCustomItemPayload returnsOrderEditAddCustomItemPayload returns
- Anchor to calculatedLineItemcalculated•
Line Item The custom line item that will be added to the order based on the current edits.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]! non-null The list of errors that occurred from executing the mutation.