Verdmarket tiekėjo API
REST API produktų, atsargų, kainų ir užsakymų programiniam valdymui.
Bazinis URL
Galimi galiniai taškai
| Metodas | Galinis taškas | Aprašymas |
|---|---|---|
| GET | /products | Produktų sąrašas |
| GET | /products/{id} | Produkto detalės |
| POST | /products | Sukurti produktą |
| POST | /products/{id} | Atnaujinti produktą |
| POST | /products/{id}/delete | Ištrinti produktą |
| GET | /products/{id}/images | Produkto nuotraukų sąrašas |
| POST | /products/{id}/images | Pridėti nuotraukas per URL |
| POST | /products/{id}/images/{imageId}/delete | Ištrinti nuotrauką |
| POST | /products/{id}/images/{imageId}/primary | Nustatyti pagrindinę nuotrauką |
| POST | /stock | Masinis atsargų atnaujinimas |
| POST | /prices | Masinis kainų atnaujinimas |
| GET | /orders | Užsakymų sąrašas |
| GET | /orders/{id} | Užsakymo detalės |
| POST | /orders/{id}/status | Atnaujinti užsakymo būseną |
| GET | /categories | Kategorijų sąrašas |
Autentifikacija
Visi API užklausos reikalauja Bearer žetono Authorization antraštėje.
Sugeneruokite API raktą skiltyje Tiekėjo skydelis → Parduotuvės profilis → API raktai.
Užklausų limitai
Numatytasis: 1000 užklausų per valandą vienam API raktui.
Limito informacija grąžinama atsakymo antraštėse:
| Antraštė | Aprašymas |
|---|---|
| X-RateLimit-Limit | Maksimalus užklausų skaičius per valandą |
| X-RateLimit-Remaining | Likę užklausos dabartiniame lange |
| X-RateLimit-Reset | Unix laiko žyma, kada langas atstatomas |
| Retry-After | Sekundės iki pakartotinio bandymo (tik prie 429) |
Atsakymo formatas
Visi atsakymai yra JSON formatu. Sėkmingi atsakymai:
{
"success": true,
"data": { ... }
}Klaidų atsakymai:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Name is required."
}
}Produktai
/products
Jūsų produktų sąrašas su puslapiavimu ir filtravimu.
Užklausos parametrai
| Parametras | Tipas | Aprašymas |
|---|---|---|
| page | int | Puslapio numeris (numatytasis: 1) |
| per_page | int | Elementų puslapyje (maks.: 100, numatytasis: 20) |
| status | string | Filtras: active, inactive, pending |
| search | string | Ieškoti pagal pavadinimą arba SKU |
Atsakymo pavyzdys
{
"success": true,
"data": {
"products": [
{
"id": 42,
"name": "Red Roses Premium",
"sku": "ROSE-RED-001",
"type": "flower",
"base_price": 2.50,
"unit": "stem",
"stock_qty": 500,
"stock_status": "in_stock",
"is_active": true,
"is_approved": true,
"category": { "id": 3, "name": "Roses" },
"primary_image": "/uploads/products/rose-red.jpg"
}
],
"pagination": {
"current_page": 1,
"total_pages": 5,
"total_items": 94,
"per_page": 20
}
}
}/products/{id}
Gauti vieną produktą su nuotraukomis ir variantais.
/products
Sukurti naują produktą. Nauji produktai reikalauja administratoriaus patvirtinimo prieš pasirodant kataloge.
Užklausos turinys (JSON)
| Laukas | Tipas | Privalomas | Aprašymas |
|---|---|---|---|
| name | string | * | Produkto pavadinimas |
| category_id | int | * | Kategorijos ID |
| base_price | float | * | Kaina EUR |
| unit | string | * | stiebas, puokštė, dėžė, pakuotė, vienetas, kilogramas, metras, ritinys |
| type | string | flower (numatytasis) arba supply | |
| description | string | Produkto aprašymas | |
| sku | string | Unikalus SKU (tikrinamas dėl dublikatų) | |
| stock_qty | int | Atsargų kiekis (numatytasis: 0) | |
| min_order_qty | int | Minimalus užsakymo kiekis (numatytasis: 1) | |
| color | string | Produkto spalva | |
| stem_length | int | Stiebo ilgis cm | |
| country_of_origin | string | Kilmės šalis | |
| vat_rate | float | PVM tarifas % (numatytasis: 21) | |
| image_url | string | Nuotraukos URL. Palaikomi jpg, png, webp. Keli URL atskiriami kabliataškiu (;). Maks. 10 nuotraukų vienam produktui. |
/products/{id}
Atnaujinti esamą produktą. Siųskite tik laukus, kuriuos norite keisti (dalinis atnaujinimas).
/products/{id}/delete
Minkštas produkto ištrynimas. Užklausos turinys nereikalingas.
Produkto nuotraukos
/products/{id}/images
Gauti visas produkto nuotraukas. Grąžina URL adresus ir pagrindinės nuotraukos žymę.
Atsakymo pavyzdys
{
"success": true,
"data": {
"images": [
{
"id": 1,
"url": "/uploads/products/abc123.jpg",
"thumbnail_url": "/uploads/products/thumb_abc123.jpg",
"is_primary": true
},
{
"id": 2,
"url": "/uploads/products/def456.jpg",
"thumbnail_url": "/uploads/products/thumb_def456.jpg",
"is_primary": false
}
]
}
}/products/{id}/images
Pridėti nuotraukas per URL. Serveris atsisiunčia, patikrina (jpg/png/webp, maks. 5 MB) ir automatiškai sukuria miniatiūras. Naudokite kabliataškį keliems URL.
Užklausos turinys (JSON)
| Laukas | Tipas | Privalomas | Aprašymas |
|---|---|---|---|
| image_url | string | * | Nuotraukos URL. Palaikomi jpg, png, webp. Keli URL atskiriami kabliataškiu (;). Maks. 10 nuotraukų vienam produktui. |
Užklausos turinys
{
"image_url": "https://example.com/images/rose.jpg;https://example.com/images/rose-2.jpg"
}/products/{id}/images/{imageId}/delete
Ištrinti produkto nuotrauką. Failas pašalinamas iš serverio. Jei ištrinta nuotrauka buvo pagrindinė, kita nuotrauka automatiškai tampa pagrindine.
/products/{id}/images/{imageId}/primary
Nustatyti nuotrauką kaip pagrindinę. Pagrindinė nuotrauka rodoma katalogo sąrašuose ir paieškos rezultatuose.
Masinis atsargų atnaujinimas
/stock
Atnaujinti atsargų kiekius keliems produktams vienu metu. Identifikuokite produktus pagal product_id arba sku. Maks. 500 elementų užklausoje.
Užklausos turinys
{
"items": [
{ "product_id": 42, "stock_qty": 500 },
{ "sku": "ROSE-RED-001", "stock_qty": 250 },
{ "sku": "LILY-WHT-003", "stock_qty": 0 }
]
}Atsakymas
{
"success": true,
"data": {
"updated": 2,
"failed": 1,
"errors": [
{ "index": 2, "sku": "LILY-WHT-003", "error": "Product not found" }
]
}
}Masinis kainų atnaujinimas
/prices
Atnaujinti kainas keliems produktams. Tas pats formatas kaip atsargų atnaujinimas, bet su base_price lauku. Maks. 500 elementų.
Užklausos turinys
{
"items": [
{ "product_id": 42, "base_price": 2.75 },
{ "sku": "ROSE-RED-001", "base_price": 3.10 }
]
}Užsakymai
/orders
Jūsų užsakymų grupių sąrašas (tiekėjui skirtos užsakymo dalys).
Užklausos parametrai
| Parametras | Tipas | Aprašymas |
|---|---|---|
| page | int | Puslapio numeris |
| per_page | int | Elementų puslapyje (maks. 100) |
| status | string | pending, confirmed, processing, shipped, delivered, completed, cancelled |
/orders/{id}
Pilna užsakymo informacija, įskaitant elementus, kliento duomenis ir būsenų istoriją.
/orders/{id}/status
Atnaujinti užsakymo būseną. Leidžiami tik tinkami perėjimai:
| Iš | Leidžiami perėjimai |
|---|---|
| pending | confirmed, cancelled |
| confirmed | processing, cancelled |
| processing | shipped, cancelled |
| shipped | delivered |
Užklausos turinys
{
"status": "confirmed",
"comment": "Order confirmed, preparing for shipment"
}Kategorijos
/categories
Visų aktyvių kategorijų sąrašas. Grąžina plokščią sąrašą su tėvinėmis nuorodomis.
Atsakymo pavyzdys
{
"success": true,
"data": {
"categories": [
{ "id": 1, "name": "Flowers", "slug": "flowers", "parent_id": null, "type": "flower" },
{ "id": 3, "name": "Roses", "slug": "roses", "parent_id": 1, "type": "flower" }
]
}
}Klaidų kodai
| HTTP | Kodas | Aprašymas |
|---|---|---|
| 401 | UNAUTHORIZED | Trūkstamas arba netinkamas API raktas |
| 403 | FORBIDDEN | Raktas atšauktas arba tiekėjas nepatvirtintas |
| 404 | NOT_FOUND | Išteklius nerastas |
| 422 | VALIDATION_ERROR | Netinkami įvesties duomenys |
| 429 | RATE_LIMITED | Užklausų limitas viršytas |
| 500 | SERVER_ERROR | Vidinė serverio klaida |
Kodo pavyzdžiai
Produktų sąrašas
curl -X GET "https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products?page=1&per_page=10" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Accept: application/json"
Produkto kūrimas
curl -X POST "https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Red Roses Premium",
"category_id": 3,
"base_price": 2.50,
"unit": "stem",
"stock_qty": 500,
"sku": "ROSE-RED-001",
"color": "Red",
"stem_length": 60,
"country_of_origin": "Netherlands",
"image_url": "https://example.com/images/rose-red.jpg"
}'Produkto nuotraukų pridėjimas
curl -X POST "https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/products/42/images" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"image_url": "https://example.com/img/photo1.jpg;https://example.com/img/photo2.jpg"
}'Masinis atsargų atnaujinimas
curl -X POST "https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier/stock" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"items": [
{"sku": "ROSE-RED-001", "stock_qty": 500},
{"sku": "LILY-WHT-003", "stock_qty": 200}
]
}'PHP pavyzdys
<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier';
// List products
$ch = curl_init("$baseUrl/products?page=1&per_page=10");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
"Authorization: Bearer $apiKey",
"Accept: application/json",
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);
// Bulk stock update
$ch = curl_init("$baseUrl/stock");
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode([
'items' => [
['sku' => 'ROSE-RED-001', 'stock_qty' => 500],
['sku' => 'LILY-WHT-003', 'stock_qty' => 200],
],
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer $apiKey",
"Content-Type: application/json",
],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);Python pavyzdys
import requests
API_KEY = "YOUR_API_KEY"
BASE_URL = "https://www.verdmarket.com.mature-black-wombat.65-108-70-81.cpanel.site/api/v1/supplier"
headers = {"Authorization": f"Bearer {API_KEY}"}
# List products
resp = requests.get(f"{BASE_URL}/products", headers=headers,
params={"page": 1, "per_page": 10})
products = resp.json()
# Bulk stock update
resp = requests.post(f"{BASE_URL}/stock", headers=headers,
json={"items": [
{"sku": "ROSE-RED-001", "stock_qty": 500},
{"sku": "LILY-WHT-003", "stock_qty": 200},
]})
result = resp.json()
# Update order status
resp = requests.post(f"{BASE_URL}/orders/15/status", headers=headers,
json={"status": "confirmed",
"comment": "Ready for shipment"})
print(resp.json())