Powered by Redocly

Tickets

Tickets describe the requests to execute services on a vehicle for your customers.

Ticket

id
string <uuid>

Ticket identifier.

assigned_at
string or null <date-time>

Date and time the ticket was joined by the first operator.

cancel_reason_id
integer or null <int32>

Reference to a cancel reason. Only present for tickets in the cancelled state.

connection_id
string or null <uuid>

Identifier of the connection.

created_at
string <date-time>

Date and time of creation.

customer_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the customer. This will not be set for tickets in the 'prepared' state.

customer_connector_id
string or null <uuid>

Identifier of the connector that is used by the customer for whom the initial ticket was created.

customer_id
string or null <uuid>

Identifier of the customer for whom the ticket was created.

customer_reference
string [ 0 .. 255 ] characters

Reference added by the customer.

external_reference
string

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

finished_at
string or null <date-time>

Date and time the ticket was finished at. Only present for tickets in the cancelled or closed states.

operator_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the operator of the partnered provider that outsourced this ticket to you. This will be null when the ticket was created by a customer.

operator_id
string or null <uuid>

Identifier of the assigned operator. This value will be set when the ticket currently is or has been in state "in_progress".

operator_reference
string [ 0 .. 255 ] characters

Reference added by the operator.

outsourced
boolean

Reflects whether a ticket has been outsourced at least once to another provider.

source_provider_id
string <uuid>

The identifier of the provider that was the source of this ticket. This is the identifier of the provider that insourced this ticket, otherwise it will be your provider identifier.

state
string (Ticket-state)

This state provides information about the current activity of the ticket.

Enum Value Description
prepared

The ticket is prepared and can be used by a customer.

pending

The ticket is waiting to be worked on.

in_progress

The ticket is being worked by an operator.

outsourced

The ticket is outsourced to another provider.

closed

The ticket is successfully finished.

cancelled

The ticket is cancelled, see cancel_reason_id as to why.

ticket_number
integer <int64>

Human-readable ticket identifier.

updated_at
string <date-time>

Date and time the ticket was last updated.

vehicle_model_id
integer <int64>

Identifier of the vehicle model of the ticket.

vin
string or null = 17 characters

Vehicle Identification Number (VIN) of the vehicle of the ticket. Can be null for tickets in "prepared" state.

voucher_code
string or null

Code of the applied voucher.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assigned_at": "2019-08-24T14:15:22Z",
  • "cancel_reason_id": 0,
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_channel_id": "ea96c632-cea8-4e93-a2a9-b43cdfd2784c",
  • "customer_connector_id": "38442d12-3ddc-4ea7-815d-16388caccddf",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "customer_reference": "A-123-B",
  • "external_reference": "string",
  • "externally_processed": true,
  • "finished_at": "2019-08-24T14:15:22Z",
  • "operator_channel_id": "ca45affe-f503-4778-ab9e-3dd26cdd2d66",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "operator_reference": "example reference",
  • "outsourced": true,
  • "source_provider_id": "89679b1d-5eea-4ceb-8c38-aea88452dbc0",
  • "state": "cancelled",
  • "ticket_number": 7440303,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "voucher_code": "WQ4MM3"
}

Retrieve tickets

Retrieve a list of tickets.

SecurityOAuth2 and ApiKey
Request
query Parameters
cancel_reason_id
Array of numbers <int64> non-empty unique

Filter tickets by one or more cancel reason references.

Example: cancel_reason_id=1,2
created_after
string <date-time>

Filter tickets that have been created after provided date-time.

Example: created_after=2023-03-15T08:34:28Z
created_before
string <date-time>

Filter tickets that have been created before provided date-time.

Example: created_before=2023-03-15T08:34:28Z
customer_connector_id
string <uuid>

Filter tickets by customer_connector_id.

customer_id
string <uuid>

Filter tickets by customer_id.

external_reference
string

Filter tickets by external reference.

externally_processed
boolean

Only return tickets that are or are not processed by an external system.

finished_after
string <date-time>

Filter tickets that have been finished after provided date-time.

Example: finished_after=2023-03-15T08:34:28Z
finished_before
string <date-time>

Filter tickets that have been finished before provided date-time.

Example: finished_before=2023-03-15T08:34:28Z
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

operator_id
string <uuid>

Filter tickets by operator.

object
Default: {"created_at":"asc"}

Sort tickets.

Example: sort_by[created_at]=asc
source_provider_id
string <uuid>

Filter tickets by source provider identifier.

state
Array of strings (Ticket-state) non-empty unique

Filter tickets by one or more ticket states.

Items Enum Value Description
prepared

The ticket is prepared and can be used by a customer.

pending

The ticket is waiting to be worked on.

in_progress

The ticket is being worked by an operator.

outsourced

The ticket is outsourced to another provider.

closed

The ticket is successfully finished.

cancelled

The ticket is cancelled, see cancel_reason_id as to why.

ticket_number
number <int64>

Filter tickets by ticket number.

Example: ticket_number=7179072
updated_after
string <date-time>

Filter tickets that have been updated after provided date-time.

Example: updated_after=2023-03-15T08:34:28Z
updated_before
string <date-time>

Filter tickets that have been updated before provided date-time.

Example: updated_before=2023-03-15T08:34:28Z
vehicle_model_id
integer

Filter tickets by vehicle_model_id.

vin
string = 17 characters

Filter tickets by Vehicle Identification Number (VIN). Providing no value will return tickets without a VIN.

Example: vin=JH4KA7630PC007649
voucher_code
string non-empty

Filter tickets by voucher code.

Example: voucher_code=WQ4MM3
Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

object
Default: {"created_at":"asc"}

The applied value of the sort_by query parameter on the resources in result.

property name*
additional property
any
Array of objects (Ticket) >= 0 items

List of tickets.

Array (>= 0 items)
id
string <uuid>

Ticket identifier.

assigned_at
string or null <date-time>

Date and time the ticket was joined by the first operator.

cancel_reason_id
integer or null <int32>

Reference to a cancel reason. Only present for tickets in the cancelled state.

connection_id
string or null <uuid>

Identifier of the connection.

created_at
string <date-time>

Date and time of creation.

customer_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the customer. This will not be set for tickets in the 'prepared' state.

customer_connector_id
string or null <uuid>

Identifier of the connector that is used by the customer for whom the initial ticket was created.

customer_id
string or null <uuid>

Identifier of the customer for whom the ticket was created.

customer_reference
string [ 0 .. 255 ] characters

Reference added by the customer.

external_reference
string

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

finished_at
string or null <date-time>

Date and time the ticket was finished at. Only present for tickets in the cancelled or closed states.

operator_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the operator of the partnered provider that outsourced this ticket to you. This will be null when the ticket was created by a customer.

operator_id
string or null <uuid>

Identifier of the assigned operator. This value will be set when the ticket currently is or has been in state "in_progress".

operator_reference
string [ 0 .. 255 ] characters

Reference added by the operator.

outsourced
boolean

Reflects whether a ticket has been outsourced at least once to another provider.

source_provider_id
string <uuid>

The identifier of the provider that was the source of this ticket. This is the identifier of the provider that insourced this ticket, otherwise it will be your provider identifier.

state
string (Ticket-state)

This state provides information about the current activity of the ticket.

Enum Value Description
prepared

The ticket is prepared and can be used by a customer.

pending

The ticket is waiting to be worked on.

in_progress

The ticket is being worked by an operator.

outsourced

The ticket is outsourced to another provider.

closed

The ticket is successfully finished.

cancelled

The ticket is cancelled, see cancel_reason_id as to why.

ticket_number
integer <int64>

Human-readable ticket identifier.

updated_at
string <date-time>

Date and time the ticket was last updated.

vehicle_model_id
integer <int64>

Identifier of the vehicle model of the ticket.

vin
string or null = 17 characters

Vehicle Identification Number (VIN) of the vehicle of the ticket. Can be null for tickets in "prepared" state.

voucher_code
string or null

Code of the applied voucher.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/tickets
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve ticket

Retrieve a single ticket by its identifier.

SecurityOAuth2 and ApiKey
Request
path Parameters
ticket-id
required
string <uuid>

The identifier of the ticket you want to operate on.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Ticket identifier.

assigned_at
string or null <date-time>

Date and time the ticket was joined by the first operator.

cancel_reason_id
integer or null <int32>

Reference to a cancel reason. Only present for tickets in the cancelled state.

connection_id
string or null <uuid>

Identifier of the connection.

created_at
string <date-time>

Date and time of creation.

customer_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the customer. This will not be set for tickets in the 'prepared' state.

customer_connector_id
string or null <uuid>

Identifier of the connector that is used by the customer for whom the initial ticket was created.

customer_id
string or null <uuid>

Identifier of the customer for whom the ticket was created.

customer_reference
string [ 0 .. 255 ] characters

Reference added by the customer.

external_reference
string

Reference of this ticket to something in an external system. This property value is never changed from within the Jifeline system.

externally_processed
boolean

Whether this ticket has been processed by an external system. This field is purely present to allow an external system to easily register if it has already "processed" it. This property value is never changed from within the Jifeline system.

finished_at
string or null <date-time>

Date and time the ticket was finished at. Only present for tickets in the cancelled or closed states.

operator_channel_id
string or null <uuid>

Identifier for the ticket messenger channel with the operator of the partnered provider that outsourced this ticket to you. This will be null when the ticket was created by a customer.

operator_id
string or null <uuid>

Identifier of the assigned operator. This value will be set when the ticket currently is or has been in state "in_progress".

operator_reference
string [ 0 .. 255 ] characters

Reference added by the operator.

outsourced
boolean

Reflects whether a ticket has been outsourced at least once to another provider.

source_provider_id
string <uuid>

The identifier of the provider that was the source of this ticket. This is the identifier of the provider that insourced this ticket, otherwise it will be your provider identifier.

state
string (Ticket-state)

This state provides information about the current activity of the ticket.

Enum Value Description
prepared

The ticket is prepared and can be used by a customer.

pending

The ticket is waiting to be worked on.

in_progress

The ticket is being worked by an operator.

outsourced

The ticket is outsourced to another provider.

closed

The ticket is successfully finished.

cancelled

The ticket is cancelled, see cancel_reason_id as to why.

ticket_number
integer <int64>

Human-readable ticket identifier.

updated_at
string <date-time>

Date and time the ticket was last updated.

vehicle_model_id
integer <int64>

Identifier of the vehicle model of the ticket.

vin
string or null = 17 characters

Vehicle Identification Number (VIN) of the vehicle of the ticket. Can be null for tickets in "prepared" state.

voucher_code
string or null

Code of the applied voucher.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/tickets/{ticket-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "assigned_at": "2019-08-24T14:15:22Z",
  • "cancel_reason_id": 0,
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_channel_id": "ea96c632-cea8-4e93-a2a9-b43cdfd2784c",
  • "customer_connector_id": "38442d12-3ddc-4ea7-815d-16388caccddf",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "customer_reference": "A-123-B",
  • "external_reference": "string",
  • "externally_processed": true,
  • "finished_at": "2019-08-24T14:15:22Z",
  • "operator_channel_id": "ca45affe-f503-4778-ab9e-3dd26cdd2d66",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "operator_reference": "example reference",
  • "outsourced": true,
  • "source_provider_id": "89679b1d-5eea-4ceb-8c38-aea88452dbc0",
  • "state": "cancelled",
  • "ticket_number": 7440303,
  • "updated_at": "2019-08-24T14:15:22Z",
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "voucher_code": "WQ4MM3"
}
➔ Next to Product lines