Vignetim

Get Order

Retrieve full details of a specific order or check its current status.

Get Order Details

GET /orders/:id

Path Parameters

NameTypeRequiredDescription
idstringYesThe order ID (e.g., ord-a1b2c3d4-e5f6-7890-abcd-ef1234567890)

Response

{
	"id": "ord-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"status": "COMPLETED",
	"products": [
		{
			"productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
			"productTypeId": 1,
			"productName": "Austria 10-Day Vignette",
			"quantity": 1,
			"status": "COMPLETED",
			"vehiclePlate": "AB123CD",
			"vehicleCountryIsocode": "AT",
			"startAt": "2026-04-01T00:00:00.000Z",
			"endAt": "2026-04-10T23:59:59.000Z"
		}
	],
	"payment": {
		"type": "CARD",
		"status": "CAPTURED",
		"paidAt": "2026-03-20T14:31:10.000Z"
	},
	"customer": {
		"email": "john.doe@example.com",
		"firstName": "John",
		"lastName": "Doe"
	},
	"total": {
		"amount": 11.5,
		"currency": "EUR"
	},
	"externalReference": "YOUR-ORDER-REF-001",
	"idempotencyKey": "unique-order-key-12345",
	"createdAt": "2026-03-20T14:30:00.000Z",
	"completedAt": "2026-03-20T14:31:15.000Z"
}

Get Order Status

A lightweight endpoint that returns only the current order status, useful for polling.

GET /orders/:id/status

Path Parameters

NameTypeRequiredDescription
idstringYesThe order ID

Response

{
	"id": "ord-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
	"status": "COMPLETED",
	"updatedAt": "2026-03-20T14:31:15.000Z"
}

Order Statuses

StatusDescription
PENDINGOrder created, awaiting payment confirmation
PROCESSINGPayment confirmed, products being provisioned
COMPLETEDAll products delivered successfully
FAILEDPayment failed or product provisioning error
CANCELLEDOrder was cancelled
REFUNDEDOrder was refunded