Powered by Redocly

In progress tickets

Manage in progress tickets.

In progress ticket

An 'In Progress' ticket is a ticket that is joined by an operator and is marked as currently being worked on.

id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

service_started_at
string <date-time>

Date and time service started on this ticket.

operator_id
string <uuid>

Identifier of the assigned operator.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

outsourced
boolean

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

connection_id
string or null <uuid>

Identifier of the connection.

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "service_started_at": "2019-08-24T14:15:22Z",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "voucher_code": "WQ4MM3",
  • "outsourced": true,
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Retrieve 'In Progress' tickets [BETA]

Retrieve a list of 'In Progress' tickets.

BETA

SecurityOAuth2 and ApiKey
Request
query Parameters
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.

ticket_number
number <int64>

Filter tickets by ticket number.

Example: ticket_number=7179072
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.

property name*
additional property
any
Array of objects (In progress ticket) >= 0 items

List of 'In Progress' tickets.

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

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

service_started_at
string <date-time>

Date and time service started on this ticket.

operator_id
string <uuid>

Identifier of the assigned operator.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

outsourced
boolean

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

connection_id
string or null <uuid>

Identifier of the connection.

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/in-progress-tickets
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve an in progress ticket [BETA]

Retrieve a single 'In Progress' ticket by its identifier.

BETA

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

The identifier of the 'In Progress' ticket.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

service_started_at
string <date-time>

Date and time service started on this ticket.

operator_id
string <uuid>

Identifier of the assigned operator.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

outsourced
boolean

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

connection_id
string or null <uuid>

Identifier of the connection.

default

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

get/v2/tickets/in-progress-tickets/{in-progress-ticket-id}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "service_started_at": "2019-08-24T14:15:22Z",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "voucher_code": "WQ4MM3",
  • "outsourced": true,
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Update an in progress ticket [BETA]

Update a single 'In Progress' ticket by its identifier.

BETA

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

The identifier of the 'In Progress' ticket.

Request Body schema: application/json
required

The updated 'In Progress' ticket.

operator_id
required
string <uuid>

Identifier of the assigned operator.

Responses
200

Successful response.

Response Schema: application/json
id
string <uuid>

Ticket identifier.

created_at
string <date-time>

Date and time of creation.

customer_id
string <uuid>

Identifier of the customer for whom the ticket was created.

ticket_number
integer <int64>

Human-readable ticket identifier.

vehicle_model_id
integer <int64>

Identifier of the vehicle model on the ticket.

vin
string = 17 characters

Vehicle Identification Number (VIN) of the vehicle on the ticket.

service_started_at
string <date-time>

Date and time service started on this ticket.

operator_id
string <uuid>

Identifier of the assigned operator.

voucher_code
string or null [ 4 .. 8 ] characters [A-Z0-9]

Voucher code.

outsourced
boolean

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

connection_id
string or null <uuid>

Identifier of the connection.

default

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

put/v2/tickets/in-progress-tickets/{in-progress-ticket-id}
Request samples
application/json
{
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "voucher_code": "WQ4MM3"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "created_at": "2019-08-24T14:15:22Z",
  • "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
  • "ticket_number": 7440303,
  • "vehicle_model_id": 0,
  • "vin": "JH4KA7630PC007649",
  • "service_started_at": "2019-08-24T14:15:22Z",
  • "operator_id": "fa9de6bb-1df8-4ba6-9e6d-1172fbf7e166",
  • "voucher_code": "WQ4MM3",
  • "outsourced": true,
  • "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9"
}

Transition in progress ticket [BETA]

Transition a single 'In Progress' ticket by its identifier.

BETA

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

The identifier of the 'In Progress' ticket.

Request Body schema: application/json

The changes you wish to make.

required
Outsource (object) or Complete (object) or Cancel (object)

Transition this ticket to a different state.

One of:

Request another provider to execute specified products on your behalf.

type
required
string

The type of transition to apply on this ticket.

Value Description
outsource

Outsource this ticket.

allow_customer_chat_write_access
boolean

Whether an operator of the outsource provider is allowed to send chat messages to your customer. If this property is omitted the outsource link settings for the outsource provider will be used.

product_ids
required
Array of strings <uuid> non-empty

Identifiers of the product(s) to outsource. Only products of type "base" can be outsourced. See Outsource applications for a way to determine which products can be outsourced to providers that are available to you.

provider_id
required
string <uuid>

Identifier of the provider to outsource to.

share_customer_information
boolean

Whether contact information of your customer is shared with the outsource provider. If this property is omitted the outsource link settings for the outsource provider will be used.

Responses
303

Transitioned.

Response Headers
Location
string <uri-reference>

Path to resource the ticket has been transitioned to.

Example: "/v2/tickets/outsourced-tickets/f2c4cf2d-c633-466b-b161-c01ab5bf66f0"
400

Bad request.

default

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

patch/v2/tickets/in-progress-tickets/{in-progress-ticket-id}
Request samples
application/json
{
  • "transition": {
    }
}
Response samples
application/problem+json
{
  • "status": 400,
  • "type": "about:blank",
  • "title": "Some title for the error situation",
  • "detail": "Some description for the error situation"
}
➔ Next to Outsourced tickets