order24 ops

Order API

Cross-vertical orders, cancel reasons, and lifecycle events.

Queries

QUERY

adminListOrders

Deprecated#

Deprecation reason: Use adminListOrdersWithDetails; BET-205

Arguments

  • input!

    Default

    {
      "pagination": {
        "limit": 10,
        "page": 1,
        "after": null
      },
      "statuses": null,
      "driverId": null,
      "customerId": null,
      "providerId": null,
      "fleetIds": null,
      "serviceClassIds": null,
      "kind": null,
      "ids": null,
      "search": null,
      "fromDate": null,
      "toDate": null,
      "scheduledFromAfter": null,
      "scheduledFromBefore": null,
      "createdAtCursor": null,
      "idCursor": null,
      "sortBy": "CREATED_AT",
      "sortDirection": "ASC"
    }
Returns!
QUERY

adminListOrdersWithDetails

#

List orders with admin filters and pagination. Supports filtering by status, driver, customer, kind, date range, and sorting by various fields. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input
Returns!
QUERY

cancelReason

#

Get a single cancel reason by ID (admin view). # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • idID!
Returns!
QUERY

cancelReasons

#

List cancel reasons available for the current user's role and app This query returns all active cancel reasons that are applicable to: - The user's current role (from JWT token) - The app specified in the request header - The user's tenant Results are ordered by position and name. Never empty. A workspace that has set up no reasons for the role is answered with one whose code is no_reason_given: there is nothing to choose between, so an app cancels under it without asking.

Returns[!]!
QUERY

customerStrikeBlock

#

Current block state for an account / app combo. Returns None when the account has no soft or hard block. Requires TenantAdmin role.

Arguments

  • accountId!
  • app!
Returns
QUERY

exportOrders

#

Export orders in CSV, JSON, or PDF format. # Authorization Requires TenantAdmin or PlatformAdmin role. # Arguments * input - Export parameters including filters and format # Returns Export data with content type and suggested filename. For PDF format, the data is base64-encoded.

Arguments

  • input!

    Default

    {
      "statuses": null,
      "driverId": null,
      "customerId": null,
      "fleetIds": null,
      "serviceClassIds": null,
      "kind": null,
      "fromDate": null,
      "toDate": null,
      "format": "CSV",
      "limit": null
    }
Returns!
QUERY

getPartnershipOrderStatistics

#

Get aggregated statistics for orders associated with a partnership. Returns counts of completed, cancelled, and active orders, along with total revenue and commissions. # Authorization - TenantAdmin/PlatformAdmin can access any partnership - PartnerAdmin can only access their own partnership

Arguments

  • input!
Returns!
QUERY

listCancelReasons

#

List all cancel reasons for the tenant (admin view). Supports filtering by app and actor, with pagination. Unlike the client-facing cancelReasons query, this includes inactive reasons when includeInactive is true. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
QUERY

listPartnershipOrders

#

List orders associated with a partnership. Returns orders where any participant entity is linked to the partnership via entity_partner_links. Uses temporal validity to ensure the link was active at the time of the order. # Authorization - TenantAdmin/PlatformAdmin can access any partnership - PartnerAdmin can only access their own partnership

Arguments

  • input!
Returns!
QUERY

myOrders

#

List my orders - returns orders for the authenticated user filtered by their app

Arguments

  • input
  • pagination
Returns[!]!
QUERY

myOrderStatistics

#

Get order statistics for the authenticated user. Statistics are automatically filtered by the app header (vertical).

Returns!
QUERY

myPaymentBlocks

#

Get active payment blocks for the current user. Returns empty list if no blocks exist.

Returns[!]!
QUERY

order

#

Get a single order by ID. Staff (admin-tier) read any order of their tenant; other callers only an order they are the customer of or a participant in (driver, courier, merchant, provider, attendant).

Arguments

  • orderId!
Returns
QUERY

orderActivities

#

Fetch all activities for a specific order. # Authorization Requires TenantAdmin or PlatformAdmin role. # Arguments * order_id - The order ID to fetch activities for # Returns List of activities associated with the order in chronological order.

Arguments

  • orderId!
Returns[!]!

Mutations

MUTATION

adminCreateOrder

#

Create an order on behalf of a customer. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
MUTATION

adminResolvePaymentBlock

#

Waive an account's active payment block (support/admin escape hatch). # Authorization Requires TenantOwner, TenantAdmin, or PlatformAdmin role.

Arguments

  • blockIdString!
  • notesString
ReturnsBoolean!
MUTATION

cancelOrder

#

Cancel an order with a specified reason This mutation allows customers, drivers, merchants, or staff to cancel an order with appropriate permissions based on their role and the cancel reason configuration. The order service handles the core cancellation logic and may call vertical-specific gRPC services (e.g., Taxi, Shop) for additional validation if needed.

Arguments

  • input!
Returns!
MUTATION

clearCustomerStrikeBlock

#

Clear the soft / hard block for an account on a given app. Used by support staff when a customer has gone through manual review. Does not erase the strike history — only the cached block state. Requires TenantAdmin role.

Arguments

  • accountId!
  • app!
ReturnsBoolean!
MUTATION

confirmOrderPayment

#

Confirm payment for an order after 3DS authentication

Arguments

  • input!
Returns!
MUTATION

createCancelReason

#

Create a new cancel reason. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!
MUTATION

createOrder

#

Create a new order

Arguments

  • input!
Returns!
MUTATION

deleteCancelReason

#

Delete a cancel reason. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • id!
ReturnsBoolean!
MUTATION

resetCustomerStrikes

#

Reset (expire) all active strikes for an account on a given app and clear any block state. Equivalent to the on-tier-upgrade reset, but triggered manually by support. Requires TenantAdmin role.

Arguments

  • accountId!
  • app!
ReturnsBoolean!
MUTATION

updateCancelReason

#

Update an existing cancel reason. # Authorization Requires TenantAdmin or PlatformAdmin role.

Arguments

  • input!
Returns!