Prepared tickets

Prepared tickets are pre-filled tickets for customers to pick up in the Customer Portal. Prepared tickets contain at least a VIN, a reference to a vehicle model and should have at least one product-line to be usable for a customer.

Prepared ticket

A prepared ticket is a ticket with pre-filled data that can be picked up by a customer in the Customer Portal. Prepared tickets appear in the Customer Portal when a VIN, vehicle model and an associated product-line is present.

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 or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

{"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": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Retrieve prepared tickets

Retrieve a list of prepared tickets.

SecurityOAuth2

Request

query Parameters

created_after	string <date-time> Filter prepared tickets that have been created after provided date-time.
created_before	string <date-time> Filter prepared tickets that have been created before provided date-time.
customer_id	string <uuid> Filter prepared tickets by customer identifier.
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.
preparer_external_reference	string Filter prepared tickets by preparer's given external reference. Example: preparer_external_reference=ERP_DYNAMICS_2442
product_id	string <uuid> Filter prepared tickets by product identifier. Return only prepared tickets with an associated product-line for the referenced product.
ticket_number	number <int64> Filter tickets by ticket number. Example: ticket_number=7179072
vin	string = 17 characters Filter prepared tickets by Vehicle Identification Number (VIN). Providing no value will return tickets without a VIN. Example: vin=JH4KA7630PC007649

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 (Prepared ticket) >= 0 items

List of prepared 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 or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

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/prepared-tickets

Response samples

200
default

application/json

{"query": {"limit": 25,
"offset": 0
},
"result": [{"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": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}
],
"total": 3255
}

Create a prepared ticket

Create a new prepared ticket.

SecurityOAuth2

Request

Request Body schema: application/json
required

The prepared ticket you wish to create.

customer_id required	string <uuid> Identifier of the customer for whom the ticket was created.
vehicle_model_id required	integer <int64> Identifier of the vehicle model on the ticket.
vin required	string or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference required	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

Responses

201

Created.

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 or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

default

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

post/v2/tickets/prepared-tickets

Request samples

Payload

application/json

{"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"vehicle_model_id": 0,
"vin": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Response samples

201
default

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": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Retrieve prepared ticket

Retrieve a single prepared ticket by its identifier.

SecurityOAuth2

Request

path Parameters

prepared-ticket-id

required

string <uuid>

Identifier of the prepared 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 or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

default

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

get/v2/tickets/prepared-tickets/{prepared-ticket-id}

Response samples

200
default

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": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Update a prepared ticket

Update a single prepared ticket by its identifier.

SecurityOAuth2

Request

path Parameters

prepared-ticket-id

required

string <uuid>

Identifier of the prepared ticket.

Request Body schema: application/json
required

The prepared ticket you wish to update.

vehicle_model_id required	integer <int64> Identifier of the vehicle model on the ticket.
vin required	string or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code required	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference required	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

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 or null = 17 characters Vehicle Identification Number (VIN) of the vehicle on the ticket.
voucher_code	string or null [ 4 .. 8 ] characters [A-Z0-9] Voucher code.
preparer_external_reference	string [ 0 .. 255 ] characters This custom external reference, provided by the ticket preparer, is used for the purpose of communicating with other applications.

default

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

put/v2/tickets/prepared-tickets/{prepared-ticket-id}

Request samples

Payload

application/json

{"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"vehicle_model_id": 0,
"vin": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Response samples

200
default

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": "string",
"voucher_code": "WQ4MM3",
"preparer_external_reference": "DYNAMICS_ERP_3454662"
}

Delete a prepared ticket

Delete a single prepared ticket by its identifier.

SecurityOAuth2

Request

path Parameters

prepared-ticket-id

required

string <uuid>

Identifier of the prepared ticket.

Responses

204

Successfully removed.

default

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

delete/v2/tickets/prepared-tickets/{prepared-ticket-id}

Response samples

default

application/problem+json

Returned when the request cannot be handled due to something that is perceived to be a client error.

{"detail": "The request violates one or more constraints. Please resolve all of them and try again.",
"status": 400,
"title": "Bad request",
"type": "/problems/violations",
"violations": [{"property_path": "gross_price.amount",
"in": "body",
"detail": "Value must be greater than 0"
},
{"property_path": "provider_id",
"in": "query",
"detail": "Provider with ID 3445 does not exist."
}
]
}

➔ Next to Pending tickets

Prepared tickets

Prepared ticket

Retrieve prepared tickets

query Parameters

Response Schema: application/json

Create a prepared ticket

Request Body schema: application/jsonrequired

Response Schema: application/json

Retrieve prepared ticket

path Parameters

Response Schema: application/json

Update a prepared ticket

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a prepared ticket

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required