1. Getting started

1.1 How do I get access?

  • Step 1: Account creation, get your credentials with your account manager.
  • Step 2: Authentication, after your account is created, obtain tokens via the login mutation. It returns:
    • a short‑lived access token (JWT) for the Authorization header, and
    • a refresh token to obtain new access tokens.

1.2 Environment Setup - where do I find the GraphQL playground and schema?

Use our Apollo Studio Sandbox at https://docs.deal-engine.com/graphql#/.

  • Open the Sandbox link
  • Add Authorization: Bearer <token> header
  • Use the Explorer to run queries and mutations. The schema is in the Docs panel.

1.3 Quickest way to issue my first refund request

Login to get your token:

mutation Login($email: String!, $password: String!) {
    login(email: $email, password: $password) {
        token
        refreshToken
        expiresIn
    }
}

Variables example:

{
    "email": "[email protected]",
    "password": "********"
}
  1. Use the token in subsequent requests with Authorization: Bearer <token>.
  2. Issue your first refund request:
mutation CreateQuote($request: [quoteRequest]!) {
    createQuote(request: $request)
}

Variables example:

{
    "request": [
        {
            "ticketNum": "1282132019309",
            "isEmd": false
        }
    ]
}