Choose a version:

DraftOrderConnection

connection

An auto-generated type for paginating through multiple DraftOrders.

Anchor to Fields with this connectionFields with this connection

Anchor to Company.draftOrders Company.draftOrders •OBJECT: A business entity that purchases from the shop as part of B2B commerce. Companies organize multiple locations and contacts who can place orders on behalf of the organization. CompanyLocation objects can have custom pricing through Catalog and PriceList configurations.
Anchor to CompanyContact.draftOrders CompanyContact.draftOrders •OBJECT: A person who acts on behalf of a Company to make B2B purchases. Company contacts are associated with Customer accounts and can place orders on behalf of their company.

Each contact can be assigned to one or more CompanyLocation objects with specific roles that determine their permissions and access to catalogs, pricing, and payment terms configured for those locations.
Anchor to CompanyLocation.draftOrders CompanyLocation.draftOrders •OBJECT: A location or branch of a Company that's a customer of the shop. Company locations enable B2B customers to manage multiple branches with distinct billing and shipping addresses, tax settings, and checkout configurations.

Each location can have its own Catalog objects that determine which products are published and their pricing. The BuyerExperienceConfiguration determines checkout behavior including PaymentTerms, and whether orders require merchant review. B2B customers select which location they're purchasing for, which determines the applicable catalogs, pricing, TaxExemption values, and checkout settings for their Order objects.
Anchor to CustomerMergePreviewDefaultFields.draftOrders CustomerMergePreviewDefaultFields.draftOrders •OBJECT: The fields that will be kept as part of a customer merge preview.

Was this section helpful?

Anchor to Queries with this connectionQueries with this connection

Anchor to draftOrders draftOrders

•query

List of saved draft orders.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•DraftOrderSortKeys

Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to created_at •time
Anchor to customer_id •id
Anchor to id •id: Filter by id range.
Anchor to source •string
Anchor to status •string
Anchor to tag •string
Anchor to updated_at •time

Anchor to savedSearchIdsavedSearchId

•ID

The ID of a saved search. The search’s query string is used as the query argument.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[DraftOrderEdge!]! non-null: The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.
Anchor to nodesnodes •[DraftOrder!]! non-null: A list of nodes that are contained in DraftOrderEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.

Was this section helpful?