Get Order

Retrieve full details of a specific order or check its current status. Both endpoints are API key only, no signature required.

Get Order Details

text

GET /orders/:id

Path Parameters

Name	Type	Required	Description
`id`	UUID	Yes	The order ID

Example Request

GET/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90

curl "https://api.vignetim.com/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

Returns a single bare order object, in the same shape as the items of List Orders:

json

{
	"id": "0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90",
	"orderNumber": "VGN-2026-004512",
	"status": 4,
	"statusLabel": "COMPLETED",
	"totalAmount": 11.5,
	"discountAmount": 0,
	"taxAmount": 1.92,
	"currency": "EUR",
	"externalReference": "YOUR-ORDER-REF-001",
	"products": [
		{
			"id": "7e6d5c4b-3a2f-1e0d-9c8b-7a6f5e4d3c2b",
			"status": 4,
			"statusLabel": "COMPLETED",
			"productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
			"productTypeId": 1,
			"price": 11.5,
			"vehicle": {
				"plate": "AB123CD",
				"countryIsocode": "AT",
				"categoryId": "f1e2d3c4-b5a6-7890-abcd-ef1234567890"
			},
			"startAt": "2026-04-01T00:00:00.000Z",
			"endAt": "2026-04-10T23:59:59.000Z"
		}
	],
	"createdAt": "2026-03-20T14:30:00.000Z",
	"updatedAt": "2026-03-20T14:31:15.000Z"
}

Orders that do not belong to your organization return 404.

Get Order Status

A lightweight endpoint that returns the current order status with a per-product breakdown, useful for polling.

text

GET /orders/:id/status

Path Parameters

Name	Type	Required	Description
`id`	UUID	Yes	The order ID

Example Request

GET/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90/status

curl "https://api.vignetim.com/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90/status" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

json

{
	"orderId": "0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90",
	"status": 4,
	"statusLabel": "COMPLETED",
	"productStatuses": [
		{
			"productId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
			"productTypeId": 1,
			"status": 4,
			"statusLabel": "COMPLETED"
		}
	],
	"externalReference": "YOUR-ORDER-REF-001",
	"updatedAt": "2026-03-20T14:31:15.000Z"
}

Field	Type	Description
`orderId`	UUID	Order ID
`status`	integer / null	Aggregated status (numeric); `null` when the order has no products
`statusLabel`	string / null	Status enum name for `status`
`productStatuses`	array	Per-product status entries
`externalReference`	string	Your external reference (optional)
`updatedAt`	ISO 8601	Last update timestamp

Status values, labels, and the aggregation rule are documented in List Orders.

Tip: Prefer webhooks over polling for status updates. See Webhooks Overview.

Get Order Documents

Returns the customer-facing documents of an order with short-lived download URLs. Use it after the order.fulfilled webhook, or whenever you need a fresh URL.

text

GET /orders/:id/documents

Path Parameters

Name	Type	Required	Description
`id`	UUID	Yes	The order ID

Example Request

GET/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90/documents

curl "https://api.vignetim.com/v2/partners/orders/0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90/documents" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

json

{
	"orderId": "0d9c1c7e-3f4b-4d2a-9b1e-2f6a8c5d7e90",
	"documents": [
		{
			"type": "CONFIRMATION_PDF",
			"typeId": 1,
			"orderProductId": "7e6d5c4b-3a2f-1e0d-9c8b-7a6f5e4d3c2b",
			"filename": "confirmation.pdf",
			"url": "https://files.vignetim.com/orders/...",
			"expiresAt": "2026-03-21T09:17:00.000Z"
		}
	],
	"esim": [
		{
			"orderProductId": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
			"iccid": "8943108165000000000",
			"providerOrderId": "20260321-123456"
		}
	]
}

Field	Type	Description
`documents[].type`	string	`CONFIRMATION_PDF` or `PROVIDER_TICKET_PDF`
`documents[].typeId`	integer	Numeric form of `type`
`documents[].orderProductId`	UUID	Line item the document belongs to
`documents[].filename`	string	Suggested file name
`documents[].url`	string	Presigned download URL, valid for 5 minutes
`documents[].expiresAt`	ISO 8601	When `url` stops working
`esim[]`	array	eSIM identifiers for eSIM line items; empty for other products

Notes:

Download URLs expire after 5 minutes. Do not store them; call this endpoint again when you need a new one.
Only documents meant for your end customer are returned. Vignetim receipts, provider invoices, and legal invoices stay internal.
The esim block carries identifiers only. eSIM QR codes and installation instructions are delivered by the eSIM provider directly to the customer email on the order.
Documents appear once the order is fulfilled. An order that is paid but not yet issued returns an empty documents array.
Orders that do not belong to your organization return 404.