Order APIs

Give merchants new ways to receive, process, and manage their orders.

In this section

• Attribute — Represents a generic custom attribute.

• AttributeInput — Specifies the input fields required for an attribute.

• AutomaticDiscountApplication — Automatic discount applications capture the intentions of a discount that was automatically applied.

• CalculatedAutomaticDiscountApplication — Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

• CalculatedDiscountAllocation — An amount discounting the line that has been allocated by an associated discount application.

• CalculatedDiscountApplication — An auto-generated type for paginating through multiple CalculatedDiscountApplications.

• CalculatedDiscountCodeApplication — Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

• CalculatedDraftOrder — The computed properties for a draft order.

• CalculatedDraftOrderLineItem — The computed line items for a draft order.

• CalculatedLineItem — A line item involved in order editing that may be newly added or have new changes applied.

• CalculatedManualDiscountApplication — Manual discount applications capture the intentions of a discount that was manually created for an order.

• CalculatedOrder — An order with edits applied but not saved.

• CalculatedScriptDiscountApplication — Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

• CurrencySetting — Represents a currency setting.

• DiscountAllocation — An amount discounting the line that has been allocated by an associated discount application.

• DiscountApplication — An auto-generated type for paginating through multiple DiscountApplications.

• DiscountApplicationAllocationMethod — The method by which the discount’s value is allocated onto its entitled lines.

• DiscountApplicationLevel — The method by which the discount’s value is allocated onto its entitled lines.

• DiscountApplicationTargetSelection — Which lines on the order that the discount is allocated over, of the type defined by the Discount Application’s target_type.

• DiscountApplicationTargetType — The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.

• DiscountCodeApplication — Discount code applications capture the intentions of a discount code at the time that it is applied onto an order.

• DiscountTargetType — The type of line a subscription discount is applied on.

• DiscountType — The original type of the discount.

• DraftOrder — Represents a draft order. Merchants can use draft orders to create orders on behalf of their customers.

• DraftOrderAppliedDiscount — The order-level discount applied to a draft order.

• DraftOrderAppliedDiscountInput — The input fields for applying an order-level discount to a draft order.

• DraftOrderAppliedDiscountType — The valid discount types that can be applied to a draft order.

• DraftOrderDeleteInput — Specifies the draft order to delete by its ID.

• DraftOrderInput — The input fields used to create or update a draft order.

• DraftOrderLineItem — Represents a line item included in a draft order.

• DraftOrderLineItemInput — The input fields used to create a line item for a draft order.

• DraftOrderSortKeys — The set of valid sort keys for the DraftOrder query.

• DraftOrderStatus — The valid statuses for a draft order.

• Duty — Represents a single duty for a line item.

• EmailInput — Specifies the fields for an email.

• LineItem — Represents a single line in a shopping cart.

• LineItemMutable — Represents a single line in a shopping cart.

• LineItemSellingPlan — Represents the selling plan for a line item.

• ManualDiscountApplication — Manual discount applications capture the intentions of a discount that was manually created for an order.

• Order — An order represents an agreement to do business between a customer and a merchant.

• OrderAdjustment — An order adjustment accounts for refunded shipping costs or the difference between calculated and actual refund amount.

• OrderAdjustmentKind — The different kinds of order adjustments.

• OrderCancelReason — Represents the reason that the order is being canceled. Valid values are: customer, fraud, inventory, declined, other.

• OrderCaptureInput — Specifies the authorized transaction to capture and the total amount to capture from it.

• OrderCloseInput — Specifies an open order to close.

• OrderDisplayFinancialStatus — Represents the order’s current financial status.

• OrderDisplayFulfillmentStatus — Represents the order’s current fulfillment status. Valid values are: unfulfilled, partial, fulfilled, restocked.

• OrderEditAppliedDiscountInput — The input fields used to add a discount during an order edit.

• OrderInput — Specifies the information to be updated on the requested order.

• OrderMarkAsPaidInput — Specifies the order to mark as paid.

• OrderOpenInput — Specifies a closed order to open.

• OrderPaymentCollectionDetails — The payment collection details for an order requiring additional payment.

• OrderRisk — Represents a fraud check on an order.

• OrderRiskLevel — The likelihood that an order is fraudulent.

• OrderSortKeys — The set of valid sort keys for the Order query.

• OrderStagedChange — An auto-generated type for paginating through multiple OrderStagedChanges.

• OrderStagedChangeAddCustomItem — A newly created custom item.

• OrderStagedChangeAddLineItemDiscount — A discount application added as part of an order edit.

• OrderStagedChangeAddShippingLine — A new shipping line added as part of an order edit.

• OrderStagedChangeAddVariant — A new item created from an existing product variant.

• OrderStagedChangeDecrementItem — An removal of items from an existing line item on the order.

• OrderStagedChangeIncrementItem — An addition of items to an existing line item on the order.

• OrderTransaction — A transaction represents an exchange of money as part of an order.

• OrderTransactionInput — Specifies the information needed to create an order transaction.

• OrderTransactionKind — The different kinds of order transactions.

• OrderTransactionStatus — Transaction status’ describe the status of a transaction.

• PaymentMethods — List of payment methods used in Shopify.

• PaymentSession — Represents a payment session.

• PaymentSessionRejectionReasonInput — Reason of the payment status.

• PaymentSessionStatus — Represents a payment status.

• PaymentSessionStatusCode — Payment status codes.

• PaymentSessionStatusReason — Payment status reason.

• PaymentSessionStatusReasonRejectionCode — Payment rejection reason codes.

• PaymentSettings — Settings related to payments.

• PaymentsAppConfiguration — The production configuration of the payments app.

• Refund — Represents a refund of items or transactions in an order.

• RefundDuty — Represents a refunded duty.

• RefundDutyInput — Specifies the fields required to return duties on a refund.

• RefundDutyRefundType — The type of refund to perform for a particular refund duty.

• RefundInput — Specifies the fields to create a refund.

• RefundLineItem — Represents the details about a refunded line item.

• RefundLineItemInput — Specifies the fields required to return line items on a refund.

• RefundLineItemRefundType — The type of restock performed for a particular refund line item.

• RefundLineItemRestockType — The type of restock performed for a particular refund line item.

• ResourceAlertIcon — The available icons for resource alerts.

• ResourceAlertSeverity — The possible severity levels for a resource alert.

• ScriptDiscountApplication — Script discount applications capture the intentions of a discount that was created by a Shopify Script for an order’s line item or shipping line.

• ShippingLine — Represents the shipping details that the customer chose for their order.

• ShippingLineInput — Specifies the shipping details for the order.

• ShippingRefund — Represents the shipping costs refunded on the Refund.

• ShippingRefundInput — Specifies the fields required to return shipping costs on a Refund.

• ShopifyPaymentsExtendedAuthorization — Presents all Shopify Payments information related to an extended authorization.

• ShopifyPaymentsTransactionSet — Presents all Shopify Payments specific information related to an order transaction.

• SubscriptionAppliedCodeDiscount — Represents an applied code discount.

• SubscriptionBillingAttempt — Record of an execution of the subscription billing schedule.

• SubscriptionBillingAttemptInput — Specifies the fields required to complete a subscription billing attempt.

• SubscriptionBillingPolicy — Represents a Subscription Billing Policy.

• SubscriptionBillingPolicyInput — Specifies the input fields for a Subscription Billing Policy.

• SubscriptionContract — Represents a Subscription Contract.

• SubscriptionContractCreateInput — Specifies the input fields required to create a Subscription Contract.

• SubscriptionContractLastPaymentStatus — Possible status values of the last payment on a subscription contract.

• SubscriptionContractSubscriptionStatus — Possible status values of a subscription.

• SubscriptionCyclePriceAdjustment — Represents a Subscription Line Pricing Cycle Adjustment.

• SubscriptionDeliveryMethod — Describes the delivery method to use to get the physical goods to the customer.

• SubscriptionDeliveryMethodInput — Specifies delivery method fields for a subscription draft. This is an input union: one, and only one, field can be provided. The field provided will determine which delivery method is to be used. Note: Only shipping is supported for now, but other inputs will be added as they become supported in subscriptions.

• SubscriptionDeliveryMethodShipping — Represents a shipping delivery method: a mailing address and a shipping option.

• SubscriptionDeliveryMethodShippingInput — Specifies shipping delivery method fields. This input accepts partial input. When a field is not provided, its prior value is left unchanged.

• SubscriptionDeliveryMethodShippingOption — Represents the selected shipping option on a subscription contract.

• SubscriptionDeliveryMethodShippingOptionInput — Specifies shipping option fields.

• SubscriptionDeliveryPolicy — Represents a Subscription Delivery Policy.

• SubscriptionDeliveryPolicyInput — Specifies the input fields for a Subscription Delivery Policy.

• SubscriptionDiscount — An auto-generated type for paginating through multiple SubscriptionDiscounts.

• SubscriptionDiscountAllocation — Represents what a particular discount reduces from a line price.

• SubscriptionDiscountEntitledLines — Represents the subscription lines the discount applies on.

• SubscriptionDiscountFixedAmountValue — The value of the discount and how it will be applied.

• SubscriptionDiscountPercentageValue — The percentage value of the discount.

• SubscriptionDiscountRejectionReason — The reason a discount on a subscription draft was rejected.

• SubscriptionDiscountValue — The value of the discount and how it will be applied.

• SubscriptionDraft — Represents a Subscription Draft.

• SubscriptionDraftInput — Specifies the input fields required to create a Subscription Draft.

• SubscriptionFreeShippingDiscountInput — Specifies the input fields of a subscription free shipping discount on a contract.

• SubscriptionLine — Represents a Subscription Line.

• SubscriptionLineInput — Specifies the input fields required to add a new subscription line to a contract.

• SubscriptionLineUpdateInput — Specifies the input fields required to update a subscription line on a contract.

• SubscriptionMailingAddress — Represents a Mailing Address on a Subscription.

• SubscriptionManualDiscount — Custom subscription discount.

• SubscriptionManualDiscountEntitledLinesInput — Represents the subscription lines the discount applies on.

• SubscriptionManualDiscountFixedAmountInput — Specifies the fixed amount value of the discount and distribution on the lines.

• SubscriptionManualDiscountInput — Specifies the input fields of a subscription discount on a contract.

• SubscriptionManualDiscountLinesInput — Line items that a the discount refers to.

• SubscriptionManualDiscountValueInput — Specifies the discount value and its distribution.

• SubscriptionPricingPolicy — Represents a Subscription Line Pricing Policy.

• SubscriptionPricingPolicyCycleDiscountsInput — An array containing all pricing changes for each billing cycle.

• SubscriptionPricingPolicyInput — Describes expected price changes of the subscription line over time.

• SubscriptionShippingOption — A shipping option to deliver a subscription contract.

• SubscriptionShippingOptionResult — The result of the query to fetch shipping options for the subscription contract.

• SubscriptionShippingOptionResultFailure — Failure determining available shipping options for delivery of a subscription contract.

• SubscriptionShippingOptionResultSuccess — A shipping option for delivery of a subscription contract.

• SuggestedOrderTransaction — Represents a suggested transaction.

• SuggestedOrderTransactionKind — Specifies the kind of the suggested order transaction.

• SuggestedRefund — Represents the suggested refund to be submitted based on the items being returned.

• TaxLine — Represents the information about the tax charged on the associated line item.

• TenderTransaction — A tender transaction represents a transaction which modifies the shop’s balance.

• TenderTransactionCreditCardDetails — Information about the credit card used for this transaction.

• TenderTransactionDetails — Information about the payment instrument used for this transaction.

• TransactionFee — Transaction fee related to an order transaction.

• TransactionSupportedRefundType — The supported refund types.

• draftOrderCalculate — Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.

• draftOrderComplete — Completes a draft order and creates an order.

• draftOrderCreate — Creates a draft order.

• draftOrderDelete — Deletes a draft order.

• draftOrderInvoicePreview — Previews a draft order invoice email.

• draftOrderInvoiceSend — Sends an email invoice for a draft order.

• draftOrderUpdate — Updates a draft order.

• orderCapture — Captures from an authorized transaction on an order.

• orderClose — Closes an open order.

• orderEditAddCustomItem — Add a custom item to the order.

• orderEditAddLineItemDiscount — Add a discount to an item added during this order edit.

• orderEditAddVariant — Add a line item from an existing product variant.

• orderEditBegin — Start editing an order.

• orderEditCommit — Applies and saves staged changes to an order.

• orderEditRemoveLineItemDiscount — Removes a discount that was added as part of this edit.

• orderEditSetQuantity — Set the quantity of an item on the order.

• orderMarkAsPaid — Marks an order as paid.

• orderOpen — Opens a closed order.

• orderUpdate — Updates an order.

• paymentSessionReject — Rejects an open payment session.

• paymentSessionResolve — Resolves an open payment session.

• refundCreate — Creates a refund.

• subscriptionBillingAttemptCreate — Creates a new subscription billing attempt.

• subscriptionContractCreate — Creates a Subscription Contract.

• subscriptionContractSetNextBillingDate — Sets the next billing date of a Subscription Contract.

• subscriptionContractUpdate — Updates a Subscription Contract.

• subscriptionDraftCommit — Commits the updates of a Subscription Contract draft.

• subscriptionDraftDiscountAdd — Adds a subscription discount to a subscription draft.

• subscriptionDraftDiscountCodeApply — Applies a code discount on the subscription draft.

• subscriptionDraftDiscountRemove — Removes a subscription discount from a subscription draft.

• subscriptionDraftDiscountUpdate — Updates a subscription discount on a subscription draft.

• subscriptionDraftFreeShippingDiscountAdd — Adds a subscription free shipping discount to a subscription draft.

• subscriptionDraftFreeShippingDiscountUpdate — Updates a subscription free shipping discount on a subscription draft.

• subscriptionDraftLineAdd — Adds a subscription line to a subscription draft.

• subscriptionDraftLineRemove — Removes a subscription line from a subscription draft.

• subscriptionDraftLineUpdate — Updates a subscription line on a subscription draft.

• subscriptionDraftUpdate — Updates a Subscription Draft.