MoneyInput

input_object

The input fields for a monetary value with currency.

Anchor to FieldsFields

Anchor to amountamount • Decimal!non-null: Decimal money amount.
Anchor to currencyCodecurrencyCode • CurrencyCode!non-null: Currency of the money.

Was this section helpful?

Anchor to Mutations using this inputMutations using this input

Anchor to appPurchaseOneTimeCreate.price appPurchaseOneTimeCreate.price • MUTATION
Anchor to appSubscriptionLineItemUpdate.cappedAmount appSubscriptionLineItemUpdate.cappedAmount • MUTATION
Anchor to appUsageRecordCreate.price appUsageRecordCreate.price • MUTATION
Anchor to orderCreateMandatePayment.amount orderCreateMandatePayment.amount • MUTATION
Anchor to orderEditAddCustomItem.price orderEditAddCustomItem.price • MUTATION

Was this section helpful?

Anchor to Input objects using this inputInput objects using this input

Anchor to AppRecurringPricingInput.price AppRecurringPricingInput.price • INPUT OBJECT: The amount to be charged to the store every billing interval.
Anchor to AppUsagePricingInput.cappedAmount AppUsagePricingInput.cappedAmount • INPUT OBJECT: The maximum amount of usage charges that can be incurred within a subscription billing interval.
Anchor to DeliveryParticipantInput.fixedFee DeliveryParticipantInput.fixedFee • INPUT OBJECT: The fixed feed that's defined by the merchant for this participant.
Anchor to DeliveryPriceConditionInput.criteria DeliveryPriceConditionInput.criteria • INPUT OBJECT: The monetary value to compare the price of an order to.
Anchor to DeliveryRateDefinitionInput.price DeliveryRateDefinitionInput.price • INPUT OBJECT: The price of the rate definition.
Anchor to DraftOrderAppliedDiscountInput.amountWithCurrency DraftOrderAppliedDiscountInput.amountWithCurrency • INPUT OBJECT: The applied amount of the discount in the specified currency.
Anchor to DraftOrderLineItemInput.originalUnitPriceWithCurrency DraftOrderLineItemInput.originalUnitPriceWithCurrency • INPUT OBJECT: The price in presentment currency, without any discounts applied, for a custom line item. If this value is provided, original_unit_price will be ignored. This field is ignored when variantId is provided. Note: All presentment currencies for a single draft should be the same and match the presentment currency of the draft order.
Anchor to DraftOrderLineItemInput.priceOverride DraftOrderLineItemInput.priceOverride • INPUT OBJECT: The price override for the line item. Should be set in presentment currency.

This price will be used in place of the product variant's catalog price in this draft order.

If the override's presentment currency doesn't match the draft order's presentment currency, it will be converted over to match the draft order's presentment currency. This will occur if the input is defined in a differing currency, or if some other event causes the draft order's currency to change.

Price overrides can't be applied to bundle components. If this line item becomes part of a bundle the price override will be removed. In the case of a cart transform, this may mean that a price override is applied to this line item earlier in its lifecycle, and is removed later when the transform occurs.
Anchor to ExchangeLineItemAppliedDiscountValueInput.amount ExchangeLineItemAppliedDiscountValueInput.amount • INPUT OBJECT: The value of the discount as a fixed amount.
Anchor to GiftCardCreditInput.creditAmount GiftCardCreditInput.creditAmount • INPUT OBJECT: The amount to credit the gift card.
Anchor to GiftCardDebitInput.debitAmount GiftCardDebitInput.debitAmount • INPUT OBJECT: The amount to debit the gift card.
Anchor to MarketingActivityBudgetInput.total MarketingActivityBudgetInput.total • INPUT OBJECT: Amount of budget for the marketing activity.
Anchor to MarketingActivityCreateExternalInput.adSpend MarketingActivityCreateExternalInput.adSpend • INPUT OBJECT: The amount spent on the marketing activity.
Anchor to MarketingActivityUpdateExternalInput.adSpend MarketingActivityUpdateExternalInput.adSpend • INPUT OBJECT: The amount spent on the marketing activity.
Anchor to MarketingActivityUpsertExternalInput.adSpend MarketingActivityUpsertExternalInput.adSpend • INPUT OBJECT: The amount spent on the marketing activity.
Anchor to MarketingEngagementInput.adSpend MarketingEngagementInput.adSpend • INPUT OBJECT: The total ad spend for the marketing content. Recurring weekly, monthly, or yearly spend needs to be divided into daily amounts.
Anchor to MarketingEngagementInput.sales MarketingEngagementInput.sales • INPUT OBJECT: The amount of sales generated from the marketing content.
Anchor to MoneyBagInput.shopMoney MoneyBagInput.shopMoney • INPUT OBJECT: Amount in shop currency.
Anchor to MoneyBagInput.presentmentMoney MoneyBagInput.presentmentMoney • INPUT OBJECT: Amount in presentment currency. If this isn't given then we assume that the presentment currency is the same as the shop's currency.
Anchor to OrderEditAddShippingLineInput.price OrderEditAddShippingLineInput.price • INPUT OBJECT: The price of the shipping line.
Anchor to OrderEditAppliedDiscountInput.fixedValue OrderEditAppliedDiscountInput.fixedValue • INPUT OBJECT: The value of the discount as a fixed amount.
Anchor to OrderEditUpdateShippingLineInput.price OrderEditUpdateShippingLineInput.price • INPUT OBJECT: The price of the shipping line.
Anchor to PriceListPriceInput.price PriceListPriceInput.price • INPUT OBJECT: The price of the product variant on this price list.
Anchor to PriceListPriceInput.compareAtPrice PriceListPriceInput.compareAtPrice • INPUT OBJECT: The compare-at price of the product variant on this price list.
Anchor to PriceListProductPriceInput.price PriceListProductPriceInput.price • INPUT OBJECT: The price of the product to use for all variants with its currency.
Anchor to QuantityPriceBreakInput.price QuantityPriceBreakInput.price • INPUT OBJECT: The price of the product variant when its quantity meets the break's minimum quantity.
Anchor to RefundShippingInput.shippingRefundAmount RefundShippingInput.shippingRefundAmount • INPUT OBJECT: The input fields required to refund shipping cost, in the presentment currency of the order. This overrides the fullRefund argument. This field defaults to 0.00 when not provided and when the fullRefund argument is false.
Anchor to ReturnRefundOrderTransactionInput.transactionAmount ReturnRefundOrderTransactionInput.transactionAmount • INPUT OBJECT: The amount of money for the transaction in the presentment currency of the order.
Anchor to ReturnShippingFeeInput.amount ReturnShippingFeeInput.amount • INPUT OBJECT: The value of the fee as a fixed amount in the presentment currency of the order.
Anchor to ShippingLineInput.priceWithCurrency ShippingLineInput.priceWithCurrency • INPUT OBJECT: Price of the shipping rate with currency. If provided, price will be ignored.
Anchor to StoreCreditAccountCreditInput.creditAmount StoreCreditAccountCreditInput.creditAmount • INPUT OBJECT: The amount to credit the store credit account.
Anchor to StoreCreditAccountDebitInput.debitAmount StoreCreditAccountDebitInput.debitAmount • INPUT OBJECT: The amount to debit the store credit account.
Anchor to MarketingActivityUpdateInput.adSpend MarketingActivityUpdateInput.adSpend • INPUT OBJECTDeprecated: The cumulative amount spent on the marketing activity.

Was this section helpful?