DraftOrder object

Version unstable

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

Required access

read_draft_orders access scope.

Connections

  • events (EventConnection!)

    List of events associated with the draft order.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    query ( String )

    Supported filter parameters:

    • comments
    • created_at
    • subject_type
    • verb

    See the detailed search syntax for more information about using filters.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

    sortKey ( EventSortKeys )

    Sort the underlying list by the given key.
    Default value: ID

  • List of the line items in the draft order.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • localizationExtensions (LocalizationExtensionConnection!)

    List of localization extensions for the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    countryCodes ( [CountryCode!] )

    The country codes of the extensions.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    purposes ( [LocalizationExtensionPurpose!] )

    The purpose of the extensions.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • metafields (MetafieldConnection!)

    List of metafields that belong to the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.

    first ( Int )

    Returns up to the first n elements from the list.

    last ( Int )

    Returns up to the last n elements from the list.

    namespace ( String )

    The metafield namespace to filter by.

    reverse ( Boolean )

    Reverse the order of the underlying list.
    Default value: false

  • privateMetafields (PrivateMetafieldConnection!)

    List of private metafields that belong to the resource.

    Argument Description
    after ( String )

    Returns the elements that come after the specified cursor.

    before ( String )

    Returns the elements that come before the specified cursor.