订单-Order 对象

订单代表客户与商人之间开展业务的协议。

所需的访问

read_orders 访问范围。

在本页面

• Connections
• 字段
• 返回订单的类型
• 订单突变
• 派生关系

Connections

• discountApplications（[DiscountApplicationConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/discountapplication)）
  已在订单上应用的折扣。

• events（[EventConnection!](https://shopify.dev/docs/admin-api/graphql/reference/events/eventconnection)）
  与订单关联的内部事件列表。

• fulfillmentOrders（[FulfillmentOrderConnection!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder)）
  分页的履行订单清单。

• lineItems（[LineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/lineitem)）
  订单的订单项列表。

• localizationExtensions（[LocalizationExtensionConnection!](https://shopify.dev/docs/admin-api/graphql/reference/translations/localizationextensionconnection)）
  资源的本地化扩展列表。

• metafields（[MetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafieldconnection)）
  与资源关联的元字段的分页列表。

• nonFulfillableLineItems（[LineItemConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/lineitem)）
  无法实现的订单项。例如，由于一些或所有物品已经退款，或者该物品不是可以兑现的物品，例如小费。如果您仅在草稿或履行中考虑了这些订单项，则这些订单项将“丢失”。

• privateMetafields（[PrivateMetafieldConnection!](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafieldconnection)）
  私有元字段列表。

• shippingLines（[ShippingLineConnection!](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline)）
  包含运输费用的订单项列表。

字段

• metafields（[[ResourceAlert!]!](https://shopify.dev/docs/admin-api/graphql/reference/events/resourcealert)）
  Generated messages that appear at the top of an order page in the Shopify admin. For example, this is a test order.
• billingAddress ([MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress))
  Mailing address provided by the customer. Not all orders have mailing addresses.
• billingAddressMatchesShippingAddress ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the billing address matches the shipping address.
• canMarkAsPaid ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the order can be manually marked as paid.
• canNotifyCustomer ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether notifications can be sent to the customer or not.
• cancelReason ([OrderCancelReason](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordercancelreason))
  订单被取消的原因。如果未取消订单，则返回null。
• cancelledAt（[DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)）
  订单取消的日期和时间。如果未取消订单，则返回null。
• capturable（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  是否可以捕获订单付款。当客户的信用卡已被授权付款并且授权期限未到期时，返回true。
• cartDiscountAmountSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  商店和演示货币的订单级折扣金额（不包含任何订单项折扣）。
• clientIp（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  与此订单关联的客户端的IP地址。
• closed（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否关闭。
• closeAt（[DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)）
  订单关闭的日期和时间。如果未关闭订单，则此字段为null。
• confirmed（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  是否已为订单保留库存。
• createdAt（[DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)）
  在Shopify中创建订单的日期和时间。
• currencyCode（[CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)）
  下单时商店的货币。如果尚未付款，则此字段为null。
• currentCartDiscountAmountSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单级折扣的金额减去已退回的订单项的金额。这不包括订单项折扣。
• currentSubtotalLineItemsQuantity（[Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)）
  构成订单小计的订单项的数量总和。
• currentSubtotalPriceSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单项及其折扣的小计减去已退回的订单项。这包括订单级别的折扣，除非参数with_cart_discount设置为false。这不包括运输费用和运输折扣。除非订单是含税订单，否则不包括税费。
• currentTaxLines（[[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline)）
  订单收取的税额减去已退回的订单项的税额。
• currentTotalDiscountsSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单的折扣总额（包括订单级别和订单项的折扣）减去已退回商品的金额。
• currentTotalDutiesSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单的关税总额。如果不适用关税，则此值为null。
• currentTotalPriceSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单总额（包括税金和折扣）减去已退回的订单项的金额。
• currentTotalTaxSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  应用于订单的所有税金的总和减去已退回的订单项的税金。
• currentTotalWeight（[UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)）
  订单的总重量（克）减去已退回的订单项的重量。
• customAttributes（[[Attribute!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/attribute)）
  客户添加到订单的自定义信息（也称为注释属性）。
• customer（[Customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer)）
  下订单的客户的唯一标识符。并非所有订单都有与之关联的客户。
• customerAcceptsMarketing（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  客户是否同意接收营销材料。
• customerJourneySummary（[CustomerJourneySummary](https://shopify.dev/docs/admin-api/graphql/reference/discounts-and-marketing/customerjourneysummary)）
  描述客户在订购商店之前的体验。消费者以异步方式加载，应轮询直到“就绪”字段解析为true。
• customerLocale（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  两字母或三字母的语言代码，可以选择后面跟一个区域修饰符。示例值可以是“ en”，“ en-CA”，“ en-PIRATE”。
• discountCode（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  客户提供的折扣代码。
• displayAddress（[MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress)）
  客户的主要地址，显示在订单上。
• displayFinancialStatus（[OrderDisplayFinancialStatus](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderdisplayfinancialstatus)）
  可以显示给商家的订单的财务状况。该字段不会捕获订单财务状况的所有可能的详细信息，而应仅用于显示摘要目的。
• displayFulfillmentStatus（[OrderDisplayFulfillmentStatus!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderdisplayfulfillmentstatus)）
  可以显示给商家的订单的履行状态。该字段未捕获订单履行状态的所有可能的详细信息。仅应将其用于显示摘要。
• disputes（[[OrderDisputeSummary!]!](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/orderdisputesummary)）
  与订单相关的每个争议的摘要。按ID升序（ASC）排序。
• edited（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否已应用任何编辑。
• email（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  客户提供的电子邮件地址。
• fulfillable（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  是否有可以实现的项目。订单完全履行（或完全退款但没有任何履行）之后，此字段将返回false。
• fulfillments（[[Fulfillment!]!](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment)）
  该订单的发货清单。

• fullyPaid（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否已全额支付。
• hasTimelineComment（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  商家是否在订单中添加了时间轴注释。
• id（[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)）
  全局唯一标识符。
• legacyResourceId（[UnsignedInt64!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)）
  REST Admin API中相应资源的ID。
• vendorEditable（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否可以编辑。
• vendorEditableErrors（[[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  为何无法编辑订单的原因列表。
• metafield（[Metafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/metafield)）
  与资源关联的元字段。

• name（[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  订单上显示的订单的唯一标识符。例如，＃1000或_Store1001。此值在多个商店中不是唯一的。
• netPaymentSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单的净付款额，以收到的总金额为基础-以商店和演示货币退还的总金额。
• note（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  与订单关联的注释内容。
• originalTotalDutiesSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  对该订单进行任何应用的编辑之前的职责总数。如果不适用关税，则此值为null。
• originalTotalPriceSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  在应用商店和演示货币进行任何编辑之前的订单总价。
• paymentCollectionDetails（[OrderPaymentCollectionDetails!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderpaymentcollectiondetails)）
  需要额外付款的订单的付款收款明细。
• paymentGatewayNames（[[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  用于订单的所有付款网关的列表。例如，authorize_net和货到付款（COD）。
• phone（[String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  客户提供的电话号码。
• physicalLocation（[Location](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/location)）
  如果订单是使用Shopify POS处理的，则这是商家提供的位置。
• presentmentCurrencyCode（[CurrencyCode!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode)）
  客户为此订单的付款货币。
• privateMetafield（[PrivateMetafield](https://shopify.dev/docs/admin-api/graphql/reference/metafields/privatemetafield)）
  返回通过名称空间和键找到的私有元字段。

• processedAt（[DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)）
  处理订单的日期和时间。从应用程序导入订单时，此日期和时间可能与创建订单时的日期和时间不匹配。
• publication（[Publication](https://shopify.dev/docs/admin-api/graphql/reference/apps/publication)）
  创建订单的出版物。
• returnDiscrepancySet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  建议退款金额与实际退款金额之间的差额。正值表示商家偏爱的差异，负值表示客户偏爱的差异。
• refundable（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否可以退款。
• refunds（[[Refund!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund)）
  应用于订单的退款清单。

• requireShipping（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单中是否有任何订单项需要实际运输。
• restockable（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否可以补货。
• riskLevel（[OrderRiskLevel!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderrisklevel)）
  订单的欺诈风险等级。
• risks（[[OrderRisk!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/orderrisk)）
  与该订单相关的订单风险。

• shippingAddress（[MailingAddress](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/mailingaddress)）
  客户提供的运输邮寄地址。
• shippingLine（[ShippingLine](https://shopify.dev/docs/admin-api/graphql/reference/orders/shippingline)）
  包含运输费用的订单项。
• subtotalLineItemsQuantity（[Int!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#int-2021-01)）
  构成订单小计的订单项的数量总和。
• subtotalPriceSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单项及其折扣（不含运输成本和运输折扣）的小计，以商店和演示货币表示。
• suggestedRefund（[SuggestedRefund](https://shopify.dev/docs/admin-api/graphql/reference/orders/suggestedrefund)）
  建议退款的详细信息。此响应可用于提交RefundCreate突变。

• tags（[[String!]!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  与订单关联的标签的逗号分隔列表。更新将tags覆盖以前添加到订单中的所有现有标签。要添加新标签而不覆盖现有标签，请使用tagsAdd 突变。
• taxLi**nes**（[[TaxLine!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/taxline)）
  该订单项收取的税款。
• taxesIncluded（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单小计价格中是否包含税款。
• test（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  订单是否为测试。使用Shopify Bogus Gateway或启用了测试模式的付款提供商下达测试订单。
• totalCapturableSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  订单的授权金额，以商店和展示货币为单位，则为未捕获或未捕获的金额。
• totalDiscountsSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币从订单中扣除的总金额（包括订单级别和订单项的折扣）。
• totalO**utstandingSet**（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  尚未获得订单授权的总金额。
• totalPriceSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币表示的订单总额（包括税金和折扣）。
• totalReceivedSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  客户以商店和演示货币收到的订单总金额。
• totalRefundedSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币退还的订单总金额。
• totalRefundedShippingSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币退款的运费总额。
• totalShippingPriceSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币运输订单收取的总金额。
• totalTaxSet（[MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币应用于订单的所有税费的总计。
• totalTipReceivedSet（[MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag)）
  以商店和演示货币收到的订单总小费。
• totalWeight（[UnsignedInt64](https://shopify.dev/docs/admin-api/graphql/reference/scalar#unsignedint64-2021-01)）
  订单的总重量（克）。
• transactions（[[OrderTransaction!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction)）
  与订单关联的所有交易清单。

• unpaid（[Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01)）
  是否没有为订单付款。如果尚未为订单付款，则返回true。
• UpdatedAt（[DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01)）
  上次修改订单的日期和时间。

返回订单的类型

• [CalculatedOrder.originalOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/calculatedorder#originalorder-2021-01)
• [Customer.lastOrder](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#lastorder-2021-01)
• [Customer.orders](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer#orders-2021-01)
• [DraftOrder.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/draftorder#order-2021-01)
• [Fulfillment.order](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillment#order-2021-01)
• [FulfillmentOrder.order](https://shopify.dev/docs/admin-api/graphql/reference/shipping-and-fulfillment/fulfillmentorder#order-2021-01)
• [OrderTransaction.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction#order-2021-01)
• [QueryRoot.orders](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#orders-2021-01)
• [QueryRoot.order](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/queryroot#order-2021-01)
• [Refund.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund#order-2021-01)
• [ShopifyPaymentsDispute.order](https://shopify.dev/docs/admin-api/graphql/reference/shopify-payments/shopifypaymentsdispute#order-2021-01)
• [SubscriptionBillingAttempt.order](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptionbillingattempt#order-2021-01)
• [SubscriptionContract.orders](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#orders-2021-01)
• [SubscriptionContract.originOrder](https://shopify.dev/docs/admin-api/graphql/reference/orders/subscriptioncontract#originorder-2021-01)

订单突变

• orderCapture
  从订单的授权交易中捕获。
• orderClose
  关闭未结订单。
• orderEditAddCustomItem
  将自定义项目添加到订单。
• orderEditAddLineItemDiscount
  为在此订单编辑过程中添加的项目添加折扣。
• orderEditAddVariant
  从现有产品变体中添加订单项。
• orderEditBegin
  开始编辑订单。
• orderEditCommit
  应用并保存对订单的分段更改。
• orderEditRemoveLineItemDiscount
  删除作为此编辑的一部分添加的折扣。
• orderEditSetQuantity
  设置订单上项目的数量。
• orderMarkAsPaid
  将订单标记为已付款。
• orderOpen
  打开一个关闭的订单。
• orderUpdate
  更新订单。

派生关系

• [CommentEventSubject](https://shopify.dev/docs/admin-api/graphql/reference/events/commenteventsubject)
• [HasEvents](https://shopify.dev/docs/admin-api/graphql/reference/events/hasevents)
• [HasLocalizationExtensions](https://shopify.dev/docs/admin-api/graphql/reference/translations/haslocalizationextensions)
• [HasMetafields](https://shopify.dev/docs/admin-api/graphql/reference/metafields/hasmetafields)
• [LegacyInteroperability](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/legacyinteroperability)
• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

在本页面

• 字段

字段

• edges（[[OrderEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order)）
  边列表。
• pageInfo（[PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo)）
  有助于分页的信息。

一种自动生成的类型，在分页期间包含一个Order和一个光标。

在本页面

• 字段
• 返回OrderEdge的类型

字段

• cursor（[String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)）
  用于分页的光标。
• node（[Order!](https://shopify.dev/docs/admin-api/graphql/reference/orders/order)）
  OrderEdge末尾的项目。

返回OrderEdge的类型

• [OrderConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#edges-2021-01)