Purchase session status

Requires the X-Customer-Session header. The enterprise service API key is OPTIONAL. Returns the status of one of THE buyer’s purchase sessions: live (this tab can create the order), superseded (another tab or device replaced it: stop offering the map and the payment), expired (the map clock ran out or it was released) or converted (it already created its order: orderId). A session whose seatsDeadline has passed is reported as expired immediately. Designed to be polled every ~10 s. Another buyer’s session is 404.

GET/customer/purchase-sessions/{id}

Authorization

AuthorizationAPI key · headerrequired

API key prefixed with Bearer . Alternative: the x-api-key header with the raw key. Available scopes: read and write (see /.well-known/oauth-protected-resource).

x-api-keyAPI key · headerrequired

Raw API key (without Bearer ), alternative to Authorization.

Path parameters

idstringrequired

Header parameters

X-Workspace-Idstring

Active workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Responses

200

dataPurchaseSessionStatusrequired

Show properties

idstringrequired

statestringrequired

live: can create the order. superseded: another tab/device replaced it. expired: the map clock ran out or it was released. converted: it already created its order (orderId).

Allowed:livesupersededexpiredconverted

seatsDeadlinestring | nullrequired

Show properties

Any of:

string

string

null

null

orderIdstring | nullrequired

Sale created with this session, if any.

Show properties

Any of:

string

string

null

null

401

Missing or invalid credential.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

403

Insufficient role or resource not accessible.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

404

Resource does not exist or is out of scope.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

422

Request body/parameter validation failed.

errorobjectrequired

Show properties

codestringrequired

messagestringrequired

retryablebooleanrequired

detailsany

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*X-Workspace-IdheaderActive workspace to operate on. Optional: when omitted, the default workspace of the user who owns the key is used (pickActiveOrg).

Request

curl -X GET 'https://admin.appfreeticket.com/api/v1/customer/purchase-sessions/string' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://admin.appfreeticket.com/api/v1/customer/purchase-sessions/string", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://admin.appfreeticket.com/api/v1/customer/purchase-sessions/string",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "data": {
    "id": "string",
    "state": "live",
    "seatsDeadline": "string",
    "orderId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "retryable": true,
    "details": null
  }
}