transactionTypestring
Identifier of the type of the transaction
Allowed values:EVRINTERSTATEDMVDESKNTX
Default:NTX
<= 1048576 characters
Example:NTX
Commit the transaction
Commit the transaction
put
https://api-test.vitu.com/national-public-api/v2/transaction/{transactionId}/commit
Query Parameters
Path Parameters
transactionIdstringrequired
Either int transactionId or uuid refNumber
Match pattern:^[\s\S]*$
<= 1048576 characters
Headers
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Body
application/json
Body
application/json
FinalizeDTO
* Additional properties are NOT allowed.
shippingobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
plateDestinationobject
* Additional properties are NOT allowed.
Show Child Parameters
submitAsIsboolean
Example:true
signerNamestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Sample Name
signerPhonestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:555-0100
Response
application/json
Response
application/json
OK
object
Accepted — processing asynchronously
Callbacks
Callbacks
post
{$request.query.callbackUrl}
Callback Response
application/json
Callback Response
application/json
Target server returns this code if it accepts the callback
object
Accepted — processing asynchronously
put/transaction/{transactionId}/commit
Authentication
Path Parameters
Query Parameters
Headers
Body
{
"shipping": {
"shippingType": "Standard"
}
}
application/json
callback sample
Callback Body
Callback Response
application/json
Tickets
Tickets operations
Get Ticket Messages
Fetches a list of all messages and comments associated with a specific transactionId
get
https://api-test.vitu.com/national-public-api/v2/tickets/messages
Query Parameters
transactionIdstring(uuid)required
transactionId parameter
Match pattern:^[\s\S]*$
<= 64 characters
Headers
x-location-idstring(uuid)required
VITU Location ID
Match pattern:^[\s\S]*$
<= 64 characters
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Response
application/json
Response
application/json
A list of messages associated with the transaction.
<= 100000 items
idinteger(int64)
ID of the message
>= -9007199254740991<= 9007199254740991
Example:1
messagestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Request processed successfully
createdstring(date-time)
<= 1048576 characters
Example:2024-03-15T09:30:00Z
get/tickets/messages
Authentication
Query Parameters
Headers
application/json
Add a message to a ticket
Creates a new message (comment) within a specific Jira ticket. This can include links to previously uploaded document IDs to be added as attachments.
post
https://api-test.vitu.com/national-public-api/v2/tickets/messages
Headers
x-location-idstring(uuid)required
VITU Location ID
Match pattern:^[\s\S]*$
<= 64 characters
x-on-behalf-of-userinteger(int64)
>= -9007199254740991<= 9007199254740991
Body
application/json
Body
application/json
TicketMessageRequestDTO
transactionIdinteger(int64)required
>= -9007199254740991<= 9007199254740991
Example:1
messagestring
Match pattern:^[\s\S]*$
<= 1048576 characters
Example:Request processed successfully
documentIdsarray[integer](int64)
>= -9007199254740991<= 9007199254740991
Example:1
Response
application/json
Response
application/json
Message created successfully. Returns the unique Id of the new message.
integer(int64)
>= -9007199254740991<= 9007199254740991
post/tickets/messages
Authentication
Headers
Body
{
"transactionId": 1
}
application/json
Documents
Documents operations