API atsauce
Imports
Nosūtiet Excel vai CSV failu; katra rinda izveido vai atjaunina lokāciju, telpu vai attēlu. Viss par failu aizpildīšanu ir importa pamācībā.
#Importa pārskats
| Nosaukums | Tips | Apraksts |
|---|---|---|
kind | string | locations, boxes vai pictures. |
validate_only | boolean | true, ja fails tika tikai pārbaudīts. |
summary | object | { total, created, updated, unchanged, failed }. Attēliem created skaita pievienotos attēlus. |
rows | object[] | Viens ieraksts katrai datu rindai: row (kā to rāda Excel), external_id, status, ieraksta id un errors neizdevušai rindai. |
#Galapunkts
#Importēt failu
POST
/v1/imports/{kind}imports:writeIzveido vai atjaunina lokācijas, telpas vai attēlus no Excel (.xlsx) vai CSV faila, katrai rindai vienu ierakstu. Atbilde parāda, kas notika ar katru rindu.
- Sāciet ar attiecīgā veida šablonu: tā kolonnas ir tās, ko imports lasa.
- Rindas
external_id(jūsu pašu identifikators) lemj: ja tāds ir, rinda to atjaunina, tukša šūna atstāj vērtību nemainītu; ja tāda nav, rinda to izveido. - Rindas ir neatkarīgas. Rinda, kas neizdodas, neaptur pārējās, un atbildē ir visas tās problēmas uzreiz.
?validate_only=trueizpilda visas pārbaudes, lejupielādē attēlus un neko nesaglabā: izmantojiet to pirms īstā importa.- Līdz 500 rindām failā lokācijām un telpām, 50 attēliem. Lielākus failus sadaliet.
Ceļa parametri
| Nosaukums | Tips | Apraksts |
|---|---|---|
kind | string | locations, boxes vai pictures. |
Vaicājuma parametri
| Nosaukums | Tips | Apraksts |
|---|---|---|
validate_only | boolean | true: pārbaudīt visu un neko nesaglabāt. Statusi tad ir would_create / would_update. |
Galvenes
| Nosaukums | Tips | Apraksts |
|---|---|---|
Idempotency-Key | string | Neobligāta. Atkārtots pieprasījums ar to pašu atslēgu atgriež pirmo atbildi, nevis importē vēlreiz. |
Pieprasījuma saturs (multipart/form-data)
| Nosaukums | Tips | Apraksts |
|---|---|---|
file obligāts | file | Viens .xlsx vai .csv fails. Tiek lasīta lapa ar nosaukumu Data (vai Dati), vai pirmā lapa. |
Piemēri
Vispirms pārbaudiet lokāciju failu
Nekas netiek saglabāts: statusi parāda, kas notiktu, un tiek uzskaitītas visas katras rindas problēmas.
curl -X POST "$API/v1/imports/locations?validate_only=true" \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-F "file=@boxlatvia-locations.xlsx"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const form = new FormData();
form.append("file", boxlatvia_locationsFile); // File vai Blob
const res = await fetch(`${API}/v1/imports/locations?validate_only=true`, {
method: "POST",
headers: { Authorization: auth },
body: form,
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.post(
f"{API}/v1/imports/locations?validate_only=true",
auth=(CLIENT_ID, CLIENT_SECRET),
files=[("file", open("boxlatvia-locations.xlsx", "rb"))],
)
print(r.status_code, r.json())200 OKX-Validate-Only: true
{
"kind": "locations",
"validate_only": true,
"summary": {
"total": 3,
"created": 1,
"updated": 1,
"unchanged": 0,
"failed": 1
},
"rows": [
{
"row": 2,
"external_id": "WH-IMANTA",
"status": "would_update",
"id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3"
},
{
"row": 3,
"external_id": "WH-KENGARAGS",
"status": "would_create"
},
{
"row": 4,
"external_id": "WH-NOWHERE",
"status": "failed",
"errors": [
{
"field": "district",
"message": "\"atlantis\" is not a known district code (see the Codes sheet)"
}
]
}
]
}Lokāciju imports
curl -X POST "$API/v1/imports/locations" \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-F "file=@boxlatvia-locations.xlsx"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const form = new FormData();
form.append("file", boxlatvia_locationsFile); // File vai Blob
const res = await fetch(`${API}/v1/imports/locations`, {
method: "POST",
headers: { Authorization: auth },
body: form,
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.post(
f"{API}/v1/imports/locations",
auth=(CLIENT_ID, CLIENT_SECRET),
files=[("file", open("boxlatvia-locations.xlsx", "rb"))],
)
print(r.status_code, r.json())200 OK
{
"kind": "locations",
"validate_only": false,
"summary": {
"total": 2,
"created": 1,
"updated": 1,
"unchanged": 0,
"failed": 0
},
"rows": [
{
"row": 2,
"external_id": "WH-IMANTA",
"status": "updated",
"id": "9d80d5f4-d17a-4f3e-99f6-4ab43b132bc3"
},
{
"row": 3,
"external_id": "WH-KENGARAGS",
"status": "created",
"id": "3f502d49-40f5-43e8-8004-dc4bb2f28a99"
}
]
}Telpas: viena atjaunināta, viena izveidota, viena ar problēmām
Pirmā rinda sūta tikai available_units: pieejamības atjauninājums. Viss pārējais šai telpai paliek.
curl -X POST "$API/v1/imports/boxes" \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-F "file=@boxlatvia-boxes.xlsx"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const form = new FormData();
form.append("file", boxlatvia_boxesFile); // File vai Blob
const res = await fetch(`${API}/v1/imports/boxes`, {
method: "POST",
headers: { Authorization: auth },
body: form,
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.post(
f"{API}/v1/imports/boxes",
auth=(CLIENT_ID, CLIENT_SECRET),
files=[("file", open("boxlatvia-boxes.xlsx", "rb"))],
)
print(r.status_code, r.json())200 OK
{
"kind": "boxes",
"validate_only": false,
"summary": {
"total": 3,
"created": 1,
"updated": 1,
"unchanged": 0,
"failed": 1
},
"rows": [
{
"row": 2,
"external_id": "SKU-3M",
"status": "updated",
"id": "c4883b4a-4e38-47bf-8a69-ef025917e022"
},
{
"row": 3,
"external_id": "SKU-8M",
"status": "created",
"id": "e8e189c3-3ac4-47d0-8ff1-584221c4e1ae"
},
{
"row": 4,
"external_id": "SKU-9M",
"status": "failed",
"errors": [
{
"field": "price_unit",
"message": "\"gadsimts\" is not a known price unit code (see the Codes sheet)"
},
{
"field": "price",
"message": "must have at most 2 decimals"
}
]
}
]
}Attēli pēc adreses
curl -X POST "$API/v1/imports/pictures" \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-F "file=@boxlatvia-pictures.xlsx"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const form = new FormData();
form.append("file", boxlatvia_picturesFile); // File vai Blob
const res = await fetch(`${API}/v1/imports/pictures`, {
method: "POST",
headers: { Authorization: auth },
body: form,
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.post(
f"{API}/v1/imports/pictures",
auth=(CLIENT_ID, CLIENT_SECRET),
files=[("file", open("boxlatvia-pictures.xlsx", "rb"))],
)
print(r.status_code, r.json())200 OK
{
"kind": "pictures",
"validate_only": false,
"summary": {
"total": 3,
"created": 2,
"updated": 0,
"unchanged": 0,
"failed": 1
},
"rows": [
{
"row": 2,
"external_id": "WH-IMANTA",
"status": "created",
"id": "734e0d86-9a60-4107-9997-c9f0bcf77610"
},
{
"row": 3,
"external_id": "SKU-3M",
"status": "created",
"id": "d504c7e6-8458-456a-884d-0b4ba02be2d3"
},
{
"row": 4,
"external_id": "SKU-3M",
"status": "failed",
"errors": [
{
"field": "picture_url",
"message": "the address answered HTTP 404"
}
]
}
]
}Fails, ko nevar izmantot
curl -X POST "$API/v1/imports/boxes" \
-u "$CLIENT_ID:$CLIENT_SECRET" \
-F "file=@boxlatvia-boxes.xlsx"const API = "https://api.boxlatvia.lv";
const auth = "Basic " + btoa(`${CLIENT_ID}:${CLIENT_SECRET}`);
const form = new FormData();
form.append("file", boxlatvia_boxesFile); // File vai Blob
const res = await fetch(`${API}/v1/imports/boxes`, {
method: "POST",
headers: { Authorization: auth },
body: form,
});
console.log(res.status, await res.json());import requests
API = "https://api.boxlatvia.lv"
r = requests.post(
f"{API}/v1/imports/boxes",
auth=(CLIENT_ID, CLIENT_SECRET),
files=[("file", open("boxlatvia-boxes.xlsx", "rb"))],
)
print(r.status_code, r.json())422 Unprocessable Content
{
"type": "https://api.boxlatvia.lv/problems/validation-failed",
"title": "Validation failed",
"status": 422,
"detail": "One or more fields are invalid.",
"request_id": "88b1f62d-3509-4d1f-b542-ff67a35787ae",
"errors": [
{
"field": "columns",
"message": "unknown column(s): nane, colour. The columns of this file are: external_id, name, location_external_id, description, price, promotional_price, price_period_1, price_period_3, price_period_6, price_period_12, price_unit, size, size_length, size_width, size_height, door_width, door_height, total_units, available_units, max_advance_days, features"
}
]
}Kļūdas
| Statuss | Kad |
|---|---|
| 403 | Piekļuves datiem nav tiesību imports:write. |
| 404 | kind nav locations, boxes vai pictures. |
| 415 | Nav multipart/form-data, vai vecs .xls fails: saglabājiet to kā .xlsx vai .csv. |
| 422 | Failu kopumā nevar izmantot: nezināmas vai trūkstošas kolonnas, nav datu rindu, pārāk daudz rindu, nav nolasāms. Problēmas ar atsevišķām rindām ir atbildē (statuss 200), nevis šeit. |