Verdmarketi tarnija API
REST API toodete, laoseisu, hindade ja tellimuste programmiliseks haldamiseks.
Baas-URL
Saadaolevad lõpp-punktid
| Meetod | Lõpp-punkt | Kirjeldus |
|---|---|---|
| GET | /products | Toodete nimekiri |
| GET | /products/{id} | Toote üksikasjad |
| POST | /products | Loo toode |
| POST | /products/{id} | Uuenda toodet |
| POST | /products/{id}/delete | Kustuta toode |
| GET | /products/{id}/images | Toote piltide loend |
| POST | /products/{id}/images | Piltide lisamine URL kaudu |
| POST | /products/{id}/images/{imageId}/delete | Pildi kustutamine |
| POST | /products/{id}/images/{imageId}/primary | Põhipildi määramine |
| POST | /stock | Hulgilaoseisu uuendamine |
| POST | /prices | Hulgihinnamuutus |
| GET | /orders | Tellimuste nimekiri |
| GET | /orders/{id} | Tellimuse üksikasjad |
| POST | /orders/{id}/status | Uuenda tellimuse olekut |
| GET | /categories | Kategooriate nimekiri |
Autentimine
Kõik API päringud nõuavad Bearer žetooni Authorization päises.
Looge oma API võti jaotises Tarnija paneel → Poe profiil → API võtmed.
Päringupiirangud
Vaikimisi: 1000 päringut tunnis API võtme kohta.
Piirangu teave tagastatakse vastuse päistes:
| Päis | Kirjeldus |
|---|---|
| X-RateLimit-Limit | Maksimaalne päringute arv tunnis |
| X-RateLimit-Remaining | Järelejäänud päringud praeguses aknas |
| X-RateLimit-Reset | Unixi ajatempel akna lähtestamiseks |
| Retry-After | Sekundid uuesti proovimiseni (ainult 429 puhul) |
Vastuse vorming
Kõik vastused on JSON-vormingus. Edukad vastused:
{
"success": true,
"data": { ... }
}Veavastused:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Name is required."
}
}Tooted
/products
Teie toodete nimekiri leheküljenduse ja filtreerimisega.
Päringuparameetrid
| Parameeter | Tüüp | Kirjeldus |
|---|---|---|
| page | int | Lehekülje number (vaikimisi: 1) |
| per_page | int | Elemente lehel (maks: 100, vaikimisi: 20) |
| status | string | Filter: active, inactive, pending |
| search | string | Otsi nime või SKU järgi |
Näidisvastus
{
"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}
Ühe toote hankimine koos piltide ja variantidega.
/products
Uue toote loomine. Uued tooted vajavad administraatori kinnitust enne kataloogi ilmumist.
Päringu sisu (JSON)
| Väli | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
| name | string | * | Toote nimi |
| category_id | int | * | Kategooria ID |
| base_price | float | * | Hind EUR-ides |
| unit | string | * | vars, kimp, kast, pakk, tükk, kilogramm, meeter, rull |
| type | string | flower (vaikimisi) või supply | |
| description | string | Toote kirjeldus | |
| sku | string | Unikaalne SKU (kontrollitakse duplikaate) | |
| stock_qty | int | Laokogus (vaikimisi: 0) | |
| min_order_qty | int | Minimaalne tellimiskogus (vaikimisi: 1) | |
| color | string | Toote värvus | |
| stem_length | int | Varre pikkus cm-ides | |
| country_of_origin | string | Päritolumaa | |
| vat_rate | float | Käibemaksu määr %-des (vaikimisi: 21) | |
| image_url | string | Pildi URL(id). Toetab jpg, png, webp. Mitu URL-i semikooloniga (;) eraldatuna. Max 10 pilti toote kohta. |
/products/{id}
Olemasoleva toote uuendamine. Saatke ainult väljad, mida soovite muuta (osaline uuendamine).
/products/{id}/delete
Toote pehme kustutamine. Päringu sisu pole nõutav.
Tootepildid
/products/{id}/images
Toote kõikide piltide päring. Tagastab URL-id ja põhipildi märgendi.
Näidisvastus
{
"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
Piltide lisamine URL kaudu. Server laadib alla, kontrollib (jpg/png/webp, max 5 MB) ja loob automaatselt pisipildid. Kasutage mitme URL-i eraldamiseks semikoolonit.
Päringu sisu (JSON)
| Väli | Tüüp | Kohustuslik | Kirjeldus |
|---|---|---|---|
| image_url | string | * | Pildi URL(id). Toetab jpg, png, webp. Mitu URL-i semikooloniga (;) eraldatuna. Max 10 pilti toote kohta. |
Päringu sisu
{
"image_url": "https://example.com/images/rose.jpg;https://example.com/images/rose-2.jpg"
}/products/{id}/images/{imageId}/delete
Tootepildi kustutamine. Fail eemaldatakse serverist. Kui kustutatud pilt oli põhipilt, saab automaatselt järgmine pilt põhipildiks.
/products/{id}/images/{imageId}/primary
Pildi määramine põhipildiks (peamine). Põhipilti kuvatakse kataloogiloendites ja otsingutulemustes.
Hulgilaoseisu uuendamine
/stock
Laokoguste uuendamine mitmele tootele korraga. Tuvastage tooted product_id või sku järgi. Maks 500 elementi päringu kohta.
Päringu sisu
{
"items": [
{ "product_id": 42, "stock_qty": 500 },
{ "sku": "ROSE-RED-001", "stock_qty": 250 },
{ "sku": "LILY-WHT-003", "stock_qty": 0 }
]
}Vastus
{
"success": true,
"data": {
"updated": 2,
"failed": 1,
"errors": [
{ "index": 2, "sku": "LILY-WHT-003", "error": "Product not found" }
]
}
}Hulgihinnamuutus
/prices
Hindade uuendamine mitmele tootele. Sama vorming nagu laoseisu uuendamine, kuid base_price väljaga. Maks 500 elementi.
Päringu sisu
{
"items": [
{ "product_id": 42, "base_price": 2.75 },
{ "sku": "ROSE-RED-001", "base_price": 3.10 }
]
}Tellimused
/orders
Teie tellimuste gruppide nimekiri (tarnijakohased tellimuse osad).
Päringuparameetrid
| Parameeter | Tüüp | Kirjeldus |
|---|---|---|
| page | int | Lehekülje number |
| per_page | int | Elemente lehel (maks 100) |
| status | string | pending, confirmed, processing, shipped, delivered, completed, cancelled |
/orders/{id}
Tellimuse täielikud üksikasjad, sealhulgas elemendid, klienditeave ja olekute ajalugu.
/orders/{id}/status
Tellimuse oleku uuendamine. Lubatud on ainult kehtivad üleminekud:
| Alates | Lubatud üleminekud |
|---|---|
| pending | confirmed, cancelled |
| confirmed | processing, cancelled |
| processing | shipped, cancelled |
| shipped | delivered |
Päringu sisu
{
"status": "confirmed",
"comment": "Order confirmed, preparing for shipment"
}Kategooriad
/categories
Kõigi aktiivsete kategooriate nimekiri. Tagastab lame nimekirja ülemviidetega.
Näidisvastus
{
"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" }
]
}
}Veakoodid
| HTTP | Kood | Kirjeldus |
|---|---|---|
| 401 | UNAUTHORIZED | Puuduv või kehtetu API võti |
| 403 | FORBIDDEN | Võti tühistatud või tarnija kinnitamata |
| 404 | NOT_FOUND | Ressurssi ei leitud |
| 422 | VALIDATION_ERROR | Kehtetud sisendandmed |
| 429 | RATE_LIMITED | Päringupiirang ületatud |
| 500 | SERVER_ERROR | Sisemine serveri viga |
Koodinäited
Toodete nimekiri
curl -X GET "https://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"
Toote loomine
curl -X POST "https://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"
}'Tootepiltide lisamine
curl -X POST "https://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"
}'Hulgilaoseisu uuendamine
curl -X POST "https://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 näide
<?php
$apiKey = 'YOUR_API_KEY';
$baseUrl = 'https://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);Pythoni näide
import requests
API_KEY = "YOUR_API_KEY"
BASE_URL = "https://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())