List Orders

Retrieve a paginated list of your orders with optional filters.

text

GET /orders

API key only, no signature required. Only orders created through the Partner API for your organization are returned.

Query Parameters

Name	Type	Required	Description
`page`	integer	No	Page number (default: 1)
`limit`	integer	No	Items per page (default: 20, max: 100)
`status`	integer	No	Filter by order product status (numeric, see status table below)
`productType`	integer	No	Filter by product type: `1` = TICKET, `2` = ESIM, `4` = INSURANCE, `5` = FINES
`dateFrom`	ISO 8601	No	Filter orders created on or after this date
`dateTo`	ISO 8601	No	Filter orders created on or before this date
`externalReference`	string	No	Filter by your external reference

Example Request

GET/v2/partners/orders

curl "https://api.vignetim.com/v2/partners/orders" \
  -H "X-API-Key: $VIGNETIM_API_KEY"

Response

json

{
	"data": [
		{
			"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"
		}
	],
	"metadata": {
		"total": 156,
		"page": 1,
		"limit": 20,
		"totalPages": 8
	}
}

Order Object

Field	Type	Description
`id`	UUID	Order ID
`orderNumber`	string	Human-readable order number (optional)
`status`	integer / null	Aggregated order status (numeric, see below); `null` when the order has no products
`statusLabel`	string / null	Status enum name for `status`, e.g. `COMPLETED`
`totalAmount`	number	Order total
`discountAmount`	number	Discount applied
`taxAmount`	number	Tax portion
`currency`	string	Currency code, e.g. `EUR`
`externalReference`	string	Your external reference (optional)
`products`	array	Order products (see below)
`createdAt`	ISO 8601	Creation timestamp
`updatedAt`	ISO 8601	Last update timestamp

Order Product Object

Field	Type	Description
`id`	UUID	Order product line ID
`status`	integer	Product status (numeric)
`statusLabel`	string / null	Status enum name, e.g. `COMPLETED`
`productId`	string	Catalog product ID (ticket UUID, eSIM ID, or slug)
`productTypeId`	integer	Product type
`price`	number	Line price
`vehicle`	object	`{ plate?, countryIsocode?, categoryId? }` (optional)
`startAt`	ISO 8601	Validity start (optional)
`endAt`	ISO 8601	Validity end (optional)

Order Statuses

status is numeric; statusLabel carries the matching enum name.

Value	Label	Description
`0`	`NONE`	No status assigned
`1`	`PENDING`	Awaiting processing
`2`	`REQUESTED`	Requested from the provider
`3`	`IN_PROGRESS`	Being processed
`4`	`COMPLETED`	Successfully completed
`5`	`REJECTED`	Rejected
`6`	`REFUND_REQUESTED`	Refund requested
`7`	`REFUND_COMPLETED`	Refund completed
`8`	`ACTION_REQUIRED`	Requires additional action
`9`	`RESERVED`	Reserved
`10`	`SEMI_COMPLETED`	Completed but not fully processed
`11`	`FAILED`	Fulfillment failed after payment; under review
`12`	`EXPIRED`	Unpaid order auto-expired

Aggregation Rule

The order-level status is derived from its products:

All products COMPLETED -> COMPLETED
Any product REJECTED -> REJECTED
Any product PENDING -> PENDING
Otherwise -> the first product's status
No products -> null