Skip to content
FreeTicketDocs
Esc
↑↓navigate↵open⌘Jpreview

Get a sale with its items

Minimum role: STAFF. Active workspace via the X-Workspace-Id header.

GET/sales/{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).

or
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

OK

dataSaleDetailrequired
Show properties
idstringrequired
referencestringrequired
statusstringrequired
Allowed:PENDINGCONFIRMEDABANDONEDCANCELLEDREFUNDED
channelstringrequired
subtotalnumberrequired
discountAmountnumberrequired
serviceFeenumberrequired
ivanumberrequired
totalnumberrequired
currencystringrequired
buyerNamestringrequired
buyerEmailstringrequired
buyerPhonestring | nullrequired
Show properties
Any of:
string
string
null
null
buyerDocumentTypestring | nullrequired
Show properties
Any of:
string
string
null
null
buyerDocumentNumberstring | nullrequired
Show properties
Any of:
string
string
null
null
organizationIdstring | nullrequired
Show properties
Any of:
string
string
null
null
paymentProviderstring | nullrequired
Show properties
Any of:
string
string
null
null
paymentRefstring | nullrequired
Show properties
Any of:
string
string
null
null
confirmedAtstring | nullrequired
Show properties
Any of:
string
string
null
null
createdAtstringrequired
failureReasonstring | nullrequired
Show properties
Any of:
string
string
null
null
paymentStatusstring | nullrequired

Status of the latest payment event. Usually the payment gateway's RAW status in its own vocabulary. Values prefixed with FT_ come from FreeTicket, not the gateway: currently FT_SALE_APPROVED_POST_CONFIRM, which marks that the gateway re-notified an already-confirmed charge — this is how Bold reports its refunds. A CONFIRMED sale with this status may have money refunded that is not yet recorded.

Show properties
Any of:
string
string
null
null
declineCodestring | nullrequired
Show properties
Any of:
string
string
null
null
itemsSaleItem[]required
Show properties
Array of SaleItem
idstringrequired
ticketTypeIdstringrequired
quantityintegerrequired
min -9007199254740991 · max 9007199254740991
unitPricenumberrequired
subtotalnumberrequired
ticketCodestringrequired
checkedInAtstring | nullrequired
Show properties
Any of:
string
string
null
null
seatLabelstring | nullrequired
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
Authorization
Parameters
Request
curl -X GET 'https://admin.appfreeticket.com/api/v1/sales/string' \
  -H 'Authorization: YOUR_API_KEY'
Response
{
  "data": {
    "id": "string",
    "reference": "string",
    "status": "PENDING",
    "channel": "string",
    "subtotal": 0,
    "discountAmount": 0,
    "serviceFee": 0,
    "iva": 0,
    "total": 0,
    "currency": "string",
    "buyerName": "string",
    "buyerEmail": "string",
    "buyerPhone": "string",
    "buyerDocumentType": "string",
    "buyerDocumentNumber": "string",
    "organizationId": "string",
    "paymentProvider": "string",
    "paymentRef": "string",
    "confirmedAt": "string",
    "createdAt": "string",
    "failureReason": "string",
    "paymentStatus": "string",
    "declineCode": "string",
    "items": [
      {
        "id": "string",
        "ticketTypeId": "string",
        "quantity": -9007199254740991,
        "unitPrice": 0,
        "subtotal": 0,
        "ticketCode": "string",
        "checkedInAt": "string",
        "seatLabel": "string"
      }
    ]
  }
}