Pasūtījumi
Jūsu telpu apmaksātie pasūtījumi, tikai lasīšanai. Izmantojiet tos, lai redzētu, kas ko un kad ir nomājis, un lai panāktu iepalikušo pēc pārtraukuma.
orders:read, ko BoxLatvia piešķir apzināti. Lai uzzinātu brīdī, kad pasūtījums veikts, izmantojiet Webhooks.#Pasūtījuma objekts
| Nosaukums | Tips | Apraksts |
|---|---|---|
id | uuid | BoxLatvia identifikators. |
reference | string | Pasūtījuma numurs, ko min nomnieks un BoxLatvia. |
status | string | PAID (apmaksāts), REFUNDED (atmaksāts) vai CANCELLED (atcelts). Pasūtījums, kas nav apmaksāts, netiek rādīts. |
deal_status | string | null | AWAITING: telpas īpašniekam līdz confirm_deadline jāapstiprina noma. CONFIRMED (apstiprināts) vai FAILED (nav apstiprināts laikā vai noma nenotiks). |
confirm_deadline confirmed_at failed_at | datetime | null | Līdz kuram laikam noma jāapstiprina, kad tā apstiprināta, kad neizdevās. ISO 8601, UTC. |
box_id | uuid | null | Telpa, kas tika iznomāta. |
box_external_id | string | null | Jūsu identifikators telpai, ja esat to iestatījis. |
location_id | uuid | null | Telpas lokācija. |
location_external_id | string | null | Jūsu identifikators lokācijai. |
rent_from rent_to | date | null | Nomas periods, YYYY-MM-DD. |
rental_units | integer | null | Nomas periodu skaits (piemēram, mēneši). |
unit_price | number | null | Viena perioda cena. |
amount currency | number, string | Cik nomnieks samaksāja un valūta (EUR). |
extra_services | string[] | Papildu pakalpojumi, ko nomnieks izvēlējās, ja tādi ir. |
customer | object | Nomnieka { name, email, phone }. Satur nomnieka vārdu, e-pastu un tālruni: tie ir personas dati. Izmantojiet tos tikai telpas nodošanai un nomas apkalpošanai. |
paid_at refunded_at | datetime | null | Kad pasūtījums tika apmaksāts un kad atmaksāts. ISO 8601, UTC. |
created_at | datetime | ISO 8601, UTC. |
updated_at | datetime | Mainās ikreiz, kad pasūtījums mainās. Izmantojiet kopā ar updated_since, lai uzzinātu, kas mainījies. ISO 8601, UTC. |
{
"id": "614211b3-38be-4ba5-94e2-6f177542a174",
"reference": "ORD-MI3K7ZQ0-4F2A",
"status": "PAID",
"deal_status": "AWAITING",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": null,
"failed_at": null,
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-12-01",
"rent_to": "2027-02-28",
"rental_units": 3,
"unit_price": 31.5,
"amount": 94.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Jānis Ozols",
"email": "janis.ozols@example.com",
"phone": "+371 20000001"
},
"paid_at": "2026-11-14T09:12:30.000Z",
"refunded_at": null,
"created_at": "2026-11-14T09:10:02.000Z",
"updated_at": "2026-11-14T09:12:30.000Z"
}#Galapunkti
#Pasūtījumu saraksts
/v1/ordersorders:readJūsu telpu apmaksātie pasūtījumi, vispirms vecākās izmaiņas, pa vienai lapai. Tikai lasīšana.
Izmantojiet to, lai sāktu ar pilnu ainu un panāktu iepalikušo pēc pārtraukuma: atcerieties pēdējā apstrādātā pasūtījuma updated_at un nākamreiz pieprasiet updated_since ar šo vērtību. Pasūtījums ar tieši šādu laiku atnāk atkal, tāpēc ignorējiet pasūtījumus, kas jums jau ir. Skatiet arī Webhooks, kas paziņo brīdī, kad kaut kas notiek.
Satur nomnieka vārdu, e-pastu un tālruni: tie ir personas dati. Izmantojiet tos tikai telpas nodošanai un nomas apkalpošanai.
Vaicājuma parametri
| Nosaukums | Tips | Apraksts |
|---|---|---|
limit | integer | Lapas lielums, no 1 līdz 200. Noklusējums ir 50. |
cursor | string | Iepriekšējās lapas next_cursor. Neveidojiet kursorus paši. |
status | string | PAID, REFUNDED vai CANCELLED. |
deal_status | string | AWAITING, CONFIRMED vai FAILED. |
box_id | uuid | Tikai šīs telpas pasūtījumi. |
box_external_id | string | Tikai telpas ar šo jūsu identifikatoru pasūtījumi. |
reference | string | Tikai pasūtījums ar šo numuru. |
updated_since | datetime | Tikai pasūtījumi, kas mainīti šajā laikā vai vēlāk, piemēram, 2026-11-14T09:00:00Z. |
Piemēri
curl "$API/v1/orders?limit=2" \
-u "$CLIENT_ID:$CLIENT_SECRET"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const res = await fetch(`${API}/v1/orders?limit=2`, {
headers: { Authorization: auth },
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.get(
f"{API}/v1/orders?limit=2",
auth=(CLIENT_ID, CLIENT_SECRET),
)
print(r.status_code, r.json()){
"data": [
{
"id": "614211b3-38be-4ba5-94e2-6f177542a174",
"reference": "ORD-MI3K7ZQ0-4F2A",
"status": "PAID",
"deal_status": "AWAITING",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": null,
"failed_at": null,
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-12-01",
"rent_to": "2027-02-28",
"rental_units": 3,
"unit_price": 31.5,
"amount": 94.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Jānis Ozols",
"email": "janis.ozols@example.com",
"phone": "+371 20000001"
},
"paid_at": "2026-11-14T09:12:30.000Z",
"refunded_at": null,
"created_at": "2026-11-14T09:10:02.000Z",
"updated_at": "2026-11-14T09:12:30.000Z"
},
{
"id": "7975c57c-2ef3-40dc-a2d5-0c0c2533b541",
"reference": "ORD-MI3L1B90-9C1D",
"status": "PAID",
"deal_status": "CONFIRMED",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": "2026-11-14T10:05:11.000Z",
"failed_at": null,
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-11-20",
"rent_to": "2026-12-19",
"rental_units": 1,
"unit_price": 31.5,
"amount": 31.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Marta Liepiņa",
"email": "marta.liepina@example.com",
"phone": "+371 20000002"
},
"paid_at": "2026-11-14T09:40:00.000Z",
"refunded_at": null,
"created_at": "2026-11-14T09:38:41.000Z",
"updated_at": "2026-11-14T10:05:11.000Z"
}
],
"next_cursor": "WyIyMDI2LTExLTE0IDEwOjA1OjExLjAwMCswMCIsIjk2MzViNDE5LThlNzQtNGQ5YS1iOTRjLTRmMzQxMmQ2MzEyZCJd"
}Pasūtījumi sakārtoti pēc izmaiņu laika, tāpēc varat glabāt atzīmi.
curl "$API/v1/orders?updated_since=2026-11-14T10:00:00Z&box_external_id=SKU-3M" \
-u "$CLIENT_ID:$CLIENT_SECRET"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const res = await fetch(`${API}/v1/orders?updated_since=2026-11-14T10:00:00Z&box_external_id=SKU-3M`, {
headers: { Authorization: auth },
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.get(
f"{API}/v1/orders?updated_since=2026-11-14T10:00:00Z&box_external_id=SKU-3M",
auth=(CLIENT_ID, CLIENT_SECRET),
)
print(r.status_code, r.json()){
"data": [
{
"id": "7975c57c-2ef3-40dc-a2d5-0c0c2533b541",
"reference": "ORD-MI3L1B90-9C1D",
"status": "PAID",
"deal_status": "CONFIRMED",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": "2026-11-14T10:05:11.000Z",
"failed_at": null,
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-11-20",
"rent_to": "2026-12-19",
"rental_units": 1,
"unit_price": 31.5,
"amount": 31.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Marta Liepiņa",
"email": "marta.liepina@example.com",
"phone": "+371 20000002"
},
"paid_at": "2026-11-14T09:40:00.000Z",
"refunded_at": null,
"created_at": "2026-11-14T09:38:41.000Z",
"updated_at": "2026-11-14T10:05:11.000Z"
},
{
"id": "5aad7dee-7f4b-4ca3-a908-b0a87b8792b6",
"reference": "ORD-MI3M5X44-27E8",
"status": "REFUNDED",
"deal_status": "FAILED",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": null,
"failed_at": "2026-11-14T11:20:00.000Z",
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-12-01",
"rent_to": "2027-02-28",
"rental_units": 3,
"unit_price": 31.5,
"amount": 94.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Pēteris Kalniņš",
"email": "peteris.kalnins@example.com",
"phone": null
},
"paid_at": "2026-11-14T09:50:00.000Z",
"refunded_at": "2026-11-14T11:20:00.000Z",
"created_at": "2026-11-14T09:48:10.000Z",
"updated_at": "2026-11-14T11:20:00.000Z"
}
],
"next_cursor": null
}curl "$API/v1/orders?status=maybe&updated_since=yesterday" \
-u "$CLIENT_ID:$CLIENT_SECRET"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const res = await fetch(`${API}/v1/orders?status=maybe&updated_since=yesterday`, {
headers: { Authorization: auth },
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.get(
f"{API}/v1/orders?status=maybe&updated_since=yesterday",
auth=(CLIENT_ID, CLIENT_SECRET),
)
print(r.status_code, r.json()){
"type": "https://api.boxlatvia.lv/problems/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields are invalid.",
"request_id": "22879f48-8c91-4c54-aab3-ef1cb47b2dec",
"errors": [
{
"field": "status",
"message": "must be one of PAID, REFUNDED, CANCELLED"
},
{
"field": "updated_since",
"message": "must be an ISO 8601 date or date and time, for example 2026-11-13T09:00:00Z"
}
]
}Kļūdas
| Statuss | Kad |
|---|---|
| 403 | Piekļuves datiem nav tiesību orders:read. |
| 422 | Filtrs nav derīgs; tiek uzskaitītas visas problēmas. |
#Nolasīt pasūtījumu
/v1/orders/{id}orders:readViens pasūtījums.
Ceļa parametri
| Nosaukums | Tips | Apraksts |
|---|---|---|
id | uuid | Pasūtījuma identifikators. |
Piemēri
curl "$API/v1/orders/614211b3-38be-4ba5-94e2-6f177542a174" \
-u "$CLIENT_ID:$CLIENT_SECRET"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const res = await fetch(`${API}/v1/orders/614211b3-38be-4ba5-94e2-6f177542a174`, {
headers: { Authorization: auth },
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.get(
f"{API}/v1/orders/614211b3-38be-4ba5-94e2-6f177542a174",
auth=(CLIENT_ID, CLIENT_SECRET),
)
print(r.status_code, r.json()){
"id": "614211b3-38be-4ba5-94e2-6f177542a174",
"reference": "ORD-MI3K7ZQ0-4F2A",
"status": "PAID",
"deal_status": "AWAITING",
"confirm_deadline": "2026-11-15T09:12:30.000Z",
"confirmed_at": null,
"failed_at": null,
"box_id": "c4883b4a-4e38-47bf-8a69-ef025917e022",
"box_external_id": "SKU-3M",
"location_id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3",
"location_external_id": "WH-IMANTA",
"rent_from": "2026-12-01",
"rent_to": "2027-02-28",
"rental_units": 3,
"unit_price": 31.5,
"amount": 94.5,
"currency": "EUR",
"extra_services": [],
"customer": {
"name": "Jānis Ozols",
"email": "janis.ozols@example.com",
"phone": "+371 20000001"
},
"paid_at": "2026-11-14T09:12:30.000Z",
"refunded_at": null,
"created_at": "2026-11-14T09:10:02.000Z",
"updated_at": "2026-11-14T09:12:30.000Z"
}curl "$API/v1/orders/74c1f875-f6e8-4d9c-bcd3-52032635d35a" \
-u "$CLIENT_ID:$CLIENT_SECRET"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const res = await fetch(`${API}/v1/orders/74c1f875-f6e8-4d9c-bcd3-52032635d35a`, {
headers: { Authorization: auth },
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.get(
f"{API}/v1/orders/74c1f875-f6e8-4d9c-bcd3-52032635d35a",
auth=(CLIENT_ID, CLIENT_SECRET),
)
print(r.status_code, r.json()){
"type": "https://api.boxlatvia.lv/problems/not-found",
"title": "Not found",
"status": 404,
"detail": "No such order.",
"request_id": "4c9a8e0d-9587-4f2f-8780-48a10da5842b"
}Kļūdas
| Statuss | Kad |
|---|---|
| 404 | Jums nav šāda pasūtījuma, vai tas nav apmaksāts. |