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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the 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.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The ID of the calculated order to add an item to. |
locationId
(
ID
)
|
The ID of the location that this item will be fulfilled from. A default will be chosen automatically if none is provided. |
price
(
MoneyInput!
)
required
|
The price of the custom item to add. It cannot be negative. |
quantity
(
Int!
)
required
|
The quantity of the custom item to add. It must be greater than zero. |
requiresShipping
(
Boolean
)
|
Whether or not the item requires shipping. Default is false. |
taxable
(
Boolean
)
|
Whether or not the item is taxable. Default is true. |
title
(
String!
)
required
|
The name of the custom item to add. |
MoneyInput fields
-
amount (
Decimal!
) RequiredDecimal money amount.
-
currencyCode (
CurrencyCode!
) RequiredCurrency of the money.
Return fields
-
calculatedLineItem (
CalculatedLineItem
)The added line item.
-
calculatedOrder (
CalculatedOrder
)An order with the edits calculated.
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.