API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

OrderAgreement object

Version unstable

An agreement associated with an order placement.

Required access

read_orders access scope. Also: This resource is restricted to specific shops.


  • sales (SaleConnection!)

    All individual sales associated with the agreement.

    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


  • app (App)

    The app that created the agreement.

  • happenedAt (DateTime!)

    The date and time at which the agreement occured.

  • id (ID!)

    The unique identifier for the agreement.

  • order (Order!)

    The order associated with the agreement.

  • reason (OrderActionType!)

    The reason the agremeent was created.