Order object

Version unstable

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 Admin API.

Required access

read_orders access scope.

Connections

  • Paginated list of sale agreements associated with an 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:

    • happened_at

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

    reverse ( Boolean )

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

  • discountApplications (DiscountApplicationConnection!)

    Discounts that have been applied on the 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.

    </