订单API
为商户提供新的方式来接收,处理和管理他们的订单。
在这个部分
- 属性-表示通用的自定义属性。
- AttributeInput —指定属性所需的输入字段。
- AutomaticDiscountApplication-自动折扣应用程序捕获自动应用的折扣的意图。
- CalculatedAutomaticDiscountApplication —折扣代码应用程序在将折扣代码应用于订单时捕获其意图。
- CalculatedDiscountAllocation —对关联的折扣应用程序已分配的行进行折扣的金额。
- CalculatedDiscountApplication —一种自动生成的类型,用于通过多个CalculatedDiscountApplications分页。
- CalculatedDiscountCodeApplication —折扣代码应用程序在将折扣代码应用于订单时捕获其意图。
- CalculatedDraftOrder —草稿订单的计算属性。
- CalculatedDraftOrderLineItem —计算的草稿订单项。
- CalculatedLineItem —订单编辑中涉及的订单项,可以新添加或应用新更改。
- CalculatedManualDiscountApplication —手动折扣应用程序捕获为订单手动创建的折扣的意图。
- CalculatedOrder —已应用但未保存编辑的订单。
- CalculatedScriptDiscountApplication —折扣代码应用程序在将折扣代码应用于订单时捕获其意图。
- CurrencySetting —表示货币设置。
- DiscountAllocation —对关联的折扣应用程序已分配的行进行折扣的金额。
- DiscountApplication —一种自动生成的类型,用于通过多个DiscountApplications分页。
- DiscountApplicationAllocationMethod —折扣值分配到其授权行的方法。
- DiscountApplicationLevel —折扣值分配到其授权行的方法。
- DiscountApplicationTargetSelection —由折扣应用程序的target_type定义的类型,在分配折扣的订单行上的哪些行。
- DiscountApplicationTargetType —折扣适用于的订单上的行(即订单项或运输行)的类型。
- DiscountCodeApplication —折扣代码应用程序在将折扣代码应用于订单时捕获其意图。
- DiscountTargetType —应用订阅折扣的行的类型。
- DiscountType —折扣的原始类型。
- DraftOrder-表示草稿订单。商家可以使用订单草稿代表客户创建订单。
- DraftOrderAppliedDiscount —应用于草稿订单的订单级别折扣。
- DraftOrderAppliedDiscountInput —用于对草稿订单应用订单级折扣的输入字段。
- DraftOrderAppliedDiscountType-可应用于草稿订单的有效折扣类型。
- DraftOrderDeleteInput-通过其ID指定要删除的草稿订单。
- DraftOrderInput —用于创建或更新草稿订单的输入字段。
- DraftOrderLineItem-表示草稿订单中包含的订单项。
- DraftOrderLineItemInput-用于为草稿订单创建订单项的输入字段。
- DraftOrderSortKeys — DraftOrder查询的有效排序键集。
- DraftOrderStatus-草稿订单的有效状态。
- 职责-代表订单项的一项职责。
- EmailInput —指定电子邮件的字段。
- LineItem —表示购物车中的一行。
- LineItemMutable —表示购物车中的一行。
- LineItemSellingPlan —表示订单项的销售计划。
- ManualDiscountApplication-手动折扣应用程序捕获为订单手动创建的折扣的意图。
- 订单-订单代表客户与商人之间开展业务的协议。
- OrderAdjustment —订单调整说明退还的运输费用或计算出的退款额与实际退款额之间的差额。
- OrderAdjustmentKind —不同种类的订单调整。
- OrderCancelReason-表示订单被取消的原因。有效值包括:客户,欺诈,库存,拒绝,其他。
- OrderCaptureInput-指定要捕获的授权交易以及要从中捕获的总金额。
- OrderCloseInput —指定要关闭的未结订单。
- OrderDisplayFinancialStatus-表示订单的当前财务状况。
- OrderDisplayFulfillmentStatus-表示订单的当前履行状态。有效值是:未实现,部分,已实现,已补货。
- OrderEditAppliedDiscountInput-用于在订单编辑期间添加折扣的输入字段。
- OrderInput —指定要在请求的订单上更新的信息。
- OrderMarkAsPaidInput —指定标记为已付款的订单。
- OrderOpenInput-指定要关闭的关闭订单。
- OrderPaymentCollectionDetails —需要额外付款的订单的付款收集详细信息。
- OrderRisk-代表对订单的欺诈检查。
- OrderRiskLevel —订单被欺诈的可能性。
- OrderSortKeys —订单查询的有效排序键集。
- OrderStagedChange —一种自动生成的类型,用于通过多个OrderStagedChanges进行分页。
- OrderStagedChangeAddCustomItem —新创建的自定义项目。
- OrderStagedChangeAddLineItemDiscount —在订单编辑中添加的折扣应用程序。
- OrderStagedChangeAddShippingLine —作为订单编辑的一部分添加的新运输线。
- OrderStagedChangeAddVariant —从现有产品变体创建的新项目。
- OrderStagedChangeDecrementItem —从订单上现有订单项中删除项目。
- OrderStagedChangeIncrementItem —在订单上向现有订单项添加项目。
- OrderTransaction —交易表示作为订单一部分的货币交换。
- OrderTransactionInput-指定创建订单交易所需的信息。
- OrderTransactionKind —不同种类的订单交易。
- OrderTransactionStatus-“交易状态”描述交易的状态。
- PaymentMethods — Shopify中使用的付款方式列表。
- PaymentSession-表示付款会话。
- PaymentSessionRejectionReasonInput-付款状态的原因。
- PaymentSessionStatus —表示付款状态。
- PaymentSessionStatusCode —付款状态代码。
- PaymentSessionStatusReason —付款状态原因。
- PaymentSessionStatusReasonRejectionCode —付款拒绝原因码。
- PaymentSettings-与付款有关的设置。
- PaymentsAppConfiguration-付款应用程序的生产配置。
- 退款-表示订单中物品或交易的退款。
- RefundDuty —代表已退税。
- RefundDutyInput-指定退还关税的必填字段。
- RefundDutyRefundType —针对特定退款义务执行的退款类型。
- RefundInput —指定用于创建退款的字段。
- RefundLineItem-代表有关退款订单项的详细信息。
- RefundLineItemInput-指定退回订单项的必填字段。
- RefundLineItemRefundType —为特定退款订单项执行的补货类型。
- RefundLineItemRestockType —为特定退款订单项执行的补货类型。
- RefundSession —代表退款会话。
- RefundSessionRejectionReasonInput-退款状态的原因。
- RefundSessionStatus —代表退款状态。
- RefundSessionStatusCode-退款状态码。
- RefundSessionStatusReason-退款状态原因。
- RefundSessionStatusReasonRejectionCode —退款拒绝原因代码。
- ResourceAlertIcon —资源警报的可用图标。
- ResourceAlertSeverity-资源警报的可能严重性级别。
- ScriptDiscountApplication-脚本折扣应用程序捕获Shopify脚本为订单的行项目或运输行创建的折扣的意图。
- ShippingLine —表示客户为其订单选择的运输详细信息。
- ShippingLineInput-指定订单的运送详细信息。
- ShippingRefund —代表退款中退款的运输费用。
- ShippingRefundInput-指定退还退款的运输费用所需的字段。
- ShopifyPaymentsExtendedAuthorization —显示与扩展授权有关的所有Shopify Payments信息。
- ShopifyPaymentsTransactionSet-显示所有与订单交易有关的Shopify Payments特定信息。
- SubscriptionAppliedCodeDiscount —表示应用的代码折扣。
- SubscriptionBillingAttempt —订阅计费时间表的执行记录。
- SubscriptionBillingAttemptInput —指定完成订阅计费尝试所需的字段。
- SubscriptionBillingPolicy-代表订阅计费政策。
- SubscriptionBillingPolicyInput-指定订阅计费策略的输入字段。
- SubscriptionContract —表示订阅合同。
- SubscriptionContractCreateInput —指定创建订阅合同所需的输入字段。
- SubscriptionContractLastPaymentStatus-订阅合同上次付款的可能状态值。
- SubscriptionContractSubscriptionStatus-订阅的可能状态值。
- SubscriptionCyclePriceAdjustment-表示订阅行定价周期调整。
- SubscriptionDeliveryMethod —描述用于将实物商品提供给客户的交付方法。
- SubscriptionDeliveryMethodInput —指定订阅草稿的传递方法字段。这是一个输入并集:只能提供一个字段。提供的字段将确定要使用的交付方式。注意:目前仅
shipping
受支持,但其他输入将在订阅中受支持时添加。 - SubscriptionDeliveryMethodShipping —表示送货方式:邮寄地址和送货选项。
- SubscriptionDeliveryMethodShippingInput-指定运送方式的字段。该输入接受部分输入。如果未提供字段,则其先前值保持不变。
- SubscriptionDeliveryMethodShippingOption —表示订阅合同上的选定运送选项。
- SubscriptionDeliveryMethodShippingOptionInput-指定运送选项字段。
- SubscriptionDeliveryPolicy-表示订阅传送策略。
- SubscriptionDeliveryPolicyInput-指定订阅传递策略的输入字段。
- SubscriptionDiscount —一种自动生成的类型,用于通过多个SubscriptionDiscounts分页。
- SubscriptionDiscountAllocation-表示特定折扣从线路价格减少的金额。
- SubscriptionDiscountEntitledLines-表示折扣适用的订阅行。
- SubscriptionDiscountFixedAmountValue —折扣的值及其应用方式。
- SubscriptionDiscountPercentageValue-折扣的百分比值。
- SubscriptionDiscountRejectionReason-订阅草稿的折扣被拒绝的原因。
- SubscriptionDiscountValue —折扣的值以及其应用方式。
- SubscriptionDraft-代表订阅草稿。
- SubscriptionDraftInput-指定创建订阅草稿所需的输入字段。
- SubscriptionFreeShippingDiscountInput-指定合同上的订阅免运费折扣的输入字段。
- SubscriptionLine —表示一个订阅行。
- SubscriptionLineInput-指定将新的订阅行添加到合同所需的输入字段。
- SubscriptionLineUpdateInput-指定更新合同上的订购行所需的输入字段。
- SubscriptionMailingAddress —表示订阅中的邮寄地址。
- SubscriptionManualDiscount-自定义订阅折扣。
- SubscriptionManualDiscountEntitledLinesInput —表示折扣适用的订阅行。
- SubscriptionManualDiscountFixedAmountInput —指定行上折扣和分配的固定金额值。
- SubscriptionManualDiscountInput-指定合同的订购折扣的输入字段。
- SubscriptionManualDiscountLinesInput —折扣所引用的订单项。
- SubscriptionManualDiscountValueInput-指定折扣值及其分布。
- SubscriptionPricingPolicy-表示订阅线路定价策略。
- SubscriptionPricingPolicyCycleDiscountsInput —一个数组,其中包含每个计费周期的所有定价更改。
- SubscriptionPricingPolicyInput-描述预订行随时间的预期价格变化。
- SubscriptionShippingOption-交付订购合同的运输选项。
- SubscriptionShippingOptionResult —获取订阅合同的运输选项的查询结果。
- SubscriptionShippingOptionResultFailure —无法确定用于交付订购合同的可用运输选项。
- SubscriptionShippingOptionResultSuccess —用于交付订购合同的运输选项。
- RecommendationedOrderTransaction-表示建议的交易。
- SuggestedOrderTransactionKind —指定建议的订单交易的类型。
- 建议退款-表示根据退回的物品要提交的建议退款。
- TaxLine —表示有关在相关订单项上收取的税款的信息。
- TenderTransaction-投标交易表示修改商店余额的交易。
- TenderTransactionCreditCardDetails —有关用于此交易的信用卡的信息。
- TenderTransactionDetails-有关用于此交易的付款方式的信息。
- TransactionFee —与订单交易相关的交易费用。
- TransactionSupportedRefundType-支持的退款类型。
- draftOrderCalculate —计算草稿订单的属性。在无需实际创建订单草稿的情况下确定总税或价格等信息时很有用。
- draftOrderComplete —完成草稿订单并创建订单。
- draftOrderCreate —创建草稿订单。
- draftOrderDelete —删除草稿订单。
- draftOrderInvoicePreview —预览草稿订单发票电子邮件。
- draftOrderInvoiceSend —发送草稿订单的电子邮件发票。
- draftOrderUpdate —更新草稿订单。
- orderCapture —从订单的授权交易中捕获。
- orderClose —关闭未结订单。
- orderEditAddCustomItem —将自定义项目添加到订单。
- orderEditAddLineItemDiscount —为在此订单编辑期间添加的项目添加折扣。
- orderEditAddVariant —从现有产品变体中添加订单项。
- orderEditBegin —开始编辑订单。
- orderEditCommit —应用并保存对订单的分段更改。
- orderEditRemoveLineItemDiscount —删除作为此编辑的一部分添加的折扣。
- orderEditSetQuantity —设置订单上项目的数量。
- orderMarkAsPaid —将订单标记为已付款。
- orderOpen —打开一个关闭的订单。
- orderUpdate —更新订单。
- paymentSessionReject —拒绝公开的付款会话。
- paymentSessionResolve —解决开放式付款会话。
- returnCreate —创建退款。
- rewardSessionReject —拒绝公开退款会话。
- returnSessionResolve —解决公开退款会话。
- subscriptionBillingAttemptCreate —创建一个新的订阅计费尝试。
- subscriptionContractCreate —创建一个订阅合同。
- subscriptionContractSetNextBillingDate —设置订阅合同的下一个结算日期。
- subscriptionContractUpdate —更新订阅合同。
- subscriptionDraftCommit-提交订阅合同草稿的更新。
- subscriptionDraftDiscountAdd-将订阅折扣添加到订阅草稿中。
- subscriptionDraftDiscountCodeApply-对订阅草稿应用代码折扣。
- subscriptionDraftDiscountRemove —从订阅草稿中删除订阅折扣。
- subscriptionDraftDiscountUpdate —更新订阅草稿的订阅折扣。
- subscriptionDraftFreeShippingDiscountAdd-将订阅免费送货折扣添加到订阅草稿中。
- subscriptionDraftFreeShippingDiscountUpdate —更新订阅草稿的订阅免费送货折扣。
- subscriptionDraftLineAdd —将订阅行添加到订阅草稿。
- subscriptionDraftLineRemove-从订阅草稿中删除订阅行。
- subscriptionDraftLineUpdate-更新订阅草稿上的订阅行。
- subscriptionDraftUpdate-更新订阅草稿。