api.test.ticketcrm.net
Open in
urlscan Pro
159.69.241.82
Public Scan
URL:
https://api.test.ticketcrm.net/
Submission: On October 10 via automatic, source certstream-suspicious — Scanned from DE
Submission: On October 10 via automatic, source certstream-suspicious — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
* Company Authentication
* Client Authentication
* Content Negotiation
* Pagination
* Order workflow status
* Company
* Company JWT Token
* postRetrieves company token
* EventPoint
* getRetrieves the collection of EventPoint resources.
* getRetrieves the collection of archived EventPoint resources
* getRetrieves a EventPoint resource.
* getRetrieves the collection of EventPoint resources by SeasonTicketOrder
* City
* getRetrieves the collection of City resources.
* getRetrieves a City resource.
* Country
* getRetrieves the collection of Country resources.
* getRetrieves a Country resource.
* Order
* getRetrieves the collection of Order resources.
* postCreates a Order resource.
* getRetrieves a Order resource.
* putReplaces the Order resource.
* putAdd ticket to order by place
* putUpdate reserved to time order
* putUpdate order status
* putRemove ticket from order
* putUpdate ticket status
* getRetrieves a Widget Order resource
* Place
* getRetrieves the collection of all Place resources by EventPoint.
* getRetrieves a Place resource by EventPoint.
* getRetrieves the collection of Place resources by Sector.
* getRetrieves a Place resource by Sector.
* Sector
* getRetrieves the collection of Sector resources.
* getRetrieves a Sector resource.
* Venue
* getRetrieves the collection of Venue resources.
* getRetrieves a Venue resource.
* VenueHall
* getRetrieves the collection of VenueHall resources.
* getRetrieves a VenueHall resource.
* Genre
* getRetrieves the collection of Genre resources.
* getRetrieves a Genre resource.
* Category
* getRetrieves the collection of Category resources.
* getRetrieves a Category resource.
* Barcode
* getRetrieves the collection of Barcode resources.
* getRetrieves a Barcode resource.
* Client
* Client
* getGet current client
* putPUT current client
* postClient Registration
* Client JWT Token
* postRetrieves client token
* AuthCode
* postSend client token
* SeasonTicketOrder
* getRetrieves the collection of SeasonTicketOrder resources.
* getRetrieves the collection of SeasonTicketOrder resources.
Documentation Powered by ReDoc
TICKETSBOX API DOCUMENTATION (2.0)
Download OpenAPI specification:Download
INTRODUCTION
TicketsBox public API documentation. Provides access to events, venues data
collection and reserve tickets by registered companies.
COMPANY AUTHENTICATION
For authentication used JWT token . Example: curl -X GET
{{SERVER_URL}}/api/v2/cities -H 'Authorization: bearer JWT_TOKEN'
You can get JWT_TOKEN from data endpoint /api/v2/token. Example: curl -X POST
{{SERVER_URL}}/api/v2/token -H 'Content-Type: application/json' -d '{"apiKey":
API_KEY}}'.
Default token TTL 86400 seconds (24 hours).
API_KEY - unique api key for company.
CLIENT AUTHENTICATION
For authentication used JWT token . Example: curl -X GET
{{SERVER_URL}}/api/v2/clients/current -H 'Authorization: bearer JWT_TOKEN'
You can get JWT_TOKEN from data endpoint /api/v2/clients/token. Example: curl
--location --request POST '{{SERVER_URL}}/api/v2/clients/token' --header
'Content-Type: application/json' --data-raw '{ "username": "USERNAME",
"password": "PASSWORD" }'.
Default token TTL 86400 seconds (24 hours).
USERNAME - email or phone client.
PASSWORD - password or sms code.
CONTENT NEGOTIATION
API support supports application/json and application/ld+json content type from
request header Accept. Default: application/ld+json
PAGINATION
Collection data type support page and itemsPerPage query parameters. Also you
can use hydra:next and hydra:previous fields in application/ld+json content type
ORDER WORKFLOW STATUS
COMPANY JWT TOKEN
RETRIEVES COMPANY TOKEN
Authorization header token, to get the apiKey parameter please contact
support@ticketsbox.com
REQUEST BODY SCHEMA: APPLICATION/JSON
apiKey
string
RESPONSES
200
Retrieves the token.
post /api/v2/token
https://api.test.ticketcrm.net/api/v2/token
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "apiKey": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1NzM1NTQ4MjIsImV4cCI6MTU3MzY0MTIyMiwicm9sZXMiOlsiUk9MRV9DT01QQU5ZX0FQSSJdLCJuYW1lIjoiVGlja2V0c0JveCJ9.RbBlxK0vAmJBiWUEVdMMFwxwDN7t5Snz0BpfZSIaEqECIdhvRK_XSTtA2A_sk6xID0NrJYmP_uurxVjrwyl_bWi6uMoNZ_fuiIIFN8rr6ZMbMtTr5RuXltl-n6bmGRG9-F6XzON4kYdZAtW8jAZWSE04xWiHx6jayo5feQG5UJ1fm7nTPO80luPd47279H4_yjPOl2PodHKkp9TP8OIUwiaqgr_Fc4kzptgTNJm6kzfE0d1Zdf0m1hXDxksw7K0rMds3-Vd2JOxQAwXa8BB3FCKAQyckvvnM9iDrIOOxk3pgHOeeJpY6Nyj6y9ZLPDo2xYnsaQEYhQKhZSwYDGrToRDUvB6sLzwgyxu2NSTfzvCoKE9VLcueABMQnFpHz3iP0DxL4xOAN7-0zwcmvAZ1VCp0KVf9_Bl46a9GvwYaR0RFByK4Vzs6torsEjpqr2KhHmw-BNigXK_cAVf7Z2R0JOUyAuxD_wTnx4R6d2RD9FLe_HsyQuGhhL6oXAF7i_7rucvIX6HxRw5oy28ZX5rhj0DX6EFTtJ81Mut_3xJilO5_W3EO_fu97RMtEWnJMFjCM867uWomQi04gp1XQ8Suls7SpvOYVnhJRvLWP9pilW6x8T9pnqa1tKv96n1SYg6oo7wdVYJoPIFfmJrvYm-v8qGn03BLiskzYAwqk5J5w8Y"
}
EVENTPOINT
RETRIEVES THE COLLECTION OF EVENTPOINT RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
dateStarted[before]
any
Date filter: Example ?dateStarted[before]=2020-10-29T00:00:00+02:00
dateStarted[after]
any
Date filter: Example ?dateStarted[after]=2020-10-29T00:00:00+02:00
dateStarted[strictly_before]
any
Date filter: Example ?dateStarted[strictly_before]=2020-10-29T00:00:00+02:00
dateStarted[strictly_after]
any
Date filter: Example ?dateStarted[strictly_after]=2020-10-29T00:00:00+02:00
venueHall.id
any
Venue hall filter: Example ?venueHall.id=555
venueHall.id[]
any
Venue hall filter: Example ?venueHall.id[]=555&venueHall.id[]=444
genres.id
any
Genres filter: Example ?genres.id=555
genres.id[]
any
Genres filter: Example ?genres.id[]=555&genres.id[]=444
eventId
any
Event filter: Example ?eventId=555
eventId[]
any
Genres filter: Example ?eventId[]=555&eventId[]=444
categories.id
any
Categories filter: Example ?categories.id=555
categories.id[]
any
Categories filter: Example ?categories.id[]=555&categories.id[]=444
maxAgeLimit[between]
any
Maximum age limit filter: Example ?maxAgeLimit[between]=5..10
maxAgeLimit[gt]
any
Maximum age limit filter: Example ?maxAgeLimit[gt]=5
maxAgeLimit[gte]
any
Maximum age limit filter: Example ?maxAgeLimit[gte]=5
minAgeLimit[between]
any
Minimum age limit filter: Example ?maxAgeLimit[between]=5..10
minAgeLimit[gt]
any
Minimum age limit filter: Example ?minAgeLimit[gt]=5
minAgeLimit[gte]
any
Minimum age limit filter: Example ?minAgeLimit[gte]=5
order[dateStarted]
string
Enum: "asc" "desc"
Sort by date started
order[id]
string
Enum: "asc" "desc"
Sort by id
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
EventPoint collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points
https://api.test.ticketcrm.net/api/v2/event-points
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "eventName": "string",
* "description": "string",
* "poster": "string",
* "maxAgeLimit": 0,
* "eventId": 0,
* "minAgeLimit": 0,
* "media":
[
* "string"
],
* "genres":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "categories":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "dateStarted": "2021-10-10T03:48:49Z",
* "dateEnd": "2021-10-10T03:48:49Z",
* "dateEndOfSale": "2021-10-10T03:48:49Z",
* "venueHall": "string",
* "venue": "string",
* "widgetHash": "string",
* "minPrice":
[
* "string"
],
* "maxPrice":
[
* "string"
],
* "attributes":
[
* "string"
]
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES THE COLLECTION OF ARCHIVED EVENTPOINT RESOURCES
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
EventPoint collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points-archived
https://api.test.ticketcrm.net/api/v2/event-points-archived
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "eventName": "string",
* "description": "string",
* "poster": "string",
* "maxAgeLimit": 0,
* "eventId": 0,
* "minAgeLimit": 0,
* "media":
[
* "string"
],
* "genres":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "categories":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "dateStarted": "2021-10-10T03:48:49Z",
* "dateEnd": "2021-10-10T03:48:49Z",
* "dateEndOfSale": "2021-10-10T03:48:49Z",
* "venueHall": "string",
* "venue": "string",
* "widgetHash": "string",
* "minPrice":
[
* "string"
],
* "maxPrice":
[
* "string"
],
* "attributes":
[
* "string"
]
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A EVENTPOINT RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
EventPoint resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{id}
https://api.test.ticketcrm.net/api/v2/event-points/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "eventName": "string",
* "description": "string",
* "poster": "string",
* "maxAgeLimit": 0,
* "eventId": 0,
* "minAgeLimit": 0,
* "media":
[
* "string"
],
* "genres":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "categories":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "dateStarted": "2021-10-10T03:48:49Z",
* "dateEnd": "2021-10-10T03:48:49Z",
* "dateEndOfSale": "2021-10-10T03:48:49Z",
* "venueHall": "string",
* "venue": "string",
* "widgetHash": "string",
* "minPrice":
[
* "string"
],
* "maxPrice":
[
* "string"
],
* "attributes":
[
* "string"
]
}
RETRIEVES THE COLLECTION OF EVENTPOINT RESOURCES BY SEASONTICKETORDER
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer CLIENT_JWT_TOKEN
RESPONSES
200
EventPoint collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/season-ticket-orders/{id}/event-points
https://api.test.ticketcrm.net/api/v2/season-ticket-orders/{id}/event-points
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "id": "string",
* "eventName": "string",
* "description": "string",
* "poster": "string",
* "maxAgeLimit": 0,
* "eventId": 0,
* "minAgeLimit": 0,
* "media":
[
* "string"
],
* "genres":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "categories":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "dateStarted": "2021-10-10T03:48:49Z",
* "dateEnd": "2021-10-10T03:48:49Z"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
CITY
RETRIEVES THE COLLECTION OF CITY RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
City collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/cities
https://api.test.ticketcrm.net/api/v2/cities
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string",
* "country": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A CITY RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
City resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/cities/{id}
https://api.test.ticketcrm.net/api/v2/cities/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string",
* "country": "string"
}
COUNTRY
RETRIEVES THE COLLECTION OF COUNTRY RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Country collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/countries
https://api.test.ticketcrm.net/api/v2/countries
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "code": "UA"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A COUNTRY RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Country resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/countries/{id}
https://api.test.ticketcrm.net/api/v2/countries/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "code": "UA"
}
ORDER
RETRIEVES THE COLLECTION OF ORDER RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
status
string
Collection filter by status
status[]
array[string]
Collection filter by statuses
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Order collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/orders
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/orders
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
CREATES A ORDER RESOURCE.
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The new Order resource
eventPoint
string <iri-reference> Nullable
Numeric event point id or iri from @id
places
Array of strings (ArrayOfNumeric)
promocode
string Nullable
reservedMinutes
int Nullable
Reserved order by minutes.
RESPONSES
201
Order resource created
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
post /api/v2/orders
https://api.test.ticketcrm.net/api/v2/orders
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "eventPoint": "234",
* "places":
[
* "456",
* "765"
],
* "promocode": "string",
* "reservedMinutes": 15
}
RESPONSE SAMPLES
* 201
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
RETRIEVES A ORDER RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Order resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/orders/{id}
https://api.test.ticketcrm.net/api/v2/orders/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
REPLACES THE ORDER RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
promocode
string Nullable
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}
https://api.test.ticketcrm.net/api/v2/orders/{id}
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "promocode": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
ADD TICKET TO ORDER BY PLACE
Available only for order in status reserved_to_time
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
places
Array of strings (ArrayOfNumeric)
promocode
string Nullable
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}/add-place
https://api.test.ticketcrm.net/api/v2/orders/{id}/add-place
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "places":
[
* "456",
* "765"
],
* "promocode": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
UPDATE RESERVED TO TIME ORDER
Available only for order in status reserved_to_time
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
reservedMinutes
int Nullable
Reserved order by minutes.
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}/reserve
https://api.test.ticketcrm.net/api/v2/orders/{id}/reserve
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "reservedMinutes": 15
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
UPDATE ORDER STATUS
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
toStatus
string (OrderStatus)
Enum: "reserved_to_time" "paid" "refund"
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}/status
https://api.test.ticketcrm.net/api/v2/orders/{id}/status
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "toStatus": "refund"
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
REMOVE TICKET FROM ORDER
Available only for order in status reserved_to_time
PATH PARAMETERS
id
required
string
ticketId
required
string
Ticket id field from order resource
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}/tickets/{ticketId}/remove
https://api.test.ticketcrm.net/api/v2/orders/{id}/tickets/{ticketId}/remove
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{ }
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
UPDATE TICKET STATUS
refund status available only for order in status paid
PATH PARAMETERS
id
required
string
ticketId
required
string
Ticket id field from order resource
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Order resource
toStatus
string (OrderStatus)
Enum: "reserved_to_time" "paid" "refund"
RESPONSES
200
Order resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/orders/{id}/tickets/{ticketId}/status
https://api.test.ticketcrm.net/api/v2/orders/{id}/tickets/{ticketId}/status
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "toStatus": "refund"
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "reservedToDate": "2021-10-10T03:48:49Z",
* "eventPoint": "234",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "totalDiscount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
RETRIEVES A WIDGET ORDER RESOURCE
Retrieves a order resource created from widget
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Order resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/widget-orders/{hash}
https://api.test.ticketcrm.net/api/v2/widget-orders/{hash}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "status": "refund",
* "totalPrice":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "tickets":
[
*
{
* "ticketId": "345",
* "placeId": "456",
* "barcode": null,
* "sectorName": "Sector 1",
* "rowName": "Row 1",
* "placeName": "Place 1",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
]
}
PLACE
RETRIEVES THE COLLECTION OF ALL PLACE RESOURCES BY EVENTPOINT.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Place collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/places
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/places
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeName": "string",
* "rowName": "string",
* "type": 0,
* "sectorName": "string",
* "sector": "string",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "availableCount": 0
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A PLACE RESOURCE BY EVENTPOINT.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Place resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/places/{id}
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/places/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeName": "string",
* "rowName": "string",
* "type": 0,
* "sectorName": "string",
* "sector": "string",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "availableCount": 0
}
RETRIEVES THE COLLECTION OF PLACE RESOURCES BY SECTOR.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Place collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/sectors/{sectorId}/places
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/sectors/{sectorId}/places
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeName": "string",
* "rowName": "string",
* "type": 0,
* "sectorName": "string",
* "sector": "string",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "availableCount": 0
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A PLACE RESOURCE BY SECTOR.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Place resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/sectors/{sectorId}/places/{id}
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/sectors/{sectorId}/places/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeName": "string",
* "rowName": "string",
* "type": 0,
* "sectorName": "string",
* "sector": "string",
* "price":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "availableCount": 0
}
SECTOR
RETRIEVES THE COLLECTION OF SECTOR RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Sector collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/sectors
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/sectors
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A SECTOR RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Sector resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/sectors/{id}
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/sectors/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
VENUE
RETRIEVES THE COLLECTION OF VENUE RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
city.id
any
City filter: Example ?city.id=555
city.id[]
any
City filter: Example ?city.id[]=555&city.id[]=444
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Venue collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/venues
https://api.test.ticketcrm.net/api/v2/venues
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string",
* "address": "string",
* "city": "string",
* "halls":
[
*
{
* "id": "345",
* "hallName": "hallName1"
}
]
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A VENUE RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Venue resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/venues/{id}
https://api.test.ticketcrm.net/api/v2/venues/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string",
* "address": "string",
* "city": "string",
* "halls":
[
*
{
* "id": "345",
* "hallName": "hallName1"
}
]
}
VENUEHALL
RETRIEVES THE COLLECTION OF VENUEHALL RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
city.id
any
City filter: Example ?city.id=555
city.id[]
any
City filter: Example ?city.id[]=555&city.id[]=444
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
VenueHall collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/venue-halls
https://api.test.ticketcrm.net/api/v2/venue-halls
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "hallName": "string",
* "venueName": "string",
* "address": "string",
* "city": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A VENUEHALL RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
VenueHall resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/venue-halls/{id}
https://api.test.ticketcrm.net/api/v2/venue-halls/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "hallName": "string",
* "venueName": "string",
* "address": "string",
* "city": "string"
}
GENRE
RETRIEVES THE COLLECTION OF GENRE RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Genre collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/genres
https://api.test.ticketcrm.net/api/v2/genres
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A GENRE RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Genre resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/genres/{id}
https://api.test.ticketcrm.net/api/v2/genres/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
CATEGORY
RETRIEVES THE COLLECTION OF CATEGORY RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Category collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/categories
https://api.test.ticketcrm.net/api/v2/categories
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A CATEGORY RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Category resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/categories/{id}
https://api.test.ticketcrm.net/api/v2/categories/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
BARCODE
RETRIEVES THE COLLECTION OF BARCODE RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Barcode collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/barcodes
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/barcodes
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeId": "string",
* "placeName": "string",
* "sectorId": "string",
* "sectorName": "string",
* "barcode": "string"
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES A BARCODE RESOURCE.
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
Barcode resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/event-points/{eventPointId}/barcodes/{id}
https://api.test.ticketcrm.net/api/v2/event-points/{eventPointId}/barcodes/{id}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "placeId": "string",
* "placeName": "string",
* "sectorId": "string",
* "sectorName": "string",
* "barcode": "string"
}
CLIENT
GET CURRENT CLIENT
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer CLIENT_JWT_TOKEN
RESPONSES
200
Client resource response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/clients/current
https://api.test.ticketcrm.net/api/v2/clients/current
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "phone": "string",
* "checkedPhone": true,
* "firstName": "string",
* "lastName": "string"
}
PUT CURRENT CLIENT
PATH PARAMETERS
id
required
string
HEADER PARAMETERS
Authorization
required
string
Example: Bearer CLIENT_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The updated Client resource
phone
string Nullable
firstName
string Nullable
lastName
string Nullable
password
string Nullable
RESPONSES
200
Client resource updated
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
put /api/v2/clients/current
https://api.test.ticketcrm.net/api/v2/clients/current
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "phone": "string",
* "firstName": "string",
* "lastName": "string",
* "password": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "phone": "string",
* "checkedPhone": true,
* "firstName": "string",
* "lastName": "string"
}
CLIENT REGISTRATION
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The new Client resource
phone
string Nullable
RESPONSES
201
Client resource created
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
post /api/v2/clients/registration
https://api.test.ticketcrm.net/api/v2/clients/registration
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "phone": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "phone": "string",
* "checkedPhone": true,
* "firstName": "string",
* "lastName": "string"
}
CLIENT JWT TOKEN
RETRIEVES CLIENT TOKEN
Authorization header token
REQUEST BODY SCHEMA: APPLICATION/JSON
username
string
password
string
RESPONSES
200
Retrieves the token.
post /api/v2/clients/token
https://api.test.ticketcrm.net/api/v2/clients/token
REQUEST SAMPLES
* Payload
Content type
application/json
Copy
Expand all Collapse all
{
* "username": "string",
* "password": "string"
}
RESPONSE SAMPLES
* 200
Content type
application/json
Copy
Expand all Collapse all
{
* "token":
"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJpYXQiOjE1NzM1NTQ4MjIsImV4cCI6MTU3MzY0MTIyMiwicm9sZXMiOlsiUk9MRV9DT01QQU5ZX0FQSSJdLCJuYW1lIjoiVGlja2V0c0JveCJ9.RbBlxK0vAmJBiWUEVdMMFwxwDN7t5Snz0BpfZSIaEqECIdhvRK_XSTtA2A_sk6xID0NrJYmP_uurxVjrwyl_bWi6uMoNZ_fuiIIFN8rr6ZMbMtTr5RuXltl-n6bmGRG9-F6XzON4kYdZAtW8jAZWSE04xWiHx6jayo5feQG5UJ1fm7nTPO80luPd47279H4_yjPOl2PodHKkp9TP8OIUwiaqgr_Fc4kzptgTNJm6kzfE0d1Zdf0m1hXDxksw7K0rMds3-Vd2JOxQAwXa8BB3FCKAQyckvvnM9iDrIOOxk3pgHOeeJpY6Nyj6y9ZLPDo2xYnsaQEYhQKhZSwYDGrToRDUvB6sLzwgyxu2NSTfzvCoKE9VLcueABMQnFpHz3iP0DxL4xOAN7-0zwcmvAZ1VCp0KVf9_Bl46a9GvwYaR0RFByK4Vzs6torsEjpqr2KhHmw-BNigXK_cAVf7Z2R0JOUyAuxD_wTnx4R6d2RD9FLe_HsyQuGhhL6oXAF7i_7rucvIX6HxRw5oy28ZX5rhj0DX6EFTtJ81Mut_3xJilO5_W3EO_fu97RMtEWnJMFjCM867uWomQi04gp1XQ8Suls7SpvOYVnhJRvLWP9pilW6x8T9pnqa1tKv96n1SYg6oo7wdVYJoPIFfmJrvYm-v8qGn03BLiskzYAwqk5J5w8Y"
}
AUTHCODE
SEND CLIENT TOKEN
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
Content-Type
required
string
application/json
REQUEST BODY SCHEMA:
APPLICATION/LD+JSON
The new AuthCode resource
phone
string
RESPONSES
201
AuthCode resource created
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
post /api/v2/auth-code
https://api.test.ticketcrm.net/api/v2/auth-code
REQUEST SAMPLES
* Payload
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "phone": "string"
}
RESPONSE SAMPLES
* 201
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "status": "OK",
* "blockedTime": 0
}
SEASONTICKETORDER
RETRIEVES THE COLLECTION OF SEASONTICKETORDER RESOURCES.
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer CLIENT_JWT_TOKEN
RESPONSES
200
SeasonTicketOrder collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/season-ticket-orders
https://api.test.ticketcrm.net/api/v2/season-ticket-orders
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "id": "string",
* "status": "order_completed",
* "number": "string",
* "deliveryEmail": "string",
* "totalAmount":
{
* "amount": "90.0000",
* "currency": "UAH"
}
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
RETRIEVES THE COLLECTION OF SEASONTICKETORDER RESOURCES. DEPRECATED
QUERY PARAMETERS
page
integer
Default: 1
The collection page number
itemsPerPage
integer >= 0
Default: 30
The number of items per page
HEADER PARAMETERS
Authorization
required
string
Example: Bearer COMPANY_JWT_TOKEN
RESPONSES
200
SeasonTicketOrder collection response
400
Bad request.
401
Bad credentials.
404
The specified resource was not found
get /api/v2/season-ticket-orders-templates
https://api.test.ticketcrm.net/api/v2/season-ticket-orders-templates
RESPONSE SAMPLES
* 200
Content type
application/ld+json
Copy
Expand all Collapse all
{
* "hydra:member":
[
*
{
* "id": "string",
* "status": "order_completed",
* "number": "string",
* "deliveryEmail": "string",
* "totalAmount":
{
* "amount": "90.0000",
* "currency": "UAH"
},
* "seasonTickets":
[
*
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "seasonTicketTemplate":
{
* "@context": "string",
* "@id": "string",
* "@type": "string",
* "id": "string",
* "name": "string"
}
}
]
}
],
* "hydra:totalItems": 0,
* "hydra:view":
{
* "@id": "string",
* "@type": "string",
* "hydra:first": "string",
* "hydra:last": "string",
* "hydra:next": "string"
},
* "hydra:search":
{
* "@type": "string",
* "hydra:template": "string",
* "hydra:variableRepresentation": "string",
* "hydra:mapping":
[
*
{
* "@type": "string",
* "variable": "string",
* "property": "string",
* "required": true
}
]
}
}
Available formats: jsonld json html
Other API docs: ReDoc