Partner API (v1.0)

Orders List Endpoints (1.0.0)

Endpoint:https://api.vignette.id

Endpoints for interacting with orders.

Get Orders

GET

https://api.vignette.id

/public/orders

This endpoint allows you to obtain a list of all partner orders with all the necessary information about the order.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Get Orders › query Parameters

statusstring
Returns filtered orders by status.

• Statuses

Each vignette can have one of the statuses:

PENDING, WILL BE ACTIVE, ACTIVE, EXPIRED, REFUNDED, DELETED

More about status list.
bug_reportboolean
Use with all endpoints to inform us for bugs in API
Default: false

Get Orders › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Orders › Responses

Successful operation

idstring
emailstring
created_datenumber

Create order

POST

https://api.vignette.id

/public/orders

New paid order on partner side initiate request for processing in Vignette ID system.

⚠️ Once an order moves to the pending status, it can no longer be modified.

Create order › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Content-Typestring · enum · required
Specifies the format of the request body. Must be 'application/json' for requests with a JSON body.
Enum values:
application/json
Default: application/json

Create order › Request Body

terms_and_privacy_acceptedboolean · required
Must be true to indicate that terms and privacy are accepted. Partner need to store this information in the user order.
Example: true
order_has_been_paidboolean · required
• true - this means that the partner accepted and processed the payment on his side.

• false - to pay for an order, the API generates a link and returns it to the response in payment_link, which the partner must display to the user. The payment is processed on our side.
Example: true
carsobject[] · required
Array of Vehicles with vehicle plate and registration country.
productsobject[] · required
Array of vignettes with custom id, name, period, and start date.

userobject
User data.
subaccountstring
Partner can provide different sub-account names which mean different user UI or apps
interchange_feeobject

Create order › Responses

Successful operation

error
Error can be null, a simple string code, or an object with details.
resultobject

Get Order

GET

https://api.vignette.id

/public/orders/{id}

• id - order id in Vignette ID system

• custom_id - order id in Partner system

• provider_id - unique vignette id in national (government) providers systems

• cars -> provider_id - unique vignette identificator in national provider system

• cars -> pdf - confirmation file from national provider system.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Get Order › path Parameters

idstring · required
id of order in Vignette ID system or custom_id from Partner system

Get Order › query Parameters

bug_reportboolean
Use with all endpoints to inform us for bugs in API
Default: false

Get Order › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Order › Responses

Specific order description test

error
Error can be null, a simple string code, or an object with details.
resultobject

Get Order Status

GET

https://api.vignette.id

/public/orders/{id}/status

Returns only the order status. Applicable in cases where you need to check only the status without other information.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Get Order Status › path Parameters

idstring · required
id of order in Vignette ID system or custom_id from Partner system

Get Order Status › query Parameters

bug_reportboolean
Use with all endpoints to inform us for bugs in API
Default: false

Get Order Status › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Get Order Status › Responses

Specific order description test

error
Error can be null, a simple string code, or an object with details.
resultobject

Cancel Pending Order

POST

https://api.vignette.id

/public/orders/{id}/cancel-pending

The ability to cancel an order that has a PENDING status if it is not processed within the specified time period

• PENDING - only.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Cancel Pending Order › path Parameters

idstring · required
id of order in Vignette ID system or custom_id from Partner system

Cancel Pending Order › query Parameters

bug_reportboolean
Use with all endpoints to inform us for bugs in API
Default: false

Cancel Pending Order › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel Pending Order › Responses

Specific order description test

errorobject | string | null
resultobject

Cancel Deferred Order

POST

https://api.vignette.id

/public/orders/{id}/cancel-deferred

The ability to cancel an order that has a DEFERRED status if it is not processed within the specified time period

• DEFERRED - only.

⚠️ Rate limit policy applies to this endpoint Check Rate Limits

Cancel Deferred Order › path Parameters

idstring · required
id of order in Vignette ID system or custom_id from Partner system

Cancel Deferred Order › query Parameters

bug_reportboolean
Use with all endpoints to inform us for bugs in API
Default: false

Cancel Deferred Order › Headers

Authorizationstring · required
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Cancel Deferred Order › Responses

Specific order description test

errorobject | string | null
resultobject

Users List Endpoints Extended List Endpoints