Public API - Orders

Get order history (envelope level)

Returns paginated order history at the Order envelope level. Each row is a purchase that may contain one or more activations.

get/v1/public/orders/history

Request

  • Base URL: https://api.sms-virtual.net
  • URL: https://api.sms-virtual.net/v1/public/orders/history
  • Auth: API key in header x-api-key

Query parameters

startDatestring

Filter by createdAt >= startDate (ISO 8601, e.g. 2026-01-15T00:00:00Z).

endDatestring

Filter by createdAt <= endDate (ISO 8601, e.g. 2026-01-15T23:59:59Z).

searchstring

Case-insensitive substring match on invoice number, phone number, or service name.

statusnumber

Filter by order status. 0 = PENDING, 1 = SUCCESS, 2 = FAILED, 3 = REFUNDED, 4 = EXPIRED. Omit for all.

pageSizenumber

Items per page. Defaults to 10.

pagenumber

Page number (1-based). Defaults to 1.

Response

Order history retrieved successfully. status (envelope, statusOrder): 0 PENDING, 1 SUCCESS, 2 FAILED, 3 REFUNDED, 4 EXPIRED. type (typeOrder): 0 SINGLESERVICE, 1 MULTISERVICE.

Changes

No recorded changes to this operation across all 1 revision of this API.