1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876 |
- # An order that a merchant creates on behalf of a customer. Draft orders are useful for merchants that need to do the following tasks:
- #
- # Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created.
- # Send invoices to customers to pay with a secure checkout link.
- # Use custom items to represent additional costs or products that aren't displayed in a shop's inventory.
- # Re-create orders manually from active sales channels.
- # Sell products at discount or wholesale rates.
- # Take pre-orders.
- # Save an order as a draft and resume working on it later.
- # For Draft orders in multiple currencies presentment_money is the source of truth for what a customer is going to be charged and shop_money is an estimate of what the merchant might receive in their local currency.
- #
- # Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
- type DraftOrder implements CommentEventSubject&HasEvents&HasLocalizationExtensions&HasMetafields&LegacyInteroperability&Navigable&Node{
- # The order-level discount applied to the draft order.
- appliedDiscount: DraftOrderAppliedDiscount
- # The billing address of the customer.
- billingAddress: MailingAddress
- # Whether the billing address matches the shipping address.
- billingAddressMatchesShippingAddress: Boolean!
- # The date and time when the draft order converted to a new order,
- # and the draft order's status changed to Completed.
- completedAt: DateTime
- # The date and time when the draft order was created in Shopify.
- createdAt: DateTime!
- # The three letter code for the currency of the store at the time of the most recent update to the draft order.
- currencyCode: CurrencyCode!
- # The custom information added to the draft order on behalf of the customer.
- customAttributes: [Attribute!]!
- # The customer who will be sent an invoice for the draft order, if there is one.
- customer: Customer
- # A default cursor that returns the single next record, sorted ascending by ID.
- defaultCursor: String!
- # The email address of the customer, which is used to send notifications.
- email: String
- # The list of events associated with the draft order.
- events(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- sortKey: EventSortKeys = ID
- query: String
- ): EventConnection!
- # Whether the merchant has added timeline comments to the draft order.
- hasTimelineComment: Boolean!
- # A globally-unique identifier.
- id: ID!
- # The subject defined for the draft invoice email template.
- invoiceEmailTemplateSubject: String!
- # The date and time when the invoice was last emailed to the customer.
- invoiceSentAt: DateTime
- # The link to the checkout, which is sent to the customer in the invoice email.
- invoiceUrl: URL
- # The ID of the corresponding resource in the REST Admin API.
- legacyResourceId: UnsignedInt64!
- # The list of the line items in the draft order.
- lineItems(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): DraftOrderLineItemConnection!
- # The subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, taxes, or order discounts.
- lineItemsSubtotalPrice: MoneyBag!
- # List of localization extensions for the resource.
- localizationExtensions(
- countryCodes: [CountryCode!]
- purposes: [LocalizationExtensionPurpose!]
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): LocalizationExtensionConnection!
- # The name of the selected market.
- marketName: String!
- # The selected market region country code for the draft order.
- marketRegionCountryCode: CountryCode!
- # Returns a metafield by namespace and key that belongs to the resource.
- metafield(namespace: String!key: String!): Metafield
- # List of metafields that belong to the resource.
- metafields(
- namespace: String
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): MetafieldConnection!
- # The identifier for the draft order, which is unique within the store. For example, #D1223.
- name: String!
- # The text from an optional note attached to the draft order.
- note2: String
- # The order that was created from this draft order.
- order: Order
- # The associated payment terms for this draft order.
- paymentTerms: PaymentTerms
- # The phone number assigned to the draft order.
- phone: String
- # The payment currency of the customer for this draft order.
- presentmentCurrencyCode: CurrencyCode!
- # Returns a private metafield by namespace and key that belongs to the resource.
- privateMetafield(namespace: String!key: String!): PrivateMetafield
- # List of private metafields that belong to the resource.
- privateMetafields(
- namespace: String
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): PrivateMetafieldConnection!
- # The purchasing entity for the draft order.
- purchasingEntity: PurchasingEntity
- # Whether the Draft Order is ready and can be completed. Draft Orders
- # might have asynchronous operations that can take time to finish.
- ready: Boolean!
- # The time after which inventory will automatically be restocked.
- reserveInventoryUntil: DateTime
- # The shipping address of the customer.
- shippingAddress: MailingAddress
- # The line item that contains the shipping costs.
- shippingLine: ShippingLine
- # Status of the draft order.
- status: DraftOrderStatus!
- # The subtotal of the line items and their discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.
- subtotalPrice: Money!
- # A subtotal of the line items and corresponding discounts. The subtotal doesn't include shipping charges, shipping discounts, or taxes.
- subtotalPriceSet: MoneyBag!
- # A comma separated list of tags associated with the draft order. Updating tags overwrites
- # any existing tags that were previously added to the draft order. To add new tags without overwriting
- # existing tags, use the tagsAdd mutation.
- tags: [String!]!
- # Whether the draft order is tax exempt.
- taxExempt: Boolean!
- # Total amount of taxes charged for each line item and shipping line.
- taxLines: [TaxLine!]!
- # Whether the line item prices include taxes.
- taxesIncluded: Boolean!
- # The total discounts for this draft order.
- totalDiscountsSet: MoneyBag!
- # The total price of line items for this draft order.
- totalLineItemsPriceSet: MoneyBag!
- # The total amount of the draft order, including taxes, shipping charges, and discounts.
- totalPrice: Money!
- # The total amount of the draft order including taxes, shipping charges, and discounts.
- totalPriceSet: MoneyBag!
- # The total shipping charge for the draft order.
- totalShippingPrice: Money!
- # The total shipping charge for the draft order.
- totalShippingPriceSet: MoneyBag!
- # The total amount of taxes for the draft order.
- totalTax: Money!
- # The total amount of taxes for the draft order.
- totalTaxSet: MoneyBag!
- # The total weight in grams of the draft order.
- totalWeight: UnsignedInt64!
- # The date and time when the draft order was last changed.
- # The format is YYYY-MM-DD HH:mm:ss. For example, 2016-02-05 17:04:01.
- updatedAt: DateTime!
- # Whether the draft order will be visible to the customer on the self-serve portal.
- visibleToCustomer: Boolean!
- }
- # The order-level discount applied to a draft order.
- type DraftOrderAppliedDiscount {
- # The amount of money discounted, with values shown in both shop currency and presentment currency.
- amountSet: MoneyBag!
- # Amount of money discounted.
- amountV2: MoneyV2!
- # Description of the order-level discount.
- description: String!
- # Name of the order-level discount.
- title: String
- # The order level discount amount. If valueType is "percentage",
- # then value is the percentage discount.
- value: Float!
- # Type of the order-level discount.
- valueType: DraftOrderAppliedDiscountType!
- }
- # A line item included in a draft order.
- type DraftOrderLineItem implements Node {
- # The discount that will be applied to the line item or the overall order.
- appliedDiscount: DraftOrderAppliedDiscount
- # Whether the line item is a custom line item (true) or a product variant line item (false).
- custom: Boolean!
- # A list of attributes that represent custom features or special requests.
- customAttributes: [Attribute!]!
- # Additional information (metafields) about the line item with the associated types.
- customAttributesV2: [TypedAttribute!]!
- # The line item price after discounts are applied.
- discountedTotal: Money!
- # The line item price after discounts are applied.
- discountedTotalSet: MoneyBag!
- # The discountedTotal divided by quantity, resulting in the value of the discount per unit.
- discountedUnitPrice: Money!
- # The discountedTotal divided by quantity, resulting in the value of the discount per unit.
- discountedUnitPriceSet: MoneyBag!
- # Name of the service provider who fulfilled the order.
- #
- # Valid values are either manual or the name of the provider.
- # For example, amazon, shipwire.
- #
- # Deleted fulfillment services will return null.
- fulfillmentService: FulfillmentService
- # A globally-unique identifier.
- id: ID!
- # The image associated with the draft order line item.
- image: Image
- # Whether the line item is a gift card.
- isGiftCard: Boolean!
- # The name of the product.
- name: String!
- # The total price (without discounts) of the line item, based on the original unit price of the variant x quantity.
- originalTotal: Money!
- # The total price (without discounts) of the line item,based on the original unit price of the variant x quantity.
- originalTotalSet: MoneyBag!
- # The variant price without any discounts applied.
- originalUnitPrice: Money!
- # The variant price without any discounts applied.
- originalUnitPriceSet: MoneyBag!
- # The product corresponding to the line item’s product variant.
- product: Product
- # The number of product variants that are requested in the draft order.
- quantity: Int!
- # Whether physical shipping is required for the variant.
- requiresShipping: Boolean!
- # The SKU number of the product variant.
- sku: String
- # A list of tax line objects, each of which details the total taxes applicable to the order.
- taxLines: [TaxLine!]!
- # Whether the variant is taxable.
- taxable: Boolean!
- # The title of the product or variant. This field only applies to custom line items.
- title: String!
- # The total value of the discount that is applied to the line item.
- totalDiscount: Money!
- # The total value of the discount that is applied to the line item.
- totalDiscountSet: MoneyBag!
- # The associated variant for the line item.
- variant: ProductVariant
- # The name of the variant.
- variantTitle: String
- # The name of the vendor who created the product variant.
- vendor: String
- # The weight unit and value for a draft order line item.
- weight: Weight
- }
- # An order is a customer's request to purchase one or more products from a shop. You can retrieve and update orders using the Order object.
- # Learn more about
- # editing an existing order with the GraphQL Admin API.
- #
- # Only the last 60 days' worth of orders from a store are accessible from the Order object by default. If you want to access older orders,
- # then you need to request access to all orders. If your app is granted
- # access, then you can add the read_all_orders scope to your app along with read_orders or write_orders.
- # Private apps are not affected by this change and are automatically granted the scope.
- #
- # Caution: Only use this data if it's required for your app's functionality.
- # Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
- type Order implements CommentEventSubject&HasEvents&HasLocalizationExtensions&HasMetafieldDefinitions&HasMetafields&LegacyInteroperability&Node {
- # A list of sales agreements associated with the order.
- agreements(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- query: String
- ): SalesAgreementConnection!
- # A list of messages that appear on the order page in the Shopify admin.
- alerts: [ResourceAlert!]!
- # The application that created the order.
- app: OrderApp
- # The billing address of the customer.
- billingAddress: MailingAddress
- # Whether the billing address matches the shipping address.
- billingAddressMatchesShippingAddress: Boolean!
- # Whether the order can be manually marked as paid.
- canMarkAsPaid: Boolean!
- # Whether a customer email exists for the order.
- canNotifyCustomer: Boolean!
- # The reason provided when the order was canceled.
- # Returns null if the order wasn't canceled.
- cancelReason: OrderCancelReason
- # The date and time when the order was canceled.
- # Returns null if the order wasn't canceled.
- cancelledAt: DateTime
- # Whether payment for the order can be captured.
- capturable: Boolean!
- # The total order-level discount amount, before returns, in shop and presentment currencies.
- cartDiscountAmountSet: MoneyBag
- # Details about the channel that created the order.
- channelInformation: ChannelInformation
- # The IP address of the API client that created the order.
- clientIp: String
- # Whether the order is closed.
- closed: Boolean!
- # The date and time when the order was closed.
- # Returns null if the order is not closed.
- closedAt: DateTime
- # Whether inventory has been reserved for the order.
- confirmed: Boolean!
- # Date and time when the order was created in Shopify.
- createdAt: DateTime!
- # The shop currency when the order was placed.
- currencyCode: CurrencyCode!
- # The current order-level discount amount after all order updates, in shop and presentment currencies.
- currentCartDiscountAmountSet: MoneyBag!
- # The sum of the quantities for all line items that contribute to the order's current subtotal price.
- currentSubtotalLineItemsQuantity: Int!
- # The sum of the prices for all line items after discounts and returns, in shop and presentment currencies.
- # If taxesIncluded is true, then the subtotal also includes tax.
- currentSubtotalPriceSet: MoneyBag!
- # A list of all tax lines applied to line items on the order, after returns.
- # Tax line prices represent the total price for all tax lines with the same rate and title.
- currentTaxLines: [TaxLine!]!
- # The total amount discounted on the order after returns, in shop and presentment currencies.
- # This includes both order and line level discounts.
- currentTotalDiscountsSet: MoneyBag!
- # The total amount of duties after returns, in shop and presentment currencies.
- # Returns null if duties aren't applicable.
- currentTotalDutiesSet: MoneyBag
- # The total price of the order, after returns, in shop and presentment currencies.
- # This includes taxes and discounts.
- currentTotalPriceSet: MoneyBag!
- # The sum of the prices of all tax lines applied to line items on the order, after returns, in shop and presentment currencies.
- currentTotalTaxSet: MoneyBag!
- # The total weight of the order after returns, in grams.
- currentTotalWeight: UnsignedInt64!
- # A list of the custom attributes added to the order.
- customAttributes: [Attribute!]!
- # The customer that placed the order.
- customer: Customer
- # Whether the customer agreed to receive marketing materials.
- customerAcceptsMarketing: Boolean!
- # The customer's visits and interactions with the online store before placing the order.
- customerJourneySummary: CustomerJourneySummary
- # A two-letter or three-letter language code, optionally followed by a region modifier.
- customerLocale: String
- # A list of discounts that are applied to the order, not including order edits and refunds.
- discountApplications(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): DiscountApplicationConnection!
- # The discount code used for the order.
- discountCode: String
- # The discount codes used for the order.
- discountCodes: [String!]!
- # The primary address of the customer.
- # Returns null if neither the shipping address nor the billing address was provided.
- displayAddress: MailingAddress
- # The financial status of the order that can be shown to the merchant.
- # This field does not capture all the details of an order's financial state. It should only be used for display summary purposes.
- displayFinancialStatus: OrderDisplayFinancialStatus
- # The fulfillment status for the order that can be shown to the merchant.
- # This field does not capture all the details of an order's fulfillment state. It should only be used for display summary purposes.
- # For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
- displayFulfillmentStatus: OrderDisplayFulfillmentStatus!
- # A list of the disputes associated with the order.
- disputes: [OrderDisputeSummary!]!
- # Whether the order has had any edits applied.
- edited: Boolean!
- # The email address associated with the customer.
- email: String
- # Whether taxes on the order are estimated.
- # This field returns false when taxes on the order are finalized and aren't subject to any changes.
- estimatedTaxes: Boolean!
- # A list of events associated with the order.
- events(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- sortKey: EventSortKeys = ID
- query: String
- ): EventConnection!
- # Whether there are line items that can be fulfilled.
- # This field returns false when the order has no fulfillable line items.
- # For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
- fulfillable: Boolean!
- # A list of fulfillment orders for the order.
- fulfillmentOrders(
- displayable: Boolean = false
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- query: String
- ): FulfillmentOrderConnection!
- # List of shipments for the order.
- fulfillments(first: Int): [Fulfillment!]!
- # Whether the order has been paid in full.
- fullyPaid: Boolean!
- # Whether the merchant added a timeline comment to the order.
- hasTimelineComment: Boolean!
- # A globally-unique identifier.
- id: ID!
- # The ID of the corresponding resource in the REST Admin API.
- legacyResourceId: UnsignedInt64!
- # A list of the order's line items.
- lineItems(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): LineItemConnection!
- # List of localization extensions for the resource.
- localizationExtensions(
- countryCodes: [CountryCode!]
- purposes: [LocalizationExtensionPurpose!]
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): LocalizationExtensionConnection!
- # Whether the order can be edited by the merchant. For example, canceled orders can’t be edited.
- merchantEditable: Boolean!
- # A list of reasons why the order can't be edited. For example, "Canceled orders can’t be edited".
- merchantEditableErrors: [String!]!
- # The application acting as the Merchant of Record for the order.
- merchantOfRecordApp: OrderApp
- # Returns a metafield by namespace and key that belongs to the resource.
- metafield(namespace: String!key: String!): Metafield
- # List of metafield definitions.
- metafieldDefinitions(
- namespace: String
- pinnedStatus: MetafieldDefinitionPinnedStatus = ANY
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- sortKey: MetafieldDefinitionSortKeys = ID
- query: String
- ): MetafieldDefinitionConnection!
- # List of metafields that belong to the resource.
- metafields(
- namespace: String
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): MetafieldConnection!
- # The unique identifier for the order that appears on the order page in the Shopify admin and the order status page.
- # For example, "#1001", "EN1001", or "1001-A".
- # This value isn't unique across multiple stores.
- name: String!
- # The net payment for the order, based on the total amount received minus the total amount refunded, in shop and presentment currencies.
- netPaymentSet: MoneyBag!
- # A list of line items that can't be fulfilled.
- # For example, tips and fully refunded line items can't be fulfilled.
- # For a more granular view of the fulfillment status, refer to the FulfillmentOrder object.
- nonFulfillableLineItems(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): LineItemConnection!
- # The contents of the note associated with the order.
- note: String
- # The total amount of duties before returns, in shop and presentment currencies.
- # Returns null if duties aren't applicable.
- originalTotalDutiesSet: MoneyBag
- # The total price of the order at the time of order creation, in shop and presentment currencies.
- originalTotalPriceSet: MoneyBag!
- # The payment collection details for the order.
- paymentCollectionDetails: OrderPaymentCollectionDetails!
- # A list of the names of all payment gateways used for the order.
- # For example, "Shopify Payments" and "Cash on Delivery (COD)".
- paymentGatewayNames: [String!]!
- # The payment terms associated with the order.
- paymentTerms: PaymentTerms
- # The phone number associated with the customer.
- phone: String
- # The fulfillment location that was assigned when the order was created.
- # Use the FulfillmentOrder object for up to date fulfillment location information.
- physicalLocation: Location
- # The payment CurrencyCode of the customer for the order.
- presentmentCurrencyCode: CurrencyCode!
- # Returns a private metafield by namespace and key that belongs to the resource.
- privateMetafield(namespace: String!key: String!): PrivateMetafield
- # List of private metafields that belong to the resource.
- privateMetafields(
- namespace: String
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): PrivateMetafieldConnection!
- # The date and time when the order was processed.
- # This date and time might not match the date and time when the order was created.
- processedAt: DateTime!
- # The publication that the order was created from.
- publication: Publication
- # The purchasing entity for the order.
- purchasingEntity: PurchasingEntity
- # The difference between the suggested and actual refund amount of all refunds that have been applied to the order. A positive value indicates a difference in the merchant's favor, and a negative value indicates a difference in the customer's favor.
- refundDiscrepancySet: MoneyBag!
- # Whether the order can be refunded.
- refundable: Boolean!
- # A list of refunds that have been applied to the order.
- refunds(first: Int): [Refund!]!
- # The URL of the source that the order originated from, if found in the domain registry.
- registeredSourceUrl: URL
- # Whether the order has shipping lines or at least one line item on the order that requires shipping.
- requiresShipping: Boolean!
- # Whether any line item on the order can be restocked.
- restockable: Boolean!
- # The fraud risk level of the order.
- riskLevel: OrderRiskLevel!
- # A list of risks associated with the order.
- risks(first: Int): [OrderRisk!]!
- # The mailing address of the customer.
- shippingAddress: MailingAddress
- # A summary of all shipping costs on the order.
- shippingLine: ShippingLine
- # A list of the order's shipping lines.
- shippingLines(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): ShippingLineConnection!
- # A unique POS or third party order identifier.
- # For example, "1234-12-1000" or "111-98567-54". The receipt_number field is derived from this value for POS orders.
- sourceIdentifier: String
- # The sum of the quantities for all line items that contribute to the order's subtotal price.
- subtotalLineItemsQuantity: Int!
- # The sum of the prices for all line items after discounts and before returns, in shop and presentment currencies.
- # If taxesIncluded is true, then the subtotal also includes tax.
- subtotalPriceSet: MoneyBag
- # A suggested refund for the order.
- suggestedRefund(
- shippingAmount: Money
- refundShipping: Boolean
- refundLineItems: [RefundLineItemInput!]
- refundDuties: [RefundDutyInput!]
- suggestFullRefund: Boolean = false
- ): SuggestedRefund
- # A comma separated list of tags associated with the order. Updating tags overwrites
- # any existing tags that were previously added to the order. To add new tags without overwriting
- # existing tags, use the tagsAdd mutation.
- tags: [String!]!
- # A list of all tax lines applied to line items on the order, before returns.
- # Tax line prices represent the total price for all tax lines with the same rate and title.
- taxLines: [TaxLine!]!
- # Whether taxes are included in the subtotal price of the order.
- taxesIncluded: Boolean!
- # Whether the order is a test.
- # Test orders are made using the Shopify Bogus Gateway or a payment provider with test mode enabled.
- # A test order cannot be converted into a real order and vice versa.
- test: Boolean!
- # The authorized amount that is uncaptured or undercaptured, in shop and presentment currencies.
- # This amount isn't adjusted for returns.
- totalCapturableSet: MoneyBag!
- # The total amount discounted on the order before returns, in shop and presentment currencies.
- # This includes both order and line level discounts.
- totalDiscountsSet: MoneyBag
- # The total amount not yet transacted for the order, in shop and presentment currencies.
- # A positive value indicates a difference in the merchant's favor (payment from customer to merchant) and a negative value indicates a difference in the customer's favor (refund from merchant to customer).
- totalOutstandingSet: MoneyBag!
- # The total price of the order, before returns, in shop and presentment currencies.
- # This includes taxes and discounts.
- totalPriceSet: MoneyBag!
- # The total amount received from the customer before returns, in shop and presentment currencies.
- totalReceivedSet: MoneyBag!
- # The total amount that was refunded, in shop and presentment currencies.
- totalRefundedSet: MoneyBag!
- # The total amount of shipping that was refunded, in shop and presentment currencies.
- totalRefundedShippingSet: MoneyBag!
- # The total shipping amount before discounts and returns, in shop and presentment currencies.
- totalShippingPriceSet: MoneyBag!
- # The total tax amount before returns, in shop and presentment currencies.
- totalTaxSet: MoneyBag
- # The sum of all tip amounts for the order, in shop and presentment currencies.
- totalTipReceivedSet: MoneyBag!
- # The total weight of the order before returns, in grams.
- totalWeight: UnsignedInt64
- # A list of transactions associated with the order.
- transactions(
- first: Int
- capturable: Boolean
- manuallyResolvable: Boolean
- ): [OrderTransaction!]!
- # Whether no payments have been made for the order.
- unpaid: Boolean!
- # The date and time when the order was modified last.
- updatedAt: DateTime!
- }
- # Represents the payment schedule for a single payment defined in the payment terms.
- type PaymentSchedule implements Node {
- # Amount owed for this payment schedule.
- amount: MoneyV2!
- # Date and time when the payment schedule is paid or fulfilled.
- completedAt: DateTime
- # Date and time when the payment schedule is due.
- dueAt: DateTime
- # A globally-unique identifier.
- id: ID!
- # Date and time when the invoice is sent.
- issuedAt: DateTime
- }
- # Represents the payment terms for an order or draft order.
- type PaymentTerms implements Node {
- # Duration of payment terms in days based on the payment terms template used to create the payment terms.
- dueInDays: Int
- # A globally-unique identifier.
- id: ID!
- # Whether the payment terms have overdue payment schedules.
- overdue: Boolean!
- # List of schedules for the payment terms.
- paymentSchedules(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): PaymentScheduleConnection!
- # The name of the payment terms template used to create the payment terms.
- paymentTermsName: String!
- # The payment terms template type used to create the payment terms.
- paymentTermsType: PaymentTermsType!
- # The payment terms name, translated into the shop admin's preferred language.
- translatedName: String!
- }
- # Represents a selling method (for example, "Subscribe and save" or "Pre-paid"). Selling plan groups
- # and associated records (selling plans and policies) are deleted 48 hours after a merchant
- # uninstalls their subscriptions app. We recommend backing up these records if you need to restore them later.
- type SellingPlanGroup implements Node {
- # The identifier for app, exposed in Liquid and product JSON.
- appId: String
- # Whether the given product is directly associated to the selling plan group.
- appliesToProduct(productId: ID!): Boolean!
- # Whether the given product variant is directly associated to the selling plan group.
- appliesToProductVariant(productVariantId: ID!): Boolean!
- # Whether any of the product variants of the given product are associated to the selling plan group.
- appliesToProductVariants(productId: ID!): Boolean!
- # The date and time when the selling plan group was created.
- createdAt: DateTime!
- # The merchant-facing description of the selling plan group.
- description: String
- # A globally-unique identifier.
- id: ID!
- # The merchant-facing label of the selling plan group.
- merchantCode: String!
- # The buyer-facing label of the selling plan group.
- name: String!
- # The values of all options available on the selling plan group. Selling plans are grouped together in Liquid when they are created by the same app, and have the same selling_plan_group.name and selling_plan_group.options values.
- options: [String!]!
- # The relative position of the selling plan group for display.
- position: Int
- # A count of products associated to the selling plan group.
- productCount: Int!
- # A count of product variants associated to the selling plan group.
- productVariantCount(productId: ID): Int!
- # Product variants associated to the selling plan group.
- productVariants(
- productId: ID
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): ProductVariantConnection!
- # Products associated to the selling plan group.
- products(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): ProductConnection!
- # Selling plans associated to the selling plan group.
- sellingPlans(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): SellingPlanConnection!
- # A summary of the policies associated to the selling plan group.
- summary: String
- }
- # Represents how a product can be sold and purchased. Selling plans and associated records (selling plan groups
- # and policies) are deleted 48 hours after a merchant uninstalls their subscriptions app. We recommend backing
- # up these records if you need to restore them later.
- #
- # For more information on selling plans, refer to
- # Creating and managing selling plans.
- type SellingPlan implements Node {
- # A selling plan policy which describes the recurring billing details.
- billingPolicy: SellingPlanBillingPolicy!
- # The category used to classify the selling plan for reporting purposes.
- category: SellingPlanCategory
- # The date and time when the selling plan was created.
- createdAt: DateTime!
- # A selling plan policy which describes the delivery details.
- deliveryPolicy: SellingPlanDeliveryPolicy!
- # Buyer facing string which describes the selling plan commitment.
- description: String
- # A globally-unique identifier.
- id: ID!
- # When to reserve inventory for a selling plan.
- inventoryPolicy: SellingPlanInventoryPolicy
- # A customer-facing description of the selling plan.
- #
- # If your store supports multiple currencies, then don't include country-specific pricing content,
- # such as "Buy monthly, get 10$ CAD off". This field won't be converted to reflect different currencies.
- name: String!
- # The values of all options available on the selling plan.
- # Selling plans are grouped together in Liquid when they are created by the same app,
- # and have the same selling_plan_group.name and selling_plan_group.options values.
- options: [String!]!
- # Relative position of the selling plan for display. A lower position will be displayed before a higher position.
- position: Int
- # Selling plan pricing details.
- pricingPolicies: [SellingPlanPricingPolicy!]!
- }
- # The selling plan inventory policy.
- type SellingPlanInventoryPolicy {
- # When to reserve inventory for the order.
- reserve: SellingPlanReserve!
- }
- # A payment transaction in the context of an order.
- type OrderTransaction implements Node {
- # The masked account number associated with the payment method.
- accountNumber: String
- # The amount and currency of the transaction in shop and presentment currencies.
- amountSet: MoneyBag!
- authorizationCode: String
- # Authorization code associated with the transaction.
- # The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.
- authorizationExpiresAt: DateTime
- # Date and time when the transaction was created.
- createdAt: DateTime!
- # A standardized error code, independent of the payment provider.
- errorCode: OrderTransactionErrorCode
- # The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
- fees: [TransactionFee!]!
- # The human-readable payment gateway name used to process the transaction.
- formattedGateway: String
- # The payment gateway used to process the transaction.
- gateway: String
- # A globally-unique identifier.
- id: ID!
- # The kind of transaction.
- kind: OrderTransactionKind!
- # Whether the transaction can be manually captured.
- manuallyCapturable: Boolean!
- # Specifies the available amount with currency to refund on the gateway.
- # This value is only available for transactions of type SuggestedRefund.
- maximumRefundableV2: MoneyV2
- # The associated order.
- order: Order
- # The associated parent transaction, for example the authorization of a capture.
- parentTransaction: OrderTransaction
- # The payment icon to display for the transaction.
- paymentIcon: Image
- # Date and time when the transaction was processed.
- processedAt: DateTime
- # The transaction receipt that the payment gateway attaches to the transaction.
- # The value of this field depends on which payment gateway processed the transaction.
- receiptJson: JSON
- # The settlement currency.
- settlementCurrency: CurrencyCode
- # The rate used when converting the transaction amount to settlement currency.
- settlementCurrencyRate: Decimal
- # Contains all Shopify Payments information related to an order transaction.
- # This field is available only to stores on a Shopify Plus plan.
- shopifyPaymentsSet: ShopifyPaymentsTransactionSet
- # The status of this transaction.
- status: OrderTransactionStatus!
- # Whether the transaction is a test transaction.
- test: Boolean!
- # Specifies the available amount with currency to capture on the gateway in shop and presentment currencies.
- # Only available when an amount is capturable or manually mark as paid.
- totalUnsettledSet: MoneyBag
- # Staff member who was logged into the Shopify POS device when the transaction was processed.
- user: StaffMember
- }
- # Transaction fee related to an order transaction.
- type TransactionFee implements Node {
- # Amount of the fee.
- amount: MoneyV2!
- # Flat rate charge for a transaction.
- flatFee: MoneyV2!
- # Name of the credit card flat fee.
- flatFeeName: String
- # A globally-unique identifier.
- id: ID!
- # Percentage charge.
- rate: Decimal!
- # Name of the credit card rate.
- rateName: String
- # Tax amount charged on the fee.
- taxAmount: MoneyV2!
- # Name of the type of fee.
- type: String!
- }
- # Presents all Shopify Payments specific information related to an order transaction.
- type ShopifyPaymentsTransactionSet {
- # Contains all fields related to an extended authorization.
- extendedAuthorizationSet: ShopifyPaymentsExtendedAuthorization
- # Contains all fields related to a refund.
- refundSet: ShopifyPaymentsRefundSet
- }
- # Presents all Shopify Payments specific information related to an order refund.
- type ShopifyPaymentsRefundSet {
- # The acquirer reference number (ARN) code generated for Visa/Mastercard transactions.
- acquirerReferenceNumber: String
- }
- # Presents all Shopify Payments information related to an extended authorization.
- type ShopifyPaymentsExtendedAuthorization {
- # The time after which the extended authorization expires.
- # After the expiry, the merchant is unable to capture the payment.
- extendedAuthorizationExpiresAt: DateTime!
- # The time after which capture will incur an additional fee.
- standardAuthorizationExpiresAt: DateTime!
- }
- # Represents a refund suggested by Shopify based on the items being reimbursed.
- # You can then use the suggested refund object to generate an actual refund.
- type SuggestedRefund {
- # The total monetary value to be refunded in shop and presentment currencies.
- amountSet: MoneyBag!
- # The sum of all the discounted prices of the line items being refunded.
- discountedSubtotalSet: MoneyBag!
- # The total monetary value available to refund in shop and presentment currencies.
- maximumRefundableSet: MoneyBag!
- # A list of duties to be refunded from the order.
- refundDuties: [RefundDuty!]!
- # A list of line items to be refunded, along with restock instructions.
- refundLineItems: [RefundLineItem!]!
- # The shipping costs to be refunded from the order.
- shipping: ShippingRefund!
- # The sum of all the prices of the line items being refunded in shop and presentment currencies.
- subtotalSet: MoneyBag!
- # A list of suggested order transactions.
- suggestedTransactions: [SuggestedOrderTransaction!]!
- # The total cart discount amount that was applied to all line items in this refund.
- totalCartDiscountAmountSet: MoneyBag!
- # The sum of all the duties being refunded from the order in shop and presentment currencies. The value must be positive.
- totalDutiesSet: MoneyBag!
- # The sum of the taxes being refunded from the order in shop and presentment currencies. The value must be positive.
- totalTaxSet: MoneyBag!
- }
- # A suggested transaction. Suggested transaction are usually used in the context of refunds
- # and exchanges.
- type SuggestedOrderTransaction {
- # The masked account number associated with the payment method.
- accountNumber: String
- # The amount and currency of the suggested order transaction in shop and presentment currencies.
- amountSet: MoneyBag!
- # The human-readable payment gateway name suggested to process the transaction.
- formattedGateway: String
- # The suggested payment gateway used to process the transaction.
- gateway: String
- # Specifies the kind of the suggested order transaction.
- kind: SuggestedOrderTransactionKind!
- # Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
- maximumRefundableSet: MoneyBag
- # The associated parent transaction, for example the authorization of a capture.
- parentTransaction: OrderTransaction
- }
- # Represents the shipping costs refunded on the Refund.
- type ShippingRefund {
- # The monetary value of the shipping fees to be refunded in shop and presentment currencies.
- amountSet: MoneyBag!
- # The maximum amount of shipping fees currently refundable in shop and presentment currencies.
- maximumRefundableSet: MoneyBag!
- # The monetary value of the tax allocated to shipping fees to be refunded in shop and presentment currencies.
- taxSet: MoneyBag!
- }
- # A line item that's included in a refund.
- type RefundLineItem {
- # The LineItem resource associated to the refunded line item.
- lineItem: LineItem!
- # The inventory restock location.
- location: Location
- # The price of a refunded line item in shop and presentment currencies.
- priceSet: MoneyBag!
- # The quantity of a refunded line item.
- quantity: Int!
- # The type of restock for the refunded line item.
- restockType: RefundLineItemRestockType!
- # Whether the refunded line item was restocked. Not applicable in the context of a SuggestedRefund.
- restocked: Boolean!
- # The subtotal price of a refunded line item in shop and presentment currencies.
- subtotalSet: MoneyBag!
- # The total tax charged on a refunded line item in shop and presentment currencies.
- totalTaxSet: MoneyBag!
- }
- type LineItem implements Node {
- # The subscription contract associated with this line item.
- contract: SubscriptionContract
- # The line item's quantity, minus the removed quantity.
- currentQuantity: Int!
- # A list of attributes that represent custom features or special requests.
- customAttributes: [Attribute!]!
- # The discounts that have been allocated onto the line item by discount applications.
- discountAllocations: [DiscountAllocation!]!
- # The total line price after discounts are applied, in shop and presentment currencies.
- discountedTotalSet: MoneyBag!
- # The approximate split price of a line item unit, in shop and presentment currencies.
- # This value doesn't include discounts applied to the entire order.
- discountedUnitPriceSet: MoneyBag!
- # The duties associated with the line item.
- duties: [Duty!]!
- # A globally-unique identifier.
- id: ID!
- # The image associated to the line item's variant.
- image: Image
- # Whether the line item can be edited or not.
- merchantEditable: Boolean!
- # The name of the product.
- name: String!
- # The total number of units that can't be fulfilled.
- # For example, if items have been refunded, or the item is not something that can be fulfilled,
- # like a tip.Please see the FulfillmentOrder object for more fulfillment details.
- nonFulfillableQuantity: Int!
- # The total price in shop and presentment currencies, without discounts applied.
- # This value is based on the unit price of the variant x quantity.
- originalTotalSet: MoneyBag!
- # The variant unit price without discounts applied, in shop and presentment currencies.
- originalUnitPriceSet: MoneyBag!
- # The Product object associated with this line item's variant.
- product: Product
- # The number of variant units ordered.
- quantity: Int!
- # The line item's quantity, minus the removed quantity.
- refundableQuantity: Int!
- # Whether physical shipping is required for the variant.
- requiresShipping: Boolean!
- # Whether the line item can be restocked.
- restockable: Boolean!
- # The selling plan details associated with the line item.
- sellingPlan: LineItemSellingPlan
- sku: String
- # The variant SKU number.
- # Staff attributed to the initial sale of the line item.
- staffMember: StaffMember
- # The taxes charged for this line item.
- taxLines(first: Int): [TaxLine!]!
- # Whether the variant is taxable.
- taxable: Boolean!
- # The title of the product.
- title: String!
- # The total amount of the discount that's allocated to the line item, in the shop and presentment currencies.
- # This field must be explicitly set using draft orders, Shopify scripts, or the API.
- totalDiscountSet: MoneyBag!
- # The total discounted value of unfulfilled units, in shop and presentment currencies.
- unfulfilledDiscountedTotalSet: MoneyBag!
- # The total price, without any discounts applied.
- # This value is based on the unit price of the variant x quantity of all unfulfilled units, in shop and presentment currencies.
- unfulfilledOriginalTotalSet: MoneyBag!
- # The number of units not yet fulfilled.
- unfulfilledQuantity: Int!
- # The Variant object associated with this line item.
- variant: ProductVariant
- # The name of the variant.
- variantTitle: String
- # The name of the vendor who made the variant.
- vendor: String
- }
- # Custom subscription discount.
- type SubscriptionManualDiscount {
- # Entitled line items used to apply the subscription discount on.
- entitledLines: SubscriptionDiscountEntitledLines!
- # The unique identifier.
- id: ID!
- # The maximum number of times the subscription discount will be applied on orders.
- recurringCycleLimit: Int
- # The reason that the discount on the subscription draft is rejected.
- rejectionReason: SubscriptionDiscountRejectionReason
- # Type of line the discount applies on.
- targetType: DiscountTargetType!
- # The title associated with the subscription discount.
- title: String
- # The type of the subscription discount.
- type: DiscountType!
- # The number of times the discount was applied.
- usageCount: Int!
- # The value of the subscription discount.
- value: SubscriptionDiscountValue!
- }
- # Represents the subscription lines the discount applies on.
- type SubscriptionDiscountEntitledLines {
- # Specify whether the subscription discount will apply on all subscription lines.
- all: Boolean!
- # The list of subscription lines associated with the subscription discount.
- lines(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): SubscriptionLineConnection!
- }
- # Represents a Subscription Line.
- type SubscriptionLine {
- # The price per unit for the subscription line in the contract's currency.
- currentPrice: MoneyV2!
- # List of custom attributes associated to the line item.
- customAttributes: [Attribute!]!
- # Discount allocations.
- discountAllocations: [SubscriptionDiscountAllocation!]!
- # The unique identifier.
- id: ID!
- # Total line price including all discounts.
- lineDiscountedPrice: MoneyV2!
- # Describe the price changes of the line over time.
- pricingPolicy: SubscriptionPricingPolicy
- # The product id associated with the subscription line.
- productId: ID
- # The quantity of the unit selected for the subscription line.
- quantity: Int!
- # Whether physical shipping is required for the variant.
- requiresShipping: Boolean!
- # The selling plan ID associated to the line.
- #
- # Indicates which selling plan was used to create this
- # contract line initially. The selling plan ID is also used to
- # find the associated delivery profile.
- #
- # The subscription contract, subscription line, or selling plan might have
- # changed. As a result, the selling plan's attributes might not
- # match the information on the contract.
- sellingPlanId: ID
- # The selling plan name associated to the line. This name describes
- # the order line items created from this subscription line
- # for both merchants and customers.
- #
- # The value can be different from the selling plan's name, because both
- # the selling plan's name and the subscription line's selling_plan_name
- # attribute can be updated independently.
- sellingPlanName: String
- # Variant SKU number of the item associated with the subscription line.
- sku: String
- # Whether the variant is taxable.
- taxable: Boolean!
- # Product title of the item associated with the subscription line.
- title: String!
- # The product variant id associated with the subscription line.
- variantId: ID
- # The image associated with the line item's variant or product.
- variantImage: Image
- # Product variant title of the item associated with the subscription line.
- variantTitle: String
- }
- # Represents a Subscription Delivery Policy.
- type SubscriptionDeliveryPolicy {
- # The specific anchor dates upon which the delivery interval calculations should be made.
- anchors: [SellingPlanAnchor!]!
- # The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc).
- interval: SellingPlanInterval!
- # The number of delivery intervals between deliveries.
- intervalCount: Int!
- }
- # Represents a Subscription Billing Policy.
- type SubscriptionBillingPolicy {
- # Specific anchor dates upon which the billing interval calculations should be made.
- anchors: [SellingPlanAnchor!]!
- # The kind of interval that is associated with this schedule (e.g. Monthly, Weekly, etc).
- interval: SellingPlanInterval!
- # The number of billing intervals between invoices.
- intervalCount: Int!
- # Maximum amount of cycles after which the subscription ends.
- maxCycles: Int
- # Minimum amount of cycles required in the subscription.
- minCycles: Int
- }
- # Represents a selling plan policy anchor.
- type SellingPlanAnchor {
- # The cutoff day for the anchor.
- #
- # If type is WEEKDAY, then the value must be between 1-7. Shopify interprets
- # the days of the week according to ISO 8601, where 1 is Monday.
- #
- # If type is MONTHDAY, then the value must be between 1-31.
- #
- # If type is YEARDAY, then the value must be null.
- cutoffDay: Int
- # The day of the anchor.
- #
- # If type is WEEKDAY, then the value must be between 1-7. Shopify interprets
- # the days of the week according to ISO 8601, where 1 is Monday.
- #
- # If type is not WEEKDAY, then the value must be between 1-31.
- day: Int!
- # The month of the anchor. If type is different than YEARDAY, then the value must
- # be null or between 1-12.
- month: Int
- # Represents the anchor type, it can be one one of WEEKDAY, MONTHDAY, YEARDAY.
- type: SellingPlanAnchorType!
- }
- # Represents a Subscription Line Pricing Policy.
- type SubscriptionPricingPolicy {
- # The base price per unit for the subscription line in the contract's currency.
- basePrice: MoneyV2!
- # The adjustments per cycle for the subscription line.
- cycleDiscounts: [SubscriptionCyclePriceAdjustment!]!
- }
- # Represents a Subscription Line Pricing Cycle Adjustment.
- type SubscriptionCyclePriceAdjustment {
- # Price adjustment type.
- adjustmentType: SellingPlanPricingPolicyAdjustmentType!
- # Price adjustment value.
- adjustmentValue: SellingPlanPricingPolicyAdjustmentValue!
- # The number of cycles required before this pricing policy applies.
- afterCycle: Int!
- # The computed price after the adjustments applied.
- computedPrice: MoneyV2!
- }
- # Represents what a particular discount reduces from a line price.
- type SubscriptionDiscountAllocation {
- # Allocation amount.
- amount: MoneyV2!
- # Discount that created the allocation.
- discount: SubscriptionDiscount!
- }
- # Represents the selling plan for a line item.
- type LineItemSellingPlan {
- # The name of the selling plan for display purposes.
- name: String!
- # The ID of the selling plan associated with the line item.
- sellingPlanId: ID
- }
- type Duty implements Node {
- # The ISO 3166-1 alpha-2 country code of the country of origin used in calculating the duty.
- countryCodeOfOrigin: CountryCode
- # The harmonized system code of the item used in calculating the duty.
- harmonizedSystemCode: String
- # A globally-unique identifier.
- id: ID!
- # The amount of the duty.
- price: MoneyBag!
- # A list of taxes charged on the duty.
- taxLines: [TaxLine!]!
- }
- # Represents a refunded duty.
- type RefundDuty {
- # The amount of a refunded duty in shop and presentment currencies.
- amountSet: MoneyBag!
- # The duty associated with this refunded duty.
- originalDuty: Duty
- }
- # The record of the line items and transactions that were refunded to a customer,
- # along with restocking instructions for refunded line items.
- type Refund implements LegacyInteroperability&Node {
- # The date and time when the refund was created.
- createdAt: DateTime
- # A list of the refunded duties as part of this refund.
- duties: [RefundDuty!]
- # A globally-unique identifier.
- id: ID!
- # The ID of the corresponding resource in the REST Admin API.
- legacyResourceId: UnsignedInt64!
- # The optional note associated with the refund.
- note: String
- # The order associated with the refund.
- order: Order!
- # The RefundLineItem resources attached to the refund.
- refundLineItems(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): RefundLineItemConnection!
- # The staff member who created the refund.
- staffMember: StaffMember
- # The total amount across all transactions for the refund, in shop and presentment currencies.
- totalRefundedSet: MoneyBag!
- # The transactions associated with the refund.
- transactions(
- first: Int
- after: String
- last: Int
- before: String
- reverse: Boolean = false
- ): OrderTransactionConnection!
- # The date and time when the refund was updated.
- updatedAt: DateTime!
- }
- # Represents a fraud check on an order.
- type OrderRisk {
- # Whether the risk level is shown in the Shopify admin.
- # If false, then this order risk is ignored when Shopify determines the overall risk level for the order.
- display: Boolean!
- # The likelihood that an order is fraudulent, based on this order risk.
- #
- # The level can be set by Shopify risk analysis or by an app.
- level: OrderRiskLevel
- # The risk message that's shown to the merchant in the Shopify admin.
- message: String
- }
- # The payment collection details for an order that requires additional payment following an edit to the order.
- type OrderPaymentCollectionDetails {
- # The URL to use for collecting an additional payment on the order.
- additionalPaymentCollectionUrl: URL
- # The list of vaulted payment methods for the order with their permissions.
- vaultedPaymentMethods: [PaymentMandate!]
- }
- # A payment instrument and the permission
- # the owner of the instrument gives to the merchant to debit it.
- type PaymentMandate implements Node {
- # The unique identifier of a payment mandate.
- id: ID!
- # The outputs details of the payment instrument.
- paymentInstrument: PaymentInstrument!
- }
- # The fields required to reimburse duties on a refund.
- input RefundDutyInput {
- # The ID of the duty in the refund.
- dutyId: ID!
- # The type of refund for this duty.
- refundType: RefundDutyRefundType
- }
- # The fields required to reimburse line items on a refund.
- input RefundLineItemInput {
- # The ID of the line item in the refund.
- lineItemId: ID!
- # The quantity of the associated line item to be refunded.
- quantity: Int!
- # The type of restock for this line item.
- restockType: RefundLineItemRestockType
- # The intended location for restocking. If the restockType is set to NO_RESTOCK, then this value is empty.`
- locationId: ID
- }
- # A summary of the important details for a dispute on an order.
- type OrderDisputeSummary implements Node {
- # A globally-unique identifier.
- id: ID!
- # The type that the dispute was initiated as.
- initiatedAs: DisputeType!
- # The current status of the dispute.
- status: DisputeStatus!
- }
- # The tax allocated to a sale from a single tax line.
- type SaleTax {
- # The portion of the total tax amount on the related sale that comes from the associated tax line.
- amount: MoneyBag!
- # The unique identifier for the sale tax.
- id: ID!
- # The tax line associated with the sale.
- taxLine: TaxLine!
- }
- # A record of an execution of the subscription billing process. Billing attempts use
- #idempotency keys to avoid duplicate order creation. A successful billing attempt
- #will create an order.
- type SubscriptionBillingAttempt implements Node {
- # The date and time when the billing attempt was completed.
- completedAt: DateTime
- # The date and time when the billing attempt was created.
- createdAt: DateTime!
- # A code corresponding to a payment error during processing.
- errorCode: SubscriptionBillingAttemptErrorCode
- # A message describing a payment error during processing.
- errorMessage: String
- # A globally-unique identifier.
- id: ID!
- # A unique key generated by the client to avoid duplicate payments.
- idempotencyKey: String!
- # The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
- nextActionUrl: URL
- # The result of this billing attempt if completed successfully.
- order: Order
- # The date and time used to calculate fulfillment intervals for a billing attempt that
- # successfully completed after the current anchor date. To prevent fulfillment from being
- # pushed to the next anchor date, this field can override the billing attempt date.
- originTime: DateTime
- # Whether the billing attempt is still processing.
- ready: Boolean!
- # The subscription contract.
- subscriptionContract: SubscriptionContract!
- }
- # Represents the payment terms template object.
- type PaymentTermsTemplate implements Node {
- # The description of the payment terms template.
- description: String!
- # The number of days between the issued date and due date if this is the net type of payment terms.
- dueInDays: Int
- # A globally-unique identifier.
- id: ID!
- # The name of the payment terms template.
- name: String!
- # The type of the payment terms template.
- paymentTermsType: PaymentTermsType!
- # The translated payment terms template name.
- translatedName: String!
- }
- # The fixed selling plan billing policy.
- type SellingPlanFixedBillingPolicy {
- # The checkout charge when the full amount isn't charged at checkout.
- checkoutCharge: SellingPlanCheckoutCharge!
- # The exact time when to capture the full payment.
- remainingBalanceChargeExactTime: DateTime
- # The period after remaining_balance_charge_trigger, before capturing the full payment.
- # Expressed as an ISO8601 duration.
- remainingBalanceChargeTimeAfterCheckout: String
- # When to capture payment for amount due.
- remainingBalanceChargeTrigger: SellingPlanRemainingBalanceChargeTrigger!
- }
- # The amount charged at checkout when the full amount isn't charged at checkout.
- type SellingPlanCheckoutCharge {
- # The charge type for the checkout charge.
- type: SellingPlanCheckoutChargeType!
- # The charge value for the checkout charge.
- value: SellingPlanCheckoutChargeValue!
- }
- # Represents a recurring selling plan billing policy.
- type SellingPlanRecurringBillingPolicy {
- # Specific anchor dates upon which the billing interval calculations should be made.
- anchors: [SellingPlanAnchor!]!
- # The date and time when the selling plan billing policy was created.
- createdAt: DateTime!
- # The billing frequency, it can be either: day, week, month or year.
- interval: SellingPlanInterval!
- # The number of intervals between billings.
- intervalCount: Int!
- # Maximum number of billing iterations.
- maxCycles: Int
- # Minimum number of billing iterations.
- minCycles: Int
- }
- # Represents a fixed selling plan delivery policy.
- type SellingPlanFixedDeliveryPolicy {
- # The specific anchor dates upon which the delivery interval calculations should be made.
- anchors: [SellingPlanAnchor!]!
- # A buffer period for orders to be included in next fulfillment anchor.
- cutoff: Int
- # The date and time when the fulfillment should trigger.
- fulfillmentExactTime: DateTime
- # What triggers the fulfillment. The value must be one of ANCHOR, ASAP, EXACT_TIME, or UNKNOWN.
- fulfillmentTrigger: SellingPlanFulfillmentTrigger!
- # Whether the delivery policy is merchant or buyer-centric.
- # Buyer-centric delivery policies state the time when the buyer will receive the goods.
- # Merchant-centric delivery policies state the time when the fulfillment should be started.
- # Currently, only merchant-centric delivery policies are supported.
- intent: SellingPlanFixedDeliveryPolicyIntent!
- # The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor.
- # The default value for this field is ASAP.
- preAnchorBehavior: SellingPlanFixedDeliveryPolicyPreAnchorBehavior!
- }
- # Represents a recurring selling plan delivery policy.
- type SellingPlanRecurringDeliveryPolicy {
- # The specific anchor dates upon which the delivery interval calculations should be made.
- anchors: [SellingPlanAnchor!]!
- # The date and time when the selling plan delivery policy was created.
- createdAt: DateTime!
- # A buffer period for orders to be included in a cycle.
- cutoff: Int
- # Whether the delivery policy is merchant or buyer-centric.
- # Buyer-centric delivery policies state the time when the buyer will receive the goods.
- # Merchant-centric delivery policies state the time when the fulfillment should be started.
- # Currently, only merchant-centric delivery policies are supported.
- intent: SellingPlanRecurringDeliveryPolicyIntent!
- # The delivery frequency, it can be either: day, week, month or year.
- interval: SellingPlanInterval!
- # The number of intervals between deliveries.
- intervalCount: Int!
- # The fulfillment or delivery behavior of the first fulfillment when the order is placed before the anchor.
- # The default value for this field is ASAP.
- preAnchorBehavior: SellingPlanRecurringDeliveryPolicyPreAnchorBehavior!
- }
- # The percentage value of the price used for checkout charge.
- type SellingPlanCheckoutChargePercentageValue {
- # The percentage value of the price used for checkout charge.
- percentage: Float!
- }
- # Represents a fixed selling plan pricing policy.
- type SellingPlanFixedPricingPolicy implements SellingPlanPricingPolicyBase {
- # The price adjustment type.
- adjustmentType: SellingPlanPricingPolicyAdjustmentType!
- # The price adjustment value.
- adjustmentValue: SellingPlanPricingPolicyAdjustmentValue!
- # The date and time when the fixed selling plan pricing policy was created.
- createdAt: DateTime!
- }
- # Represents a recurring selling plan pricing policy.
- type SellingPlanRecurringPricingPolicy implements SellingPlanPricingPolicyBase {
- # The price adjustment type.
- adjustmentType: SellingPlanPricingPolicyAdjustmentType!
- # The price adjustment value.
- adjustmentValue: SellingPlanPricingPolicyAdjustmentValue!
- # Cycle after which this pricing policy applies.
- afterCycle: Int
- # The date and time when the recurring selling plan pricing policy was created.
- createdAt: DateTime!
- }
|