API فروشندگان

سیستم انبارداری، نرم‌افزار فروشگاه یا تأمین‌کنندهٔ دراپ‌شیپینگ خود را مستقیماً به فروشگاه ⁦eveyamin⁩ خود وصل کنید: محصولات را بسازید و به‌روز کنید، موجودی را در چند ثانیه همگام کنید، سفارش‌های پرداخت‌شده را دریافت کنید و ارسال‌ها را اعلام کنید.

ساخت کلید API فایل OpenAPI English version

شروع کار

API فروشندگان یک رابط REST با JSON در نشانی https://eveyamin.com/api/v1 است. نام فیلدها و مقدارها آلمانی‌اند – دسته‌بندی‌ها، رنگ‌ها، اندازه‌ها و وضعیت‌ها دقیقاً همان‌طور که در فروشگاه ثبت شده‌اند. اتصال را برنامه‌نویس شما، آژانس شما یا یک سرویس واسط (middleware) می‌سازد؛ افزونهٔ آماده‌ای برای سیستم‌های انبارداری خاص وجود ندارد.

ساخت کلید

در تنظیمات ← دسترسی API یک کلید بسازید و فقط مجوزهایی را انتخاب کنید که اتصال به آن‌ها نیاز دارد.
کلید را فوراً کپی کنید و در جای امنی نگه دارید – فقط همین یک بار نمایش داده می‌شود.
آن را در هر درخواست در هدر Authorization: Bearer <کلید> بفرستید.

مجوز	اجازه می‌دهد
`produkte:schreiben`	ساختن، تغییر، خواندن و بایگانی محصولات
`bestand:schreiben`	خواندن و تنظیم موجودی
`bestellungen:lesen`	دریافت سفارش‌ها و تأیید دریافت آن‌ها (به‌محض اینکه فروشگاه شما فعال شود)
`bestellungen:versenden`	اعلام ارسال با کد رهگیری

جای کلیدها روی سرور است، هرگز در صفحهٔ وب یا اپلیکیشن. می‌توانید حداکثر 10 کلید داشته باشید – برای هر اتصال یک کلید جدا به کار ببرید تا بتوانید هر کدام را جداگانه باطل کنید. اگر ممکن است کلیدی به دست افراد نادرست افتاده باشد، فوراً آن را باطل کنید.

اولین فراخوانی

درخواست

curl https://eveyamin.com/api/v1/ping \
  -H "Authorization: Bearer evy_live_…"

پاسخ

{
  "ok": true,
  "umgebung": "live",
  "haendler_id": "5a03da19-…",
  "schluessel": {
    "name": "Warenwirtschaft",
    "praefix": "evy_live_Ab3x",
    "berechtigungen": ["bestand:schreiben", "bestellungen:lesen"]
  }
}

اصلی و آزمایشی

کلیدها با evy_live_ (فروشگاه) یا evy_test_ (محیط آزمایشی) شروع می‌شوند و فقط همان‌جا کار می‌کنند که ساخته شده‌اند. کلیدی از محیط دیگر پاسخ 401 keyWrongEnvironment می‌گیرد.

مقدارهای آلمانی

دسته‌بندی‌ها با مسیر کامل‌شان می‌آیند (eve-Home > Bettwäsche > Bettwäsche-Sets)، رنگ‌ها و اندازه‌ها دقیقاً همان‌طور که در فروشگاه هستند. GET /api/v1/taxonomy همهٔ دسته‌بندی‌ها را با اندازه‌هایشان و همهٔ رنگ‌ها را برمی‌گرداند. API تفاوت‌های کوچک را خودش اصلاح می‌کند (weiss ← Weiß، 200x200 ← 200 x 200 cm) و آن‌ها را به‌صورت نکته گزارش می‌دهد. نام‌های خاص سیستم انبارداری خود را یک بار در درون‌ریزی CSV تطبیق دهید؛ این تطبیق برای API هم اعمال می‌شود.

محدودیت‌ها

مورد	محدودیت
درخواست برای هر کلید	120 در دقیقه، سپس 429 با `Retry-After`
اندازهٔ درخواست	1024 KB
سطر در هر فراخوانی موجودی	500
گونه برای هر محصول	500
تصویر برای هر محصول	20
محصول در هر صفحه	100
سفارش در هر صفحه	100

هر پاسخ JSON است و هرگز در حافظهٔ پنهان (cache) نگه داشته نمی‌شود. فراخوانی از مرورگر (CORS) مجاز نیست.

محصولات

هر محصول شامل مشخصاتش و گونه‌هایش (رنگ × اندازه) است. قواعد همان قواعد فرم محصول و درون‌ریزی CSV است: هرچه آن‌ها رد کنند، API هم رد می‌کند – با همان کدها. نام فیلدها همان نام ستون‌های قالب CSV است.

POST /api/v1/products

{
  "uebergeordnete_sku": "BW-SATIN-01",
  "titel": "Satin-Bettwäsche Uni",
  "beschreibung": "Bettwäsche aus 100 % Baumwollsatin, mit Reißverschluss.",
  "kategorie": "eve-Home > Bettwäsche > Bettwäsche-Sets",
  "rabattpreis": 44.90,
  "varianten": [
    {
      "farbe": "Weiß",
      "groesse": "135 x 200 cm",
      "preis": 49.90,
      "lagerbestand": 12,
      "sku": "BW-SATIN-01-W-135",
      "ean": "4006381333931",
      "bild_urls": ["https://bilder.example-shop.de/bw-satin-weiss.jpg"]
    },
    {
      "farbe": "Weiß",
      "groesse": "155 x 220 cm",
      "preis": "59,90",
      "lagerbestand": 5,
      "sku": "BW-SATIN-01-W-155"
    }
  ]
}

uebergeordnete_sku (Übergeordnete SKU، یعنی SKU والد) کلید شما برای محصول است و در فروشگاه شما یکتاست. بعداً با آن به محصول دسترسی دارید: /products/BW-SATIN-01.
kategorie مسیر کامل است؛ هر groesse باید متعلق به همان دسته‌بندی باشد.
preis برای هر گونه جداست. قیمت‌ها فقط بر اساس اندازه می‌توانند فرق کنند، نه رنگ؛ کمترین قیمت، قیمت پایه است. rabattpreis (قیمت با تخفیف) برای کل محصول است؛ بدون آن تخفیفی در کار نیست.
عددها می‌توانند به‌صورت متن هم بیایند، به قالب آلمانی یا انگلیسی ("59,90").
sku و ean برای هر گونه اختیاری‌اند. اگر فیلد را نفرستید، کد ذخیره‌شده می‌ماند؛ null آن را پاک می‌کند. EAN باید رقم کنترل معتبر داشته باشد.
bild_urls: نشانی‌های https. تصاویر بارگیری و نزد ما ذخیره می‌شوند؛ گالری می‌تواند فقط روی گونهٔ اول هم باشد.
versandkosten (هزینهٔ ارسال) اختیاری است: بدون آن، محصول جدید مقدار پیش‌فرض شما را می‌گیرد و محصول موجود مقدار خودش را نگه می‌دارد.

ساختن، جایگزینی، خواندن

فراخوانی	نتیجه
`POST /products`	محصول را می‌سازد: 201. اگر Übergeordnete SKU از قبل وجود داشته باشد: 409 `productExists` همراه با محصول موجود.
`PUT /products/{id}`	کل محصول را جایگزین می‌کند؛ گونه‌هایی که نیامده‌اند بایگانی می‌شوند. اگر `{id}` هنوز وجود نداشته باشد و بدنه `{id}` را به‌عنوان `uebergeordnete_sku` بیاورد، محصول ساخته می‌شود (upsert)؛ در غیر این صورت 404.
`GET /products/{id}`	محصول را دقیقاً به همان شکلی که PUT می‌پذیرد برمی‌گرداند، به‌علاوهٔ فیلدهای فقط‌خواندنی (`id`، `artikelnummer`، `status`، `geaendert_am`، `variant_id`). می‌توانید آن را همان‌طور که هست پس بفرستید.
`GET /products`	همهٔ محصولات شما، قدیمی‌ترین تغییر اول، از جمله بایگانی‌شده‌ها – با `geaendert_seit` فقط آن‌هایی که از آن زمان تغییر کرده‌اند.
`DELETE /products/{id}`	محصول را بایگانی می‌کند؛ فراخوانی دوم چیزی را تغییر نمی‌دهد.

{id} می‌تواند شناسهٔ محصول در ⁦eveyamin⁩، Übergeordnete SKU شما یا شمارهٔ کالای ⁦eveyamin⁩ (artikelnummer) باشد. محصولی که در فرم ساخته شده، Übergeordnete SKU خود را یک بار از طریق PUT /products/{artikelnummer} با uebergeordnete_sku در بدنه می‌گیرد؛ Übergeordnete SKU موجود فقط در فرم محصول تغییر می‌کند.

نتیجه

ergebnis یکی از angelegt (ساخته شد)، aktualisiert (به‌روز شد) یا unveraendert (بدون تغییر) است. وقتی چیزی تغییر نکرده باشد، چیزی نوشته و دوباره ترجمه نمی‌شود – بنابراین همگام‌سازی کامل همهٔ محصولات تقریباً هزینه‌ای ندارد. hinweise (نکته‌ها) نگارش‌های اصلاح‌شده و تصاویری را که بارگیری نشدند نام می‌برد. محصولات جدید ابتدا ترجمه می‌شوند (وضعیت «Wird übersetzt») و سپس منتشر می‌شوند.

تصاویر

تصاویر در طول فراخوانی بارگیری می‌شوند. اگر این کار زیادی طول بکشد، API با 202 و یک وظیفه پاسخ می‌دهد (Location: /api/v1/jobs/{id}). وضعیت وظیفه را تا وقتی fertig (تمام‌شده) شود بررسی کنید؛ محصول فقط وقتی ذخیره می‌شود که تصاویرش آماده باشند.
هر نشانی تصویر یک بار بارگیری می‌شود. بنابراین تصویر تغییریافته به نشانی تازه‌ای نیاز دارد، مثلاً با ?v=2.
اگر درخواست تازه‌تری برای همان محصول برسد، وظیفهٔ باز ersetzt (جایگزین‌شده) می‌شود.

موجودی در فراخوانی محصول

برای گونه‌هایی که از قبل در حال فروش‌اند، فراخوانی محصول موجودی را تغییر نمی‌دهد – این کار فراخوانی موجودی است. lagerbestand متفاوت به‌صورت نکتهٔ stockIgnored برمی‌گردد. محصولات جدید و گونه‌های جدید موجودی ارسال‌شده را می‌گیرند.

بایگانی‌شده، مسدود، متری

محصولات بایگانی‌شده را در داشبورد بازیابی کنید؛ PUT و POST پاسخ 409 productArchived می‌دهند. محصولات مسدود: 409 productBlocked. محصولاتی که متری فروخته می‌شوند (پارچه‌ها) هنوز در API نیستند: 409 productMeterware.

همگام‌سازی موجودی

فراخوانی موجودی فقط موجودی را تغییر می‌دهد، هرگز محصول را. سیستم انبارداری شما با آن موجودی eveyamin را به‌روز نگه می‌دارد تا وقتی در چند کانال می‌فروشید، چیزی دو بار فروخته نشود.

PATCH /api/v1/stock

{
  "positionen": [
    { "sku": "BW-SATIN-01-W-135", "lagerbestand": 11, "stand": "2026-10-09T14:05:00+02:00" },
    { "produkt": "BW-SATIN-01", "farbe": "Weiß", "groesse": "155 x 220 cm", "lagerbestand": 0 }
  ]
}

هر سطر یک گونه را با sku، یا با produkt + farbe + groesse مشخص می‌کند. حداکثر 500 سطر در هر فراخوانی، برای همهٔ محصولات روی هم.
lagerbestand موجودی شماست. این مقدار منهای تعداد اقلامی ذخیره می‌شود که در سفارش‌های باز eveyamin هستند و سیستم شما هنوز دریافتشان را تأیید نکرده است – شمارش شما نمی‌تواند از آن‌ها خبر داشته باشد.
stand، یعنی زمان شمارش خود را بفرستید. سطری که stand آن قدیمی‌تر از آخرین مقدار پذیرفته‌شده باشد نادیده گرفته می‌شود (veraltet، کهنه).
هر سطر نتیجهٔ خودش را دارد: ok، unveraendert، veraltet یا fehler. سطر ناموفق بقیه را متوقف نمی‌کند.
در صورت 503 busy چیزی ذخیره نشده است؛ درخواست را پس از Retry-After ثانیه تکرار کنید.

روش کار

یک بار GET /stock را صفحه‌به‌صفحه بخوانید و کالاهای خود را با گونه‌ها تطبیق دهید، ترجیحاً با sku.
با هر تغییر موجودی، یا مثلاً هر پنج دقیقه، PATCH /stock را با سطرهای تغییرکرده و stand بفرستید.
سفارش‌های جدید را دریافت و تأیید کنید – فقط در این صورت دیگر باز به حساب نمی‌آیند.

سفارش‌ها و دراپ‌شیپینگ

سفارش‌های پرداخت‌شده‌ای را که اقلام شما را دارند دریافت می‌کنید، دریافتشان را تأیید می‌کنید و ارسال را اعلام می‌کنید. اقلام فروشندگان دیگرِ همان سفارش به شما نشان داده نمی‌شود.

GET /orders/new – سفارش‌های پرداخت‌شده‌ای که سیستم شما هنوز تأیید نکرده است، قدیمی‌ترین اول. سفارش تا وقتی تأییدش نکنید آنجا می‌ماند؛ اگر پاسخی گم شود، در فراخوانی بعدی دوباره می‌آید.
POST /orders/{id}/acknowledge – سیستم شما آن را دریافت کرده است. با POST /orders/acknowledge تا 100 سفارش یکجا.
POST /orders/{id}/fulfill با شرکت حمل و کد رهگیری – اقلام «Versendet» (ارسال شد) می‌شوند و خریدار ایمیلی با پیوند رهگیری دریافت می‌کند.
GET /orders?geaendert_seit=… – لغوها و بازپرداخت‌هایی که بعداً رخ می‌دهند. آخرین geaendert_am را نگه دارید و با کمی هم‌پوشانی دوباره بپرسید.

POST /api/v1/orders/1042/fulfill

{
  "versanddienstleister": "DHL",
  "sendungsnummer": "00340434161234567890"
}

{id} شناسهٔ سفارش در eveyamin یا شمارهٔ سفارش (bestellnummer) است.
شرکت‌های حمل: DHL، DPD، Hermes، GLS، UPS، Deutsche Post یا Sonstige (سایر – در این صورت با tracking_url خودتان).
چند بسته: برای هر کد رهگیری یک فراخوانی، با positionen همان بسته. ارسال دوبارهٔ همان کد رهگیری چیزی را تغییر نمی‌دهد و ایمیل دومی نمی‌فرستد.
نشانی تحویل شامل نام، نشانی و تلفن است، اما ایمیل ندارد: ⁦eveyamin⁩ با خریدار در ارتباط است.

دراپ‌شیپینگ: به تأمین‌کنندهٔ خود کلید جداگانه‌ای بدهید که فقط bestellungen:lesen و bestellungen:versenden را داشته باشد. در این صورت او نه محصولات را می‌بیند و نه موجودی را. مسئولیت او، از جمله نحوهٔ برخوردش با داده‌های خریداران، با شما می‌ماند – شرایط و قوانین و حریم خصوصی را ببینید.

محیط آزمایشی

برای توسعه، یک محیط آزمایشی در ⁦https://staging--eveyamin.netlify.app⁩ وجود دارد. داده‌ها و کلیدهای خودش را دارد (evy_test_…) و به خریداران ایمیلی نمی‌فرستد.

در ⁦https://staging--eveyamin.netlify.app⁩ ثبت‌نام کنید و به info@eveyamin.com بنویسید – ما حساب شما را به‌عنوان فروشگاه آزمایشی تنظیم می‌کنیم.
آنجا در تنظیمات ← دسترسی API یک کلید آزمایشی بسازید.
از طریق API محصول بسازید و سفارش آزمایشی ثبت کنید.

سفارش آزمایشی

curl -X POST https://staging--eveyamin.netlify.app/api/v1/sandbox/orders \
  -H "Authorization: Bearer evy_test_…"

POST /sandbox/orders برای یکی از گونه‌های شما یک سفارش پرداخت‌شده می‌سازد – بدون بدنه برای اولین گونهٔ دارای موجودی، یا به‌طور مشخص با {"positionen": [{"sku": "…", "menge": 2}]}. خریدار، شخصیت خیالی Erika Mustermann است. سفارش همهٔ مراحل یک سفارش واقعی را طی می‌کند: /orders/new، تأیید دریافت، اعلام ارسال. حداکثر 30 در ساعت. همین دکمه در محیط آزمایشی زیر «دسترسی API» هم هست؛ فروشگاه اصلی چنین فراخوانی‌ای ندارد.

محیط آزمایشی بایگانی نیست: داده‌هایش ممکن است هر زمان بازنشانی شوند.

خطاها

خطاها همیشه یک شکل دارند:

{
  "fehler": [
    {
      "code": "colorUnknown",
      "feld": "varianten[1].farbe",
      "nachricht": "Unbekannte Farbe „Weis“. Meintest du „Weiß“?"
    }
  ]
}

به code تکیه کنید: ثابت و انگلیسی است. nachricht (پیام) آلمانی است و ممکن است تغییر کند؛ feld (فیلد) مسیر JSON فیلد مربوط است، یا null.

وضعیت	معنا
200 / 201	انجام شد؛ 201 برای محصول تازه‌ساخته یا سفارش آزمایشی
202	پذیرفته شد، تصاویر هنوز در حال بارگیری‌اند (وظیفه)
400	JSON معتبر نیست، یا پارامترها نامعتبرند
401	کلیدی نیامده، یا کلید نامعتبر یا باطل‌شده است
403	مجوز کم است، یا فروشگاه هنوز تأیید نشده است
404	پیدا نشد – یا متعلق به شما نیست
409	تعارض با یک کلید یا وضعیت (مثلاً Übergeordnete SKU از قبل گرفته شده)
422	بدنهٔ نامعتبر
429	درخواست‌های بیش از حد
500 / 503	خطا در سمت ما یا قطعی کوتاه – بعداً دوباره تلاش کنید

هر فراخوانی

کد	وضعیت	معنا
`invalidJson`	400	بدنهٔ درخواست JSON معتبر نیست.
`invalidQuery`	400	`seite`، `pro_seite` یا `geaendert_seit` نامعتبر است.
`keyMissing`	401	هیچ کلیدی در هدر `Authorization: Bearer …` نیست.
`keyInvalid`	401	کلید ناشناخته یا باطل‌شده است، یا حساب فعال نیست.
`keyWrongEnvironment`	401	کلید آزمایشی در فروشگاه اصلی، یا برعکس.
`scopeMissing`	403	کلید مجوز لازم برای این فراخوانی را ندارد.
`registrationNotApproved`	403	ثبت‌نام فروشگاه هنوز تأیید نشده است (سفارش‌ها: فروشگاه هنوز فعال نیست).
`apiNotEnabled`	403	API هنوز برای فروشگاه شما فعال نشده است.
`notFound`	404	مسیر ناشناخته.
`bodyTooLarge`	413	درخواست بیش از حد بزرگ است.
`rateLimited`	429	تعداد درخواست‌ها بیش از حد است؛ به تعداد ثانیه‌هایی که `Retry-After` می‌گوید صبر کنید.
`internal`	500	خطای غیرمنتظره در سمت ما؛ بعداً دوباره تلاش کنید.
`unavailable`	503	سرویس موقتاً در دسترس نیست؛ پس از `Retry-After` دوباره تلاش کنید.

محصولات

کد	وضعیت	معنا
`productNotFound`	404	چنین محصولی از شما وجود ندارد.
`jobNotFound`	404	چنین وظیفه‌ای از شما وجود ندارد.
`productExists`	409	Übergeordnete SKU از قبل وجود دارد؛ پاسخ، محصول را نام می‌برد. از PUT استفاده کنید.
`productArchived`	409	محصول بایگانی شده است؛ آن را در داشبورد بازیابی کنید.
`productBlocked`	409	محصول مسدود است و قابل تغییر نیست.
`productMeterware`	409	محصولاتی که متری فروخته می‌شوند هنوز در API نیستند.
`parentSkuDuplicate`	409	این Übergeordnete SKU را از قبل به کار برده‌اید.
`imagesFailed`	422	هیچ‌یک از تصاویر محصول بارگیری نشد.
`writeFailed`	500	محصول ذخیره نشد؛ بعداً دوباره تلاش کنید.
`tooManyVariants`	422	تعداد گونه‌ها بیش از حد مجاز است.
`invalidValue`	422	قالب یکی از مقدارها نادرست است.

موجودی

کد	وضعیت	معنا
`invalidBody`	422	`{ "positionen": [ … ] }` انتظار می‌رود (یا قالب همان فراخوانی).
`noLines`	422	`positionen` خالی است.
`tooManyLines`	422	تعداد سطرها بیش از حد است؛ آن‌ها را در چند درخواست بفرستید.
`busy`	503	موجودی هم‌اکنون جای دیگری در حال تغییر است؛ چیزی ذخیره نشد، دوباره تلاش کنید.
`invalidLine`	در سطر	سطر یک شیء نیست.
`identifierMissing`	در سطر	نه `sku` آمده و نه `produkt` + `farbe` + `groesse`.
`stockInvalid`	در سطر	`lagerbestand` عدد صحیح مجازی نیست.
`standInvalid`	در سطر	`stand` زمانی به قالب ISO 8601 همراه با منطقهٔ زمانی نیست.
`standInFuture`	در سطر	`stand` در آینده است.
`variantNotFound`	در سطر	هیچ گونهٔ فعالی مطابقت ندارد.
`keyMismatch`	در سطر	SKU به ترکیبی جز آنچه بقیهٔ مقدارهای سطر نشان می‌دهند تعلق دارد.
`duplicateLine`	در سطر	همین گونه پیش‌تر در سطر دیگری آمده است.

سفارش‌ها و ارسال

کد	وضعیت	معنا
`orderNotFound`	404	چنین سفارش پرداخت‌شده‌ای با اقلامی از شما وجود ندارد.
`noEntries`	422	`bestellungen` خالی است.
`tooManyEntries`	422	تعداد سفارش‌ها در یک درخواست بیش از حد است.
`invalidEntry`	در سطر	نه شناسهٔ سفارش است و نه شمارهٔ سفارش.
`orderNotShippable`	409	فقط سفارش‌های پرداخت‌شده قابل ارسال‌اند.
`nothingToShip`	409	هیچ‌یک از اقلام شما دیگر در وضعیت «In Bearbeitung» (در حال انجام) نیست.
`invalidCarrier`	422	شرکت حمل ناشناخته.
`invalidTrackingNumber`	422	کد رهگیری: 4 تا 40 نویسه از `A–Z`، `0–9` و `-`.
`invalidTrackingUrl`	422	`tracking_url` پیوند https نیست.
`lineNotFound`	422	هیچ‌یک از اقلام شما در این سفارش این شناسه را ندارد.
`lineNotShippable`	422	این قلم دیگر در وضعیت «In Bearbeitung» نیست.
`lineInOtherShipment`	422	این قلم پیش‌تر با کد رهگیری دیگری ارسال شده است.

محیط آزمایشی

کد	وضعیت	معنا
`noStock`	422	هیچ گونهٔ دارای موجودی برای سفارش آزمایشی وجود ندارد.
`sandboxLimit`	429	سفارش‌های آزمایشی در یک ساعت گذشته بیش از حد بوده است.

نکته‌ها

کد	وضعیت	معنا
`stockIgnored`	نکته	موجودی گونه‌ای که در حال فروش است اعمال نشد؛ برای این کار از فراخوانی موجودی استفاده کنید.
`valueMapped`	نکته	مقدار از طریق تطبیق شما اعمال شد.

بررسی‌های محصول

محصولات مانند درون‌ریزی CSV بررسی می‌شوند. این کدها در fehler (409 برای تعارض کلیدها، وگرنه 422) یا به‌صورت نکته می‌آیند. خود پیام‌ها آلمانی‌اند؛ اینجا به فارسی آمده‌اند:

کد	وضعیت	معنا
`required`	422	«…» الزامی است.
`tooLong`	422	«…» بیش از حد طولانی است (حداکثر … نویسه).
`tooShort`	422	«…» بیش از حد کوتاه است (دست‌کم … نویسه).
`numberInvalid`	422	«…» عدد معتبری نیست.
`priceRange`	422	«…» بین … و … نیست.
`stockInvalid`	422	«…» موجودی معتبری نیست (عدد صحیح از 0 تا …).
`categoryUnknown`	422	دسته‌بندی ناشناختهٔ «…».
`categoryIncomplete`	422	دسته‌بندی «…» کامل نیست – لطفاً تا پایین‌ترین سطح وارد کنید.
`categoryNotOffered`	422	دسته‌بندی «…» دیگر ارائه نمی‌شود.
`colorUnknown`	422	رنگ ناشناختهٔ «…».
`sizeUnknown`	422	اندازهٔ ناشناختهٔ «…».
`sizeNotInCategory`	422	اندازهٔ «…» در «…» ارائه نمی‌شود.
`duplicateCombination`	422	ترکیب … پیش‌تر در ⁦varianten[…]⁩ آمده است.
`priceVariesByColor`	422	قیمت … با ⁦varianten[…]⁩ فرق دارد. قیمت فقط بر اساس اندازه می‌تواند متفاوت باشد، نه رنگ.
`discountAboveBase`	422	قیمت تخفیفی (… €) از کمترین قیمت (… €) بیشتر است.
`imageUrlInvalid`	422	«…» نشانی تصویر معتبری نیست (https://…).
`tooManyImages`	422	… تصویر – حداکثر … برای هر محصول.
`noImages`	422	لطفاً برای هر محصول دست‌کم یک نشانی تصویر وارد کنید.
`skuDuplicateInFile`	422	SKU «…» پیش‌تر در ⁦varianten[…]⁩ آمده است.
`skuTaken`	409	SKU «…» از قبل متعلق به محصول دیگری از شماست.
`eanInvalid`	422	«…» یک EAN معتبر نیست (۸، ۱۲، ۱۳ یا ۱۴ رقم با رقم کنترل درست).
`ambiguousMatch`	409	«…» با بیش از یک محصول موجود مطابقت دارد (شمارهٔ کالا …).
`parentSkuLocked`	409	محصول … از قبل Übergeordnete SKU «…» را دارد. Übergeordnete SKU موجود را در فرم محصول تغییر دهید.
`parentSkuOfOther`	409	«…» از قبل متعلق به محصول … شماست، اما eveyamin-Artikelnummer متعلق به … است. لطفاً Übergeordnete SKU دیگری به کار ببرید.
`categoryFixed`	نکته	دسته‌بندی به‌صورت «…» پذیرفته شد.
`colorFixed`	نکته	رنگ «…» به‌صورت «…» پذیرفته شد.
`sizeFixed`	نکته	اندازهٔ «…» به‌صورت «…» پذیرفته شد.
`imageFailed`	نکته	تصویر پذیرفته نشد (…): …

مرجع

همهٔ فراخوانی‌ها با پارامترها و فیلدهایشان، مستقیماً از خود رابط تولید شده‌اند؛ توضیحات مانند خود API آلمانی‌اند. برای Postman، Insomnia یا مولدهای کد، فایل OpenAPI در دسترس است.

Allgemein

Schlüssel prüfen und die deutschen Werte des Shops abrufen.

GET/api/v1/ping

Schlüssel prüfen

Antwortet mit dem Händler und den Berechtigungen des Schlüssels.

مجوز: هر کلید معتبر

پاسخ‌ها

200 Der Schlüssel gilt. – Ping

فیلد	نوع	الزامی	توضیح
`ok`	true	بله
`umgebung`	string	بله	live = Shop, test = Testumgebung.مقدارها: live, test
`haendler_id`	string	بله	Deine Händler-ID bei eveyamin.
`schluessel`	object	بله
`schluessel.name`	string	بله
`schluessel.praefix`	string	بله	Anfang des Schlüssels, z. B. evy_live_Ab3x.
`schluessel.berechtigungen`	string[]	بله	مقدارها: produkte:schreiben, bestand:schreiben, bestellungen:lesen, bestellungen:versenden

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/taxonomy

Kategorien, Größen und Farben

Die Werte, die Produkte und Bestand verwenden – zum Zuordnen der eigenen Werte. Dieselben Listen wie in der Import-Vorlage.

مجوز: هر کلید معتبر

پاسخ‌ها

200 Die aktuellen Listen. – Taxonomie

فیلد	نوع	الزامی	توضیح
`kategorien`	object[]	بله	Jede Kategorie, unter der ein Produkt stehen kann.
`kategorien[].pfad`	string	بله	Vollständiger Kategoriepfad, mit „ > “ getrennt, z. B. „eve-Home > Bettwäsche > Bettwäsche-Sets“.
`kategorien[].groessen`	string[]	بله	Größen, die diese Kategorie anbietet.
`farben`	string[]	بله	Alle Farben, z. B. „Weiß“ oder „Ohne Farbe“.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

Produkte

Produkte anlegen, ersetzen, lesen und archivieren (WP2).

POST/api/v1/products

Produkt anlegen

Ein Produkt mit allen Farbe-×-Größe-Kombinationen (varianten, höchstens 500), geprüft nach denselben Regeln wie der Katalog-Import und das Produktformular, mit denselben Fehlercodes. Den Bestand bestehender Kombinationen ändert nur PATCH /products/{id}/stock: ein abweichender lagerbestand bleibt unberücksichtigt (Hinweis stockIgnored); neue Produkte und neue Kombinationen übernehmen ihn. Fehlende Kombinationen werden archiviert. Fehlen sku oder ean bei einer Variante, bleiben die gespeicherten. Bilder werden zu eveyamin geladen; eine schon geladene Adresse wird nicht erneut geladen, ein geändertes Bild braucht also eine neue Adresse. Dauert das Laden zu lange, antwortet der Aufruf mit 202 und einem Auftrag (/jobs/{id}); das Produkt wird geschrieben, sobald die Bilder da sind. Ein unverändertes Produkt wird nicht geschrieben und nicht neu übersetzt (unveraendert). Neue und geänderte Titel und Beschreibungen werden übersetzt, bevor das Produkt sichtbar wird. uebergeordnete_sku ist hier Pflicht; gibt es sie schon: 409 productExists mit dem Produkt.

مجوز: produkte:schreiben

بدنه – ProduktAnfrage

فیلد	نوع	الزامی	توضیح
`uebergeordnete_sku`	string \| null	خیر	Deine Produktnummer, eindeutig in deinem Shop, max. 100 Zeichen. Pflicht beim Anlegen.
`titel`	string	بله	Max. 100 Zeichen.
`beschreibung`	string	بله	10 bis 10.000 Zeichen.
`kategorie`	string	بله	Vollständiger Pfad, z. B. „eve-Home > Bettwäsche > Bettwäsche-Sets“ (siehe /taxonomy).
`rabattpreis`	number \| string \| null	خیر
`versandkosten`	number \| string \| null	خیر
`varianten`	ProduktVarianteEingabe[]	بله
`varianten[].farbe`	string	بله	Farbe wie im Shop, z. B. „Weiß“ (siehe /taxonomy).
`varianten[].groesse`	string	بله	Größe aus der Größenliste der Kategorie, z. B. „M“ oder „200 x 200 cm“.
`varianten[].preis`	number \| string	بله	Preis dieser Variante in EUR, brutto. Preise dürfen sich nur je Größe unterscheiden; der niedrigste ist der Grundpreis.
`varianten[].lagerbestand`	number \| string	بله	Bestand, 0 bis 10.000. Gilt nur für neue Produkte und neue Kombinationen; den Bestand bestehender Kombinationen änderst du über /products/{id}/stock.
`varianten[].sku`	string \| null	خیر	Deine SKU dieser Kombination, eindeutig in deinem Shop, max. 64 Zeichen.
`varianten[].ean`	string \| null	خیر	EAN / GTIN (8, 12, 13 oder 14 Ziffern mit Prüfziffer). Fehlt der Schlüssel, bleibt die gespeicherte EAN; null löscht sie.
`varianten[].bild_urls`	string[]	خیر	Öffentliche https-Bildadressen. Ein Bild nur bei Varianten bestimmter Farben gehört zu diesen Farben, eines bei allen Farben gilt für alle; stehen alle Bilder nur bei einer Farbe (z. B. nur bei der ersten Variante), gelten sie für alle. Bekannte Adressen werden nicht neu geladen – ein geändertes Bild braucht eine neue Adresse.

پاسخ‌ها

201 Angelegt (Location: /api/v1/products/{id}). – ProduktErgebnis

فیلد	نوع	الزامی	توضیح
`ergebnis`	string	بله	unveraendert: Das Produkt war schon so; nichts wurde geschrieben oder neu übersetzt.مقدارها: angelegt, aktualisiert, unveraendert
`produkt`	Produkt	بله
`produkt.id`	string	بله	eveyamin-Produkt-ID.
`produkt.artikelnummer`	string	بله	eveyamin-Artikelnummer.
`produkt.uebergeordnete_sku`	string \| null	بله
`produkt.status`	string	بله	Neue und geänderte Texte werden erst übersetzt; ohne eingerichteten Zahlungsanbieter bleibt das Produkt verborgen.مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`produkt.titel`	string	بله
`produkt.beschreibung`	string	بله
`produkt.kategorie`	string	بله
`produkt.rabattpreis`	number \| null	بله
`produkt.versandkosten`	number \| null	بله
`produkt.geaendert_am`	string	بله	Letzte Änderung am Produkt, auch am Bestand. ISO 8601, UTC.
`produkt.varianten`	object[]	بله
`produkt.varianten[].variant_id`	string	بله
`produkt.varianten[].farbe`	string	بله
`produkt.varianten[].groesse`	string	بله
`produkt.varianten[].preis`	number	بله
`produkt.varianten[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`produkt.varianten[].sku`	string \| null	بله
`produkt.varianten[].ean`	string \| null	بله
`produkt.varianten[].bild_urls`	string[]	بله	Die Bilder dieser Farbe, bei eveyamin gespeichert.
`hinweise`	object[]	بله	Z. B. korrigierte Schreibweisen, nicht geladene Bilder, ignorierter Bestand.
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله

202 Die Bilder werden noch geladen (Location: /api/v1/jobs/{id}). – ProduktInArbeit

فیلد	نوع	الزامی	توضیح
`ergebnis`	"in_arbeit"	بله
`auftrag`	Auftrag	بله
`auftrag.id`	string	بله
`auftrag.status`	string	بله	ersetzt: Eine neuere Anfrage für dasselbe Produkt kam dazwischen; dieser Auftrag wird nicht mehr geschrieben.مقدارها: wartet, in_arbeit, fertig, fehlgeschlagen, ersetzt
`auftrag.aktion`	string	بله	مقدارها: anlegen, aktualisieren
`auftrag.schluessel`	string	بله	Übergeordnete SKU des Produkts, oder seine Artikelnummer, wenn es keine hat.
`auftrag.bilder`	object	بله
`auftrag.bilder.gesamt`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.bilder.geladen`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.bilder.fehlgeschlagen`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.produkt`	object \| null	بله	Sobald das Produkt geschrieben ist.
`auftrag.produkt.id`	string	بله
`auftrag.produkt.artikelnummer`	string	بله
`auftrag.produkt.uebergeordnete_sku`	string \| null	بله
`auftrag.produkt.status`	string	بله	مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`auftrag.fehler`	string \| null	بله	Warum der Auftrag fehlgeschlagen ist.
`auftrag.hinweise`	object[]	بله
`auftrag.hinweise[].code`	string	بله
`auftrag.hinweise[].feld`	string \| null	بله
`auftrag.hinweise[].nachricht`	string	بله
`auftrag.erstellt_am`	string	بله	Eingang der Anfrage. ISO 8601, UTC.
`auftrag.abgeschlossen_am`	string \| null	بله
`hinweise`	object[]	بله
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
409 Schlüssel- oder Zustandskonflikt: productExists, productArchived, productBlocked, productMeterware, skuTaken, parentSkuLocked, parentSkuOfOther, ambiguousMatch.
422 Ungültige Angaben, mit den Codes des Katalog-Imports (z. B. required, colorUnknown, sizeNotInCategory, priceVariesByColor, noImages, eanInvalid) und dem JSON-Pfad in feld.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/products

Produkte

Deine Produkte, älteste Änderung zuerst, auch archivierte (status Archiviert), damit dein System Löschungen sieht. Meterware fehlt. Mit geaendert_seit nur seither geänderte – auch Bestandsänderungen zählen.

مجوز: produkte:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`seite (query)`	integer	خیر	Seite, ab 1.
`pro_seite (query)`	integer	خیر	Produkte pro Seite, höchstens 100.
`geaendert_seit (query)`	string (date-time)	خیر	Nur Produkte, die danach geändert wurden (ISO 8601 mit Zeitzone).

پاسخ‌ها

200 Eine Seite Produkte. – ProduktListe

فیلد	نوع	الزامی	توضیح
`seite`	integer	بله	(-9007199254740991–9007199254740991)
`pro_seite`	integer	بله	(-9007199254740991–9007199254740991)
`gesamt`	integer	بله	Produkte insgesamt (mit geaendert_seit: seither geänderte). (-9007199254740991–9007199254740991)
`produkte`	Produkt[]	بله
`produkte[].id`	string	بله	eveyamin-Produkt-ID.
`produkte[].artikelnummer`	string	بله	eveyamin-Artikelnummer.
`produkte[].uebergeordnete_sku`	string \| null	بله
`produkte[].status`	string	بله	Neue und geänderte Texte werden erst übersetzt; ohne eingerichteten Zahlungsanbieter bleibt das Produkt verborgen.مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`produkte[].titel`	string	بله
`produkte[].beschreibung`	string	بله
`produkte[].kategorie`	string	بله
`produkte[].rabattpreis`	number \| null	بله
`produkte[].versandkosten`	number \| null	بله
`produkte[].geaendert_am`	string	بله	Letzte Änderung am Produkt, auch am Bestand. ISO 8601, UTC.
`produkte[].varianten`	object[]	بله
`produkte[].varianten[].variant_id`	string	بله
`produkte[].varianten[].farbe`	string	بله
`produkte[].varianten[].groesse`	string	بله
`produkte[].varianten[].preis`	number	بله
`produkte[].varianten[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`produkte[].varianten[].sku`	string \| null	بله
`produkte[].varianten[].ean`	string \| null	بله
`produkte[].varianten[].bild_urls`	string[]	بله	Die Bilder dieser Farbe, bei eveyamin gespeichert.

400 geaendert_seit, seite oder pro_seite ungültig (invalidQuery).
401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/products/{id}

Ein Produkt

In der Form, die PUT annimmt: den Inhalt kannst du unverändert zurückschicken (dann: unveraendert).

مجوز: produkte:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.

پاسخ‌ها

200 Das Produkt. – Produkt

فیلد	نوع	الزامی	توضیح
`id`	string	بله	eveyamin-Produkt-ID.
`artikelnummer`	string	بله	eveyamin-Artikelnummer.
`uebergeordnete_sku`	string \| null	بله
`status`	string	بله	Neue und geänderte Texte werden erst übersetzt; ohne eingerichteten Zahlungsanbieter bleibt das Produkt verborgen.مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`titel`	string	بله
`beschreibung`	string	بله
`kategorie`	string	بله
`rabattpreis`	number \| null	بله
`versandkosten`	number \| null	بله
`geaendert_am`	string	بله	Letzte Änderung am Produkt, auch am Bestand. ISO 8601, UTC.
`varianten`	object[]	بله
`varianten[].variant_id`	string	بله
`varianten[].farbe`	string	بله
`varianten[].groesse`	string	بله
`varianten[].preis`	number	بله
`varianten[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`varianten[].sku`	string \| null	بله
`varianten[].ean`	string \| null	بله
`varianten[].bild_urls`	string[]	بله	Die Bilder dieser Farbe, bei eveyamin gespeichert.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solches Produkt von dir (productNotFound).
409 Meterware wird über die API noch nicht unterstützt (productMeterware).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

PUT/api/v1/products/{id}

Produkt ersetzen

Ein Produkt mit allen Farbe-×-Größe-Kombinationen (varianten, höchstens 500), geprüft nach denselben Regeln wie der Katalog-Import und das Produktformular, mit denselben Fehlercodes. Den Bestand bestehender Kombinationen ändert nur PATCH /products/{id}/stock: ein abweichender lagerbestand bleibt unberücksichtigt (Hinweis stockIgnored); neue Produkte und neue Kombinationen übernehmen ihn. Fehlende Kombinationen werden archiviert. Fehlen sku oder ean bei einer Variante, bleiben die gespeicherten. Bilder werden zu eveyamin geladen; eine schon geladene Adresse wird nicht erneut geladen, ein geändertes Bild braucht also eine neue Adresse. Dauert das Laden zu lange, antwortet der Aufruf mit 202 und einem Auftrag (/jobs/{id}); das Produkt wird geschrieben, sobald die Bilder da sind. Ein unverändertes Produkt wird nicht geschrieben und nicht neu übersetzt (unveraendert). Neue und geänderte Titel und Beschreibungen werden übersetzt, bevor das Produkt sichtbar wird. Gibt es {id} noch nicht und ist es die uebergeordnete_sku des Inhalts, wird das Produkt angelegt. Ein Produkt ohne Übergeordnete SKU bekommt sie über seine Artikelnummer als {id}; eine vorhandene ändert nur das Produktformular.

مجوز: produkte:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.

بدنه – ProduktAnfrage

فیلد	نوع	الزامی	توضیح
`uebergeordnete_sku`	string \| null	خیر	Deine Produktnummer, eindeutig in deinem Shop, max. 100 Zeichen. Pflicht beim Anlegen.
`titel`	string	بله	Max. 100 Zeichen.
`beschreibung`	string	بله	10 bis 10.000 Zeichen.
`kategorie`	string	بله	Vollständiger Pfad, z. B. „eve-Home > Bettwäsche > Bettwäsche-Sets“ (siehe /taxonomy).
`rabattpreis`	number \| string \| null	خیر
`versandkosten`	number \| string \| null	خیر
`varianten`	ProduktVarianteEingabe[]	بله
`varianten[].farbe`	string	بله	Farbe wie im Shop, z. B. „Weiß“ (siehe /taxonomy).
`varianten[].groesse`	string	بله	Größe aus der Größenliste der Kategorie, z. B. „M“ oder „200 x 200 cm“.
`varianten[].preis`	number \| string	بله	Preis dieser Variante in EUR, brutto. Preise dürfen sich nur je Größe unterscheiden; der niedrigste ist der Grundpreis.
`varianten[].lagerbestand`	number \| string	بله	Bestand, 0 bis 10.000. Gilt nur für neue Produkte und neue Kombinationen; den Bestand bestehender Kombinationen änderst du über /products/{id}/stock.
`varianten[].sku`	string \| null	خیر	Deine SKU dieser Kombination, eindeutig in deinem Shop, max. 64 Zeichen.
`varianten[].ean`	string \| null	خیر	EAN / GTIN (8, 12, 13 oder 14 Ziffern mit Prüfziffer). Fehlt der Schlüssel, bleibt die gespeicherte EAN; null löscht sie.
`varianten[].bild_urls`	string[]	خیر	Öffentliche https-Bildadressen. Ein Bild nur bei Varianten bestimmter Farben gehört zu diesen Farben, eines bei allen Farben gilt für alle; stehen alle Bilder nur bei einer Farbe (z. B. nur bei der ersten Variante), gelten sie für alle. Bekannte Adressen werden nicht neu geladen – ein geändertes Bild braucht eine neue Adresse.

پاسخ‌ها

200 Aktualisiert, oder unveraendert. – ProduktErgebnis

فیلد	نوع	الزامی	توضیح
`ergebnis`	string	بله	unveraendert: Das Produkt war schon so; nichts wurde geschrieben oder neu übersetzt.مقدارها: angelegt, aktualisiert, unveraendert
`produkt`	Produkt	بله
`produkt.id`	string	بله	eveyamin-Produkt-ID.
`produkt.artikelnummer`	string	بله	eveyamin-Artikelnummer.
`produkt.uebergeordnete_sku`	string \| null	بله
`produkt.status`	string	بله	Neue und geänderte Texte werden erst übersetzt; ohne eingerichteten Zahlungsanbieter bleibt das Produkt verborgen.مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`produkt.titel`	string	بله
`produkt.beschreibung`	string	بله
`produkt.kategorie`	string	بله
`produkt.rabattpreis`	number \| null	بله
`produkt.versandkosten`	number \| null	بله
`produkt.geaendert_am`	string	بله	Letzte Änderung am Produkt, auch am Bestand. ISO 8601, UTC.
`produkt.varianten`	object[]	بله
`produkt.varianten[].variant_id`	string	بله
`produkt.varianten[].farbe`	string	بله
`produkt.varianten[].groesse`	string	بله
`produkt.varianten[].preis`	number	بله
`produkt.varianten[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`produkt.varianten[].sku`	string \| null	بله
`produkt.varianten[].ean`	string \| null	بله
`produkt.varianten[].bild_urls`	string[]	بله	Die Bilder dieser Farbe, bei eveyamin gespeichert.
`hinweise`	object[]	بله	Z. B. korrigierte Schreibweisen, nicht geladene Bilder, ignorierter Bestand.
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله

201 Angelegt. – ProduktErgebnis

فیلد	نوع	الزامی	توضیح
`ergebnis`	string	بله	unveraendert: Das Produkt war schon so; nichts wurde geschrieben oder neu übersetzt.مقدارها: angelegt, aktualisiert, unveraendert
`produkt`	Produkt	بله
`produkt.id`	string	بله	eveyamin-Produkt-ID.
`produkt.artikelnummer`	string	بله	eveyamin-Artikelnummer.
`produkt.uebergeordnete_sku`	string \| null	بله
`produkt.status`	string	بله	Neue und geänderte Texte werden erst übersetzt; ohne eingerichteten Zahlungsanbieter bleibt das Produkt verborgen.مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`produkt.titel`	string	بله
`produkt.beschreibung`	string	بله
`produkt.kategorie`	string	بله
`produkt.rabattpreis`	number \| null	بله
`produkt.versandkosten`	number \| null	بله
`produkt.geaendert_am`	string	بله	Letzte Änderung am Produkt, auch am Bestand. ISO 8601, UTC.
`produkt.varianten`	object[]	بله
`produkt.varianten[].variant_id`	string	بله
`produkt.varianten[].farbe`	string	بله
`produkt.varianten[].groesse`	string	بله
`produkt.varianten[].preis`	number	بله
`produkt.varianten[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`produkt.varianten[].sku`	string \| null	بله
`produkt.varianten[].ean`	string \| null	بله
`produkt.varianten[].bild_urls`	string[]	بله	Die Bilder dieser Farbe, bei eveyamin gespeichert.
`hinweise`	object[]	بله	Z. B. korrigierte Schreibweisen, nicht geladene Bilder, ignorierter Bestand.
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله

202 Die Bilder werden noch geladen (Location: /api/v1/jobs/{id}). – ProduktInArbeit

فیلد	نوع	الزامی	توضیح
`ergebnis`	"in_arbeit"	بله
`auftrag`	Auftrag	بله
`auftrag.id`	string	بله
`auftrag.status`	string	بله	ersetzt: Eine neuere Anfrage für dasselbe Produkt kam dazwischen; dieser Auftrag wird nicht mehr geschrieben.مقدارها: wartet, in_arbeit, fertig, fehlgeschlagen, ersetzt
`auftrag.aktion`	string	بله	مقدارها: anlegen, aktualisieren
`auftrag.schluessel`	string	بله	Übergeordnete SKU des Produkts, oder seine Artikelnummer, wenn es keine hat.
`auftrag.bilder`	object	بله
`auftrag.bilder.gesamt`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.bilder.geladen`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.bilder.fehlgeschlagen`	integer	بله	(-9007199254740991–9007199254740991)
`auftrag.produkt`	object \| null	بله	Sobald das Produkt geschrieben ist.
`auftrag.produkt.id`	string	بله
`auftrag.produkt.artikelnummer`	string	بله
`auftrag.produkt.uebergeordnete_sku`	string \| null	بله
`auftrag.produkt.status`	string	بله	مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`auftrag.fehler`	string \| null	بله	Warum der Auftrag fehlgeschlagen ist.
`auftrag.hinweise`	object[]	بله
`auftrag.hinweise[].code`	string	بله
`auftrag.hinweise[].feld`	string \| null	بله
`auftrag.hinweise[].nachricht`	string	بله
`auftrag.erstellt_am`	string	بله	Eingang der Anfrage. ISO 8601, UTC.
`auftrag.abgeschlossen_am`	string \| null	بله
`hinweise`	object[]	بله
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solches Produkt von dir, und der Inhalt nennt {id} nicht als uebergeordnete_sku (productNotFound).
409 Schlüssel- oder Zustandskonflikt: productExists, productArchived, productBlocked, productMeterware, skuTaken, parentSkuLocked, parentSkuOfOther, ambiguousMatch.
422 Ungültige Angaben, mit den Codes des Katalog-Imports (z. B. required, colorUnknown, sizeNotInCategory, priceVariesByColor, noImages, eanInvalid) und dem JSON-Pfad in feld.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

DELETE/api/v1/products/{id}

Produkt archivieren

Archiviert das Produkt; es wird nicht gelöscht und kann im Dashboard wiederhergestellt werden. Wiederholbar (bereits_archiviert).

مجوز: produkte:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.

پاسخ‌ها

200 Archiviert. – ProduktArchiviert

فیلد	نوع	الزامی	توضیح
`ergebnis`	string	بله	مقدارها: archiviert, bereits_archiviert
`produkt`	object	بله
`produkt.id`	string	بله
`produkt.artikelnummer`	string	بله
`produkt.uebergeordnete_sku`	string \| null	بله
`produkt.status`	string	بله	مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solches Produkt von dir (productNotFound).
409 Das Produkt ist gesperrt (productBlocked).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/jobs/{id}

Auftrag

Stand eines Produktaufrufs, der mit 202 geantwortet hat: wartet, in_arbeit, fertig (mit dem Produkt), fehlgeschlagen (mit dem Grund) oder ersetzt (eine neuere Anfrage für dasselbe Produkt kam dazwischen).

مجوز: produkte:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	Auftrags-ID aus der 202-Antwort.

پاسخ‌ها

200 Der Auftrag. – Auftrag

فیلد	نوع	الزامی	توضیح
`id`	string	بله
`status`	string	بله	ersetzt: Eine neuere Anfrage für dasselbe Produkt kam dazwischen; dieser Auftrag wird nicht mehr geschrieben.مقدارها: wartet, in_arbeit, fertig, fehlgeschlagen, ersetzt
`aktion`	string	بله	مقدارها: anlegen, aktualisieren
`schluessel`	string	بله	Übergeordnete SKU des Produkts, oder seine Artikelnummer, wenn es keine hat.
`bilder`	object	بله
`bilder.gesamt`	integer	بله	(-9007199254740991–9007199254740991)
`bilder.geladen`	integer	بله	(-9007199254740991–9007199254740991)
`bilder.fehlgeschlagen`	integer	بله	(-9007199254740991–9007199254740991)
`produkt`	object \| null	بله	Sobald das Produkt geschrieben ist.
`produkt.id`	string	بله
`produkt.artikelnummer`	string	بله
`produkt.uebergeordnete_sku`	string \| null	بله
`produkt.status`	string	بله	مقدارها: Aktiv, Wird übersetzt, Wartet auf Zahlungsanbieter, Gesperrt, Archiviert
`fehler`	string \| null	بله	Warum der Auftrag fehlgeschlagen ist.
`hinweise`	object[]	بله
`hinweise[].code`	string	بله
`hinweise[].feld`	string \| null	بله
`hinweise[].nachricht`	string	بله
`erstellt_am`	string	بله	Eingang der Anfrage. ISO 8601, UTC.
`abgeschlossen_am`	string \| null	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solcher Auftrag von dir (jobNotFound).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

Bestand

Bestand lesen und setzen, ohne das Produkt anzufassen (WP3).

GET/api/v1/stock

Bestand aller Varianten

Jede aktive Variante mit Artikelnummer, Übergeordneter SKU, SKU, Farbe, Größe, gespeichertem Bestand und offenen Stück – zum Zuordnen deiner Artikel und zum Abgleich. Meterware fehlt (noch nicht in der API).

مجوز: bestand:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`seite (query)`	integer	خیر	Seite, ab 1.
`pro_seite (query)`	integer	خیر	Varianten pro Seite, höchstens 500.

پاسخ‌ها

200 Eine Seite Varianten. – BestandListe

فیلد	نوع	الزامی	توضیح
`seite`	integer	بله	(-9007199254740991–9007199254740991)
`pro_seite`	integer	بله	(-9007199254740991–9007199254740991)
`gesamt`	integer	بله	Varianten insgesamt. (-9007199254740991–9007199254740991)
`positionen`	object[]	بله
`positionen[].produkt_id`	string	بله
`positionen[].artikelnummer`	string	بله
`positionen[].uebergeordnete_sku`	string \| null	بله
`positionen[].sku`	string \| null	بله
`positionen[].ean`	string \| null	بله	EAN / GTIN der Variante, sonst null.
`positionen[].farbe`	string	بله
`positionen[].groesse`	string	بله
`positionen[].titel`	string	بله
`positionen[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`positionen[].offen`	integer	بله	Stück in offenen eveyamin-Bestellungen. (-9007199254740991–9007199254740991)
`positionen[].stand`	string \| null	بله	Zuletzt übernommener stand.
`positionen[].gesperrt`	boolean	بله	Das Produkt ist gesperrt; sein Bestand kann nicht geändert werden.

400 seite oder pro_seite ungültig (invalidQuery).
401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

PATCH/api/v1/stock

Bestand mehrerer Produkte setzen

Bis zu 500 Zeilen über alle Produkte, je über sku oder produkt + farbe + groesse. Gespeichert wird lagerbestand minus der Stück in offenen eveyamin-Bestellungen (reserviert, noch nicht erledigt und von deinem System noch nicht bestätigt), mindestens 0 – so werden Bestellungen, die dein System noch nicht kennt, nicht doppelt verkauft. Eine Bestellung, die du nach dem stand der Zeile bestätigt hast, zählt noch als offen: deine Zählung war älter. Sende daher stand mit. Jede Zeile hat ihr eigenes Ergebnis; eine fehlerhafte Zeile hält die anderen nicht auf. Unveränderte Werte werden nicht geschrieben.

مجوز: bestand:schreiben

بدنه – BestandAnfrage

فیلد	نوع	الزامی	توضیح
`positionen`	BestandZeile[]	بله
`positionen[].sku`	string	خیر	Deine SKU der Variante. Alternativ: produkt + farbe + groesse.
`positionen[].farbe`	string	خیر	Farbe wie im Shop, z. B. „Weiß“.
`positionen[].groesse`	string	خیر	Größe wie im Shop, z. B. „M“ oder „200 x 200 cm“.
`positionen[].lagerbestand`	integer	بله	Dein Bestand der Variante. Gespeichert wird dieser Wert abzüglich der offenen eveyamin-Bestellungen (siehe offen). (0–10000)
`positionen[].stand`	string (date-time)	خیر	Zeitpunkt deiner Zählung (ISO 8601 mit Zeitzone). Eine Zeile mit älterem stand als dem zuletzt übernommenen wird ignoriert (veraltet).
`positionen[].produkt`	string	خیر	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.

پاسخ‌ها

200 Ergebnis je Zeile. – BestandErgebnis

فیلد	نوع	الزامی	توضیح
`zusammenfassung`	object	بله
`zusammenfassung.ok`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.unveraendert`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.veraltet`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.fehler`	integer	بله	(-9007199254740991–9007199254740991)
`positionen`	object[]	بله
`positionen[].zeile`	integer	بله	Index der Zeile in positionen, ab 0. (-9007199254740991–9007199254740991)
`positionen[].status`	string	بله	ok = gespeichert, unveraendert = war schon so, veraltet = älterer stand, fehler = siehe fehler.مقدارها: ok, unveraendert, veraltet, fehler
`positionen[].produkt_id`	string	خیر
`positionen[].artikelnummer`	string	خیر
`positionen[].uebergeordnete_sku`	string \| null	خیر
`positionen[].sku`	string \| null	خیر
`positionen[].ean`	string \| null	خیر	EAN / GTIN der Variante, sonst null.
`positionen[].farbe`	string	خیر
`positionen[].groesse`	string	خیر
`positionen[].gesendet`	integer	خیر	Dein lagerbestand. (-9007199254740991–9007199254740991)
`positionen[].offen`	integer	خیر	Stück in offenen eveyamin-Bestellungen, die abgezogen wurden. (-9007199254740991–9007199254740991)
`positionen[].vorher`	integer	خیر	Gespeicherter Bestand vor dieser Anfrage. (-9007199254740991–9007199254740991)
`positionen[].lagerbestand`	integer	خیر	Gespeicherter Bestand jetzt: gesendet − offen, mindestens 0. (-9007199254740991–9007199254740991)
`positionen[].fehler`	object	خیر
`positionen[].fehler.code`	string	بله
`positionen[].fehler.feld`	string \| null	بله
`positionen[].fehler.nachricht`	string	بله
`positionen[].hinweise`	object[]	خیر	Z. B. eine korrigierte Schreibweise.
`positionen[].hinweise[].code`	string	بله
`positionen[].hinweise[].feld`	string \| null	بله
`positionen[].hinweise[].nachricht`	string	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
422 Kein { positionen: [...] }, leer, oder mehr als 500 Zeilen.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.
503 Der Bestand wird gerade an anderer Stelle geändert (busy); nichts wurde gespeichert, bitte wiederholen.

GET/api/v1/products/{id}/stock

Bestand eines Produkts

مجوز: bestand:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.
`seite (query)`	integer	خیر	Seite, ab 1.
`pro_seite (query)`	integer	خیر	Varianten pro Seite, höchstens 500.

پاسخ‌ها

200 Die Varianten des Produkts. – BestandListe

فیلد	نوع	الزامی	توضیح
`seite`	integer	بله	(-9007199254740991–9007199254740991)
`pro_seite`	integer	بله	(-9007199254740991–9007199254740991)
`gesamt`	integer	بله	Varianten insgesamt. (-9007199254740991–9007199254740991)
`positionen`	object[]	بله
`positionen[].produkt_id`	string	بله
`positionen[].artikelnummer`	string	بله
`positionen[].uebergeordnete_sku`	string \| null	بله
`positionen[].sku`	string \| null	بله
`positionen[].ean`	string \| null	بله	EAN / GTIN der Variante, sonst null.
`positionen[].farbe`	string	بله
`positionen[].groesse`	string	بله
`positionen[].titel`	string	بله
`positionen[].lagerbestand`	integer	بله	Gespeicherter, kaufbarer Bestand. (-9007199254740991–9007199254740991)
`positionen[].offen`	integer	بله	Stück in offenen eveyamin-Bestellungen. (-9007199254740991–9007199254740991)
`positionen[].stand`	string \| null	بله	Zuletzt übernommener stand.
`positionen[].gesperrt`	boolean	بله	Das Produkt ist gesperrt; sein Bestand kann nicht geändert werden.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solches Produkt bei dir (productNotFound).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

PATCH/api/v1/products/{id}/stock

Bestand eines Produkts setzen

Zeilen dieses Produkts, je über sku oder farbe + groesse. Gespeichert wird lagerbestand minus der Stück in offenen eveyamin-Bestellungen (reserviert, noch nicht erledigt und von deinem System noch nicht bestätigt), mindestens 0 – so werden Bestellungen, die dein System noch nicht kennt, nicht doppelt verkauft. Eine Bestellung, die du nach dem stand der Zeile bestätigt hast, zählt noch als offen: deine Zählung war älter. Sende daher stand mit. Jede Zeile hat ihr eigenes Ergebnis; eine fehlerhafte Zeile hält die anderen nicht auf. Unveränderte Werte werden nicht geschrieben.

مجوز: bestand:schreiben

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Produkt-ID, Übergeordnete SKU oder Artikelnummer.

بدنه – ProduktBestandAnfrage

فیلد	نوع	الزامی	توضیح
`positionen`	object[]	بله
`positionen[].sku`	string	خیر	Deine SKU der Variante. Alternativ: produkt + farbe + groesse.
`positionen[].farbe`	string	خیر	Farbe wie im Shop, z. B. „Weiß“.
`positionen[].groesse`	string	خیر	Größe wie im Shop, z. B. „M“ oder „200 x 200 cm“.
`positionen[].lagerbestand`	integer	بله	Dein Bestand der Variante. Gespeichert wird dieser Wert abzüglich der offenen eveyamin-Bestellungen (siehe offen). (0–10000)
`positionen[].stand`	string (date-time)	خیر	Zeitpunkt deiner Zählung (ISO 8601 mit Zeitzone). Eine Zeile mit älterem stand als dem zuletzt übernommenen wird ignoriert (veraltet).

پاسخ‌ها

200 Ergebnis je Zeile. – BestandErgebnis

فیلد	نوع	الزامی	توضیح
`zusammenfassung`	object	بله
`zusammenfassung.ok`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.unveraendert`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.veraltet`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.fehler`	integer	بله	(-9007199254740991–9007199254740991)
`positionen`	object[]	بله
`positionen[].zeile`	integer	بله	Index der Zeile in positionen, ab 0. (-9007199254740991–9007199254740991)
`positionen[].status`	string	بله	ok = gespeichert, unveraendert = war schon so, veraltet = älterer stand, fehler = siehe fehler.مقدارها: ok, unveraendert, veraltet, fehler
`positionen[].produkt_id`	string	خیر
`positionen[].artikelnummer`	string	خیر
`positionen[].uebergeordnete_sku`	string \| null	خیر
`positionen[].sku`	string \| null	خیر
`positionen[].ean`	string \| null	خیر	EAN / GTIN der Variante, sonst null.
`positionen[].farbe`	string	خیر
`positionen[].groesse`	string	خیر
`positionen[].gesendet`	integer	خیر	Dein lagerbestand. (-9007199254740991–9007199254740991)
`positionen[].offen`	integer	خیر	Stück in offenen eveyamin-Bestellungen, die abgezogen wurden. (-9007199254740991–9007199254740991)
`positionen[].vorher`	integer	خیر	Gespeicherter Bestand vor dieser Anfrage. (-9007199254740991–9007199254740991)
`positionen[].lagerbestand`	integer	خیر	Gespeicherter Bestand jetzt: gesendet − offen, mindestens 0. (-9007199254740991–9007199254740991)
`positionen[].fehler`	object	خیر
`positionen[].fehler.code`	string	بله
`positionen[].fehler.feld`	string \| null	بله
`positionen[].fehler.nachricht`	string	بله
`positionen[].hinweise`	object[]	خیر	Z. B. eine korrigierte Schreibweise.
`positionen[].hinweise[].code`	string	بله
`positionen[].hinweise[].feld`	string \| null	بله
`positionen[].hinweise[].nachricht`	string	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Kein solches Produkt bei dir (productNotFound).
422 Kein { positionen: [...] }, leer, oder mehr als 500 Zeilen.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.
503 Der Bestand wird gerade an anderer Stelle geändert (busy); nichts wurde gespeichert, bitte wiederholen.

Bestellungen

Bezahlte Bestellungen abrufen und bestätigen (WP4).

GET/api/v1/orders/new

Neue Bestellungen

Bezahlte Bestellungen mit Positionen in Bearbeitung, die dein System noch nicht bestätigt hat, älteste zuerst. Nur deine Positionen und nur bezahlte Bestellungen. Eine Bestellung bleibt in /orders/new, bis dein System sie mit /orders/{id}/acknowledge bestätigt – geht eine Antwort verloren, kommt sie beim nächsten Abruf wieder. Gleiche Bestellungen erkennst du an der bestellnummer.

مجوز: bestellungen:lesen

پارامترها

فیلد	نوع	الزامی	توضیح
`seite (query)`	integer	خیر	Seite, ab 1.
`pro_seite (query)`	integer	خیر	Bestellungen pro Seite, höchstens 100.

پاسخ‌ها

200 Eine Seite Bestellungen. – BestellListe

فیلد	نوع	الزامی	توضیح
`seite`	integer	بله	(-9007199254740991–9007199254740991)
`pro_seite`	integer	بله	(-9007199254740991–9007199254740991)
`gesamt`	integer	بله	Bestellungen insgesamt. (-9007199254740991–9007199254740991)
`bestellungen`	Bestellung[]	بله
`bestellungen[].id`	string	بله	eveyamin-Bestell-ID; in Pfaden geht auch die Bestellnummer.
`bestellungen[].bestellnummer`	integer	بله	(-9007199254740991–9007199254740991)
`bestellungen[].bestelldatum`	string	بله	Wann der Käufer bestellt hat. ISO 8601, UTC.
`bestellungen[].status`	string	بله	مقدارها: Bezahlt, Versendet, Abgeschlossen, Storniert, Erstattet, Rückbuchung
`bestellungen[].versandart`	string	بله	مقدارها: Standardversand, Expressversand
`bestellungen[].bestaetigt_am`	string \| null	بله
`bestellungen[].geaendert_am`	string	بله	Letzte Änderung eines Status deiner Positionen oder der Bestellung. ISO 8601, UTC.
`bestellungen[].lieferadresse`	Lieferadresse	بله	Wohin das Paket geht. Die E-Mail-Adresse des Käufers wird nicht weitergegeben.
`bestellungen[].lieferadresse.vorname`	string	بله
`bestellungen[].lieferadresse.nachname`	string	بله
`bestellungen[].lieferadresse.firma`	string \| null	بله
`bestellungen[].lieferadresse.strasse`	string	بله	Straße und Hausnummer.
`bestellungen[].lieferadresse.plz`	string	بله
`bestellungen[].lieferadresse.ort`	string	بله
`bestellungen[].lieferadresse.land`	string	بله	Wie vom Käufer eingegeben, z. B. „Deutschland“ (noch kein Ländercode).
`bestellungen[].lieferadresse.telefon`	string \| null	بله	Für den Versanddienstleister; optional beim Kauf.
`bestellungen[].summen`	object	بله	Nur deine Positionen, in EUR, brutto.
`bestellungen[].summen.waren`	number	بله
`bestellungen[].summen.versandkosten`	number	بله
`bestellungen[].summen.gesamt`	number	بله
`bestellungen[].positionen`	BestellPosition[]	بله	Nur deine Positionen; andere Händler derselben Bestellung fehlen.
`bestellungen[].positionen[].position_id`	string	بله	eveyamin-ID der Bestellposition.
`bestellungen[].positionen[].produkt_id`	string	بله
`bestellungen[].positionen[].variant_id`	string \| null	بله
`bestellungen[].positionen[].artikelnummer`	string \| null	بله
`bestellungen[].positionen[].uebergeordnete_sku`	string \| null	بله	Aktuelle Übergeordnete SKU des Produkts.
`bestellungen[].positionen[].sku`	string \| null	بله	Aktuelle SKU der Variante, sonst die beim Kauf gespeicherte.
`bestellungen[].positionen[].ean`	string \| null	بله	Aktuelle EAN / GTIN der Variante, sonst null.
`bestellungen[].positionen[].titel`	string	بله	Produkttitel zum Zeitpunkt des Kaufs.
`bestellungen[].positionen[].farbe`	string \| null	بله
`bestellungen[].positionen[].groesse`	string \| null	بله	Größe wie im Shop, oder „Maßanfertigung“.
`bestellungen[].positionen[].menge`	number	بله	Stückzahl, bei Meterware Meter.
`bestellungen[].positionen[].einheit`	string	بله	مقدارها: Stück, Meter
`bestellungen[].positionen[].einzelpreis`	number	بله	Bezahlter Preis je Stück bzw. Meter in EUR, brutto.
`bestellungen[].positionen[].summe`	number	بله	Bezahlter Warenwert der Position in EUR, brutto, ohne Versand.
`bestellungen[].positionen[].versandkosten`	number	بله	Versandkosten in EUR, brutto. Sie stehen bei einer Position je Bestellung.
`bestellungen[].positionen[].lieferstatus`	string	بله	مقدارها: In Bearbeitung, Versendet, Abgeschlossen, Storniert, Zahlung ausstehend, Erstattet, Fehlgeschlagen
`bestellungen[].positionen[].bestaetigt_am`	string \| null	بله
`bestellungen[].positionen[].sendung_id`	string \| null	بله	Das Paket, in dem die Position versendet wurde (sendungen[].id), sonst null.
`bestellungen[].positionen[].versendet_am`	string \| null	بله
`bestellungen[].positionen[].massanfertigung`	Massanfertigung \| null	بله	Die Körpermaße bei einer Maßanfertigung, sonst null.
`bestellungen[].positionen[].massanfertigung.einheit`	string	بله	So, wie der Käufer gemessen hat; nicht umgerechnet.مقدارها: cm, Zoll
`bestellungen[].positionen[].massanfertigung.brustumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.taillenumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.hueftumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.koerpergroesse`	number	بله	Barfuß.
`bestellungen[].positionen[].massanfertigung.schluesselbein_boden`	number	بله	Vom Schlüsselbein bis zum Boden.
`bestellungen[].positionen[].massanfertigung.schulterlaenge`	number	بله
`bestellungen[].positionen[].massanfertigung.extralaenge`	number \| null	بله
`bestellungen[].sendungen`	Sendung[]	بله	Deine Pakete dieser Bestellung, ältestes zuerst.
`bestellungen[].sendungen[].id`	string	بله
`bestellungen[].sendungen[].versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`bestellungen[].sendungen[].sendungsnummer`	string	بله	Ohne Leerzeichen, in Großbuchstaben.
`bestellungen[].sendungen[].tracking_url`	string \| null	بله	Link zur Sendungsverfolgung; null bei „Sonstige“ ohne eigenen Link.
`bestellungen[].sendungen[].versendet_am`	string	بله	Wann das Paket gemeldet wurde. ISO 8601, UTC.
`bestellungen[].sendungen[].positionen`	string[]	بله	position_id der Positionen in diesem Paket.

400 seite oder pro_seite ungültig (invalidQuery).
401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/orders

Geänderte Bestellungen

Deine Bestellungen, deren Status oder Lieferstatus sich nach geaendert_seit geändert hat (ohne Parameter alle), älteste Änderung zuerst – so erfährt dein System nach dem Import von Stornierungen und Erstattungen. Merke dir das letzte geaendert_am und frage mit etwas Überlappung erneut. Nur deine Positionen und nur bezahlte Bestellungen. Eine Bestellung bleibt in /orders/new, bis dein System sie mit /orders/{id}/acknowledge bestätigt – geht eine Antwort verloren, kommt sie beim nächsten Abruf wieder. Gleiche Bestellungen erkennst du an der bestellnummer.

مجوز: bestellungen:lesen

پارامترها

فیلد	نوع	الزامی	توضیح
`geaendert_seit (query)`	string (date-time)	خیر	Zeitpunkt nach ISO 8601 mit Zeitzone, z. B. 2026-10-07T09:15:00Z.
`seite (query)`	integer	خیر	Seite, ab 1.
`pro_seite (query)`	integer	خیر	Bestellungen pro Seite, höchstens 100.

پاسخ‌ها

200 Eine Seite Bestellungen. – BestellListe

فیلد	نوع	الزامی	توضیح
`seite`	integer	بله	(-9007199254740991–9007199254740991)
`pro_seite`	integer	بله	(-9007199254740991–9007199254740991)
`gesamt`	integer	بله	Bestellungen insgesamt. (-9007199254740991–9007199254740991)
`bestellungen`	Bestellung[]	بله
`bestellungen[].id`	string	بله	eveyamin-Bestell-ID; in Pfaden geht auch die Bestellnummer.
`bestellungen[].bestellnummer`	integer	بله	(-9007199254740991–9007199254740991)
`bestellungen[].bestelldatum`	string	بله	Wann der Käufer bestellt hat. ISO 8601, UTC.
`bestellungen[].status`	string	بله	مقدارها: Bezahlt, Versendet, Abgeschlossen, Storniert, Erstattet, Rückbuchung
`bestellungen[].versandart`	string	بله	مقدارها: Standardversand, Expressversand
`bestellungen[].bestaetigt_am`	string \| null	بله
`bestellungen[].geaendert_am`	string	بله	Letzte Änderung eines Status deiner Positionen oder der Bestellung. ISO 8601, UTC.
`bestellungen[].lieferadresse`	Lieferadresse	بله	Wohin das Paket geht. Die E-Mail-Adresse des Käufers wird nicht weitergegeben.
`bestellungen[].lieferadresse.vorname`	string	بله
`bestellungen[].lieferadresse.nachname`	string	بله
`bestellungen[].lieferadresse.firma`	string \| null	بله
`bestellungen[].lieferadresse.strasse`	string	بله	Straße und Hausnummer.
`bestellungen[].lieferadresse.plz`	string	بله
`bestellungen[].lieferadresse.ort`	string	بله
`bestellungen[].lieferadresse.land`	string	بله	Wie vom Käufer eingegeben, z. B. „Deutschland“ (noch kein Ländercode).
`bestellungen[].lieferadresse.telefon`	string \| null	بله	Für den Versanddienstleister; optional beim Kauf.
`bestellungen[].summen`	object	بله	Nur deine Positionen, in EUR, brutto.
`bestellungen[].summen.waren`	number	بله
`bestellungen[].summen.versandkosten`	number	بله
`bestellungen[].summen.gesamt`	number	بله
`bestellungen[].positionen`	BestellPosition[]	بله	Nur deine Positionen; andere Händler derselben Bestellung fehlen.
`bestellungen[].positionen[].position_id`	string	بله	eveyamin-ID der Bestellposition.
`bestellungen[].positionen[].produkt_id`	string	بله
`bestellungen[].positionen[].variant_id`	string \| null	بله
`bestellungen[].positionen[].artikelnummer`	string \| null	بله
`bestellungen[].positionen[].uebergeordnete_sku`	string \| null	بله	Aktuelle Übergeordnete SKU des Produkts.
`bestellungen[].positionen[].sku`	string \| null	بله	Aktuelle SKU der Variante, sonst die beim Kauf gespeicherte.
`bestellungen[].positionen[].ean`	string \| null	بله	Aktuelle EAN / GTIN der Variante, sonst null.
`bestellungen[].positionen[].titel`	string	بله	Produkttitel zum Zeitpunkt des Kaufs.
`bestellungen[].positionen[].farbe`	string \| null	بله
`bestellungen[].positionen[].groesse`	string \| null	بله	Größe wie im Shop, oder „Maßanfertigung“.
`bestellungen[].positionen[].menge`	number	بله	Stückzahl, bei Meterware Meter.
`bestellungen[].positionen[].einheit`	string	بله	مقدارها: Stück, Meter
`bestellungen[].positionen[].einzelpreis`	number	بله	Bezahlter Preis je Stück bzw. Meter in EUR, brutto.
`bestellungen[].positionen[].summe`	number	بله	Bezahlter Warenwert der Position in EUR, brutto, ohne Versand.
`bestellungen[].positionen[].versandkosten`	number	بله	Versandkosten in EUR, brutto. Sie stehen bei einer Position je Bestellung.
`bestellungen[].positionen[].lieferstatus`	string	بله	مقدارها: In Bearbeitung, Versendet, Abgeschlossen, Storniert, Zahlung ausstehend, Erstattet, Fehlgeschlagen
`bestellungen[].positionen[].bestaetigt_am`	string \| null	بله
`bestellungen[].positionen[].sendung_id`	string \| null	بله	Das Paket, in dem die Position versendet wurde (sendungen[].id), sonst null.
`bestellungen[].positionen[].versendet_am`	string \| null	بله
`bestellungen[].positionen[].massanfertigung`	Massanfertigung \| null	بله	Die Körpermaße bei einer Maßanfertigung, sonst null.
`bestellungen[].positionen[].massanfertigung.einheit`	string	بله	So, wie der Käufer gemessen hat; nicht umgerechnet.مقدارها: cm, Zoll
`bestellungen[].positionen[].massanfertigung.brustumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.taillenumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.hueftumfang`	number	بله
`bestellungen[].positionen[].massanfertigung.koerpergroesse`	number	بله	Barfuß.
`bestellungen[].positionen[].massanfertigung.schluesselbein_boden`	number	بله	Vom Schlüsselbein bis zum Boden.
`bestellungen[].positionen[].massanfertigung.schulterlaenge`	number	بله
`bestellungen[].positionen[].massanfertigung.extralaenge`	number \| null	بله
`bestellungen[].sendungen`	Sendung[]	بله	Deine Pakete dieser Bestellung, ältestes zuerst.
`bestellungen[].sendungen[].id`	string	بله
`bestellungen[].sendungen[].versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`bestellungen[].sendungen[].sendungsnummer`	string	بله	Ohne Leerzeichen, in Großbuchstaben.
`bestellungen[].sendungen[].tracking_url`	string \| null	بله	Link zur Sendungsverfolgung; null bei „Sonstige“ ohne eigenen Link.
`bestellungen[].sendungen[].versendet_am`	string	بله	Wann das Paket gemeldet wurde. ISO 8601, UTC.
`bestellungen[].sendungen[].positionen`	string[]	بله	position_id der Positionen in diesem Paket.

400 geaendert_seit, seite oder pro_seite ungültig (invalidQuery).
401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

GET/api/v1/orders/{id}

Eine Bestellung

مجوز: bestellungen:lesen

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Bestell-ID oder Bestellnummer.

پاسخ‌ها

200 Die Bestellung mit deinen Positionen. – Bestellung

فیلد	نوع	الزامی	توضیح
`id`	string	بله	eveyamin-Bestell-ID; in Pfaden geht auch die Bestellnummer.
`bestellnummer`	integer	بله	(-9007199254740991–9007199254740991)
`bestelldatum`	string	بله	Wann der Käufer bestellt hat. ISO 8601, UTC.
`status`	string	بله	مقدارها: Bezahlt, Versendet, Abgeschlossen, Storniert, Erstattet, Rückbuchung
`versandart`	string	بله	مقدارها: Standardversand, Expressversand
`bestaetigt_am`	string \| null	بله
`geaendert_am`	string	بله	Letzte Änderung eines Status deiner Positionen oder der Bestellung. ISO 8601, UTC.
`lieferadresse`	Lieferadresse	بله	Wohin das Paket geht. Die E-Mail-Adresse des Käufers wird nicht weitergegeben.
`lieferadresse.vorname`	string	بله
`lieferadresse.nachname`	string	بله
`lieferadresse.firma`	string \| null	بله
`lieferadresse.strasse`	string	بله	Straße und Hausnummer.
`lieferadresse.plz`	string	بله
`lieferadresse.ort`	string	بله
`lieferadresse.land`	string	بله	Wie vom Käufer eingegeben, z. B. „Deutschland“ (noch kein Ländercode).
`lieferadresse.telefon`	string \| null	بله	Für den Versanddienstleister; optional beim Kauf.
`summen`	object	بله	Nur deine Positionen, in EUR, brutto.
`summen.waren`	number	بله
`summen.versandkosten`	number	بله
`summen.gesamt`	number	بله
`positionen`	BestellPosition[]	بله	Nur deine Positionen; andere Händler derselben Bestellung fehlen.
`positionen[].position_id`	string	بله	eveyamin-ID der Bestellposition.
`positionen[].produkt_id`	string	بله
`positionen[].variant_id`	string \| null	بله
`positionen[].artikelnummer`	string \| null	بله
`positionen[].uebergeordnete_sku`	string \| null	بله	Aktuelle Übergeordnete SKU des Produkts.
`positionen[].sku`	string \| null	بله	Aktuelle SKU der Variante, sonst die beim Kauf gespeicherte.
`positionen[].ean`	string \| null	بله	Aktuelle EAN / GTIN der Variante, sonst null.
`positionen[].titel`	string	بله	Produkttitel zum Zeitpunkt des Kaufs.
`positionen[].farbe`	string \| null	بله
`positionen[].groesse`	string \| null	بله	Größe wie im Shop, oder „Maßanfertigung“.
`positionen[].menge`	number	بله	Stückzahl, bei Meterware Meter.
`positionen[].einheit`	string	بله	مقدارها: Stück, Meter
`positionen[].einzelpreis`	number	بله	Bezahlter Preis je Stück bzw. Meter in EUR, brutto.
`positionen[].summe`	number	بله	Bezahlter Warenwert der Position in EUR, brutto, ohne Versand.
`positionen[].versandkosten`	number	بله	Versandkosten in EUR, brutto. Sie stehen bei einer Position je Bestellung.
`positionen[].lieferstatus`	string	بله	مقدارها: In Bearbeitung, Versendet, Abgeschlossen, Storniert, Zahlung ausstehend, Erstattet, Fehlgeschlagen
`positionen[].bestaetigt_am`	string \| null	بله
`positionen[].sendung_id`	string \| null	بله	Das Paket, in dem die Position versendet wurde (sendungen[].id), sonst null.
`positionen[].versendet_am`	string \| null	بله
`positionen[].massanfertigung`	Massanfertigung \| null	بله	Die Körpermaße bei einer Maßanfertigung, sonst null.
`positionen[].massanfertigung.einheit`	string	بله	So, wie der Käufer gemessen hat; nicht umgerechnet.مقدارها: cm, Zoll
`positionen[].massanfertigung.brustumfang`	number	بله
`positionen[].massanfertigung.taillenumfang`	number	بله
`positionen[].massanfertigung.hueftumfang`	number	بله
`positionen[].massanfertigung.koerpergroesse`	number	بله	Barfuß.
`positionen[].massanfertigung.schluesselbein_boden`	number	بله	Vom Schlüsselbein bis zum Boden.
`positionen[].massanfertigung.schulterlaenge`	number	بله
`positionen[].massanfertigung.extralaenge`	number \| null	بله
`sendungen`	Sendung[]	بله	Deine Pakete dieser Bestellung, ältestes zuerst.
`sendungen[].id`	string	بله
`sendungen[].versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`sendungen[].sendungsnummer`	string	بله	Ohne Leerzeichen, in Großbuchstaben.
`sendungen[].tracking_url`	string \| null	بله	Link zur Sendungsverfolgung; null bei „Sonstige“ ohne eigenen Link.
`sendungen[].versendet_am`	string	بله	Wann das Paket gemeldet wurde. ISO 8601, UTC.
`sendungen[].positionen`	string[]	بله	position_id der Positionen in diesem Paket.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Keine solche bezahlte Bestellung mit Positionen von dir (orderNotFound).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

POST/api/v1/orders/{id}/acknowledge

Bestellung bestätigen

Dein System hat die Bestellung übernommen: Sie verschwindet aus /orders/new und wird bei Bestandsmeldungen nicht mehr abgezogen. Wiederholbar; ein zweiter Aufruf ändert nichts (bereits_bestaetigt).

مجوز: bestellungen:lesen

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Bestell-ID oder Bestellnummer.

پاسخ‌ها

200 Bestätigt. – Bestaetigung

فیلد	نوع	الزامی	توضیح
`id`	string	بله
`bestellnummer`	integer	بله	(-9007199254740991–9007199254740991)
`bestaetigt_am`	string	بله	Wann die Bestellung zum ersten Mal bestätigt wurde. ISO 8601, UTC.
`bereits_bestaetigt`	boolean	بله	true: war schon bestätigt; nichts hat sich geändert.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Keine solche bezahlte Bestellung mit Positionen von dir (orderNotFound).
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

POST/api/v1/orders/acknowledge

Mehrere Bestellungen bestätigen

Bis zu 100 Bestellungen auf einmal, je über Bestell-ID oder Bestellnummer; ein Ergebnis je Eintrag.

مجوز: bestellungen:lesen

بدنه – BestaetigungAnfrage

فیلد	نوع	الزامی	توضیح
`bestellungen`	string \| integer[]	بله	Bestell-IDs oder Bestellnummern.

پاسخ‌ها

200 Ergebnis je Eintrag. – BestaetigungErgebnis

فیلد	نوع	الزامی	توضیح
`zusammenfassung`	object	بله
`zusammenfassung.ok`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.bereits_bestaetigt`	integer	بله	(-9007199254740991–9007199254740991)
`zusammenfassung.fehler`	integer	بله	(-9007199254740991–9007199254740991)
`bestellungen`	object[]	بله
`bestellungen[].zeile`	integer	بله	Index in bestellungen, ab 0. (-9007199254740991–9007199254740991)
`bestellungen[].status`	string	بله	مقدارها: ok, bereits_bestaetigt, fehler
`bestellungen[].id`	string	خیر
`bestellungen[].bestellnummer`	integer	خیر	(-9007199254740991–9007199254740991)
`bestellungen[].bestaetigt_am`	string	خیر	Wann die Bestellung zum ersten Mal bestätigt wurde. ISO 8601, UTC.
`bestellungen[].fehler`	object	خیر
`bestellungen[].fehler.code`	string	بله
`bestellungen[].fehler.feld`	string \| null	بله
`bestellungen[].fehler.nachricht`	string	بله

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
422 Kein { bestellungen: [...] }, leer, oder mehr als 100 Einträge.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

Versand

Pakete mit Sendungsnummer melden; die Bestellung wird „Versendet“ (WP5).

POST/api/v1/orders/{id}/fulfill

Versand melden

Ein Paket deiner Positionen: Versanddienstleister, Sendungsnummer und die Positionen darin (ohne positionen: alle deine Positionen „In Bearbeitung“). Die Positionen werden „Versendet“, der Käufer bekommt eine E-Mail mit dem Link zur Sendungsverfolgung, und die Bestellung gilt als bestätigt. Mehrere Pakete: ein Aufruf je Sendungsnummer. Dieselbe Sendungsnummer noch einmal ist dasselbe Paket: Nichts passiert doppelt, neue Positionen kommen hinzu. Geht eine Position nicht, wird nichts versendet.

مجوز: bestellungen:versenden

پارامترها

فیلد	نوع	الزامی	توضیح
`id (path)`	string	بله	eveyamin-Bestell-ID oder Bestellnummer.

بدنه – VersandAnfrage

فیلد	نوع	الزامی	توضیح
`versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`sendungsnummer`	string	بله	Gespeichert ohne Leerzeichen und in Großbuchstaben: 4–40 Zeichen aus A–Z, 0–9 und -.
`tracking_url`	string \| null	خیر	Eigener https-Link. Ohne ihn baut eveyamin den Link des Versanddienstleisters (bei „Sonstige“ gibt es keinen).
`positionen`	string[]	خیر	position_id der Positionen im Paket. Ohne: alle deine Positionen „In Bearbeitung“.

پاسخ‌ها

200 Gemeldet, oder schon so gemeldet (bereits_erfasst). – VersandErgebnis

فیلد	نوع	الزامی	توضیح
`bereits_erfasst`	boolean	بله	true: Dieses Paket war mit diesen Positionen schon gemeldet; nichts hat sich geändert, keine Mail.
`sendung`	Sendung	بله	Ein Paket: ganze Positionen, eine Sendungsnummer.
`sendung.id`	string	بله
`sendung.versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`sendung.sendungsnummer`	string	بله	Ohne Leerzeichen, in Großbuchstaben.
`sendung.tracking_url`	string \| null	بله	Link zur Sendungsverfolgung; null bei „Sonstige“ ohne eigenen Link.
`sendung.versendet_am`	string	بله	Wann das Paket gemeldet wurde. ISO 8601, UTC.
`sendung.positionen`	string[]	بله	position_id der Positionen in diesem Paket.
`bestellung`	Bestellung	بله
`bestellung.id`	string	بله	eveyamin-Bestell-ID; in Pfaden geht auch die Bestellnummer.
`bestellung.bestellnummer`	integer	بله	(-9007199254740991–9007199254740991)
`bestellung.bestelldatum`	string	بله	Wann der Käufer bestellt hat. ISO 8601, UTC.
`bestellung.status`	string	بله	مقدارها: Bezahlt, Versendet, Abgeschlossen, Storniert, Erstattet, Rückbuchung
`bestellung.versandart`	string	بله	مقدارها: Standardversand, Expressversand
`bestellung.bestaetigt_am`	string \| null	بله
`bestellung.geaendert_am`	string	بله	Letzte Änderung eines Status deiner Positionen oder der Bestellung. ISO 8601, UTC.
`bestellung.lieferadresse`	Lieferadresse	بله	Wohin das Paket geht. Die E-Mail-Adresse des Käufers wird nicht weitergegeben.
`bestellung.lieferadresse.vorname`	string	بله
`bestellung.lieferadresse.nachname`	string	بله
`bestellung.lieferadresse.firma`	string \| null	بله
`bestellung.lieferadresse.strasse`	string	بله	Straße und Hausnummer.
`bestellung.lieferadresse.plz`	string	بله
`bestellung.lieferadresse.ort`	string	بله
`bestellung.lieferadresse.land`	string	بله	Wie vom Käufer eingegeben, z. B. „Deutschland“ (noch kein Ländercode).
`bestellung.lieferadresse.telefon`	string \| null	بله	Für den Versanddienstleister; optional beim Kauf.
`bestellung.summen`	object	بله	Nur deine Positionen, in EUR, brutto.
`bestellung.summen.waren`	number	بله
`bestellung.summen.versandkosten`	number	بله
`bestellung.summen.gesamt`	number	بله
`bestellung.positionen`	BestellPosition[]	بله	Nur deine Positionen; andere Händler derselben Bestellung fehlen.
`bestellung.positionen[].position_id`	string	بله	eveyamin-ID der Bestellposition.
`bestellung.positionen[].produkt_id`	string	بله
`bestellung.positionen[].variant_id`	string \| null	بله
`bestellung.positionen[].artikelnummer`	string \| null	بله
`bestellung.positionen[].uebergeordnete_sku`	string \| null	بله	Aktuelle Übergeordnete SKU des Produkts.
`bestellung.positionen[].sku`	string \| null	بله	Aktuelle SKU der Variante, sonst die beim Kauf gespeicherte.
`bestellung.positionen[].ean`	string \| null	بله	Aktuelle EAN / GTIN der Variante, sonst null.
`bestellung.positionen[].titel`	string	بله	Produkttitel zum Zeitpunkt des Kaufs.
`bestellung.positionen[].farbe`	string \| null	بله
`bestellung.positionen[].groesse`	string \| null	بله	Größe wie im Shop, oder „Maßanfertigung“.
`bestellung.positionen[].menge`	number	بله	Stückzahl, bei Meterware Meter.
`bestellung.positionen[].einheit`	string	بله	مقدارها: Stück, Meter
`bestellung.positionen[].einzelpreis`	number	بله	Bezahlter Preis je Stück bzw. Meter in EUR, brutto.
`bestellung.positionen[].summe`	number	بله	Bezahlter Warenwert der Position in EUR, brutto, ohne Versand.
`bestellung.positionen[].versandkosten`	number	بله	Versandkosten in EUR, brutto. Sie stehen bei einer Position je Bestellung.
`bestellung.positionen[].lieferstatus`	string	بله	مقدارها: In Bearbeitung, Versendet, Abgeschlossen, Storniert, Zahlung ausstehend, Erstattet, Fehlgeschlagen
`bestellung.positionen[].bestaetigt_am`	string \| null	بله
`bestellung.positionen[].sendung_id`	string \| null	بله	Das Paket, in dem die Position versendet wurde (sendungen[].id), sonst null.
`bestellung.positionen[].versendet_am`	string \| null	بله
`bestellung.positionen[].massanfertigung`	Massanfertigung \| null	بله	Die Körpermaße bei einer Maßanfertigung, sonst null.
`bestellung.positionen[].massanfertigung.einheit`	string	بله	So, wie der Käufer gemessen hat; nicht umgerechnet.مقدارها: cm, Zoll
`bestellung.positionen[].massanfertigung.brustumfang`	number	بله
`bestellung.positionen[].massanfertigung.taillenumfang`	number	بله
`bestellung.positionen[].massanfertigung.hueftumfang`	number	بله
`bestellung.positionen[].massanfertigung.koerpergroesse`	number	بله	Barfuß.
`bestellung.positionen[].massanfertigung.schluesselbein_boden`	number	بله	Vom Schlüsselbein bis zum Boden.
`bestellung.positionen[].massanfertigung.schulterlaenge`	number	بله
`bestellung.positionen[].massanfertigung.extralaenge`	number \| null	بله
`bestellung.sendungen`	Sendung[]	بله	Deine Pakete dieser Bestellung, ältestes zuerst.
`bestellung.sendungen[].id`	string	بله
`bestellung.sendungen[].versanddienstleister`	string	بله	مقدارها: DHL, DPD, Hermes, GLS, UPS, Deutsche Post, Sonstige
`bestellung.sendungen[].sendungsnummer`	string	بله	Ohne Leerzeichen, in Großbuchstaben.
`bestellung.sendungen[].tracking_url`	string \| null	بله	Link zur Sendungsverfolgung; null bei „Sonstige“ ohne eigenen Link.
`bestellung.sendungen[].versendet_am`	string	بله	Wann das Paket gemeldet wurde. ISO 8601, UTC.
`bestellung.sendungen[].positionen`	string[]	بله	position_id der Positionen in diesem Paket.

401 Kein, ungültiger oder widerrufener Schlüssel (keyMissing, keyInvalid, keyWrongEnvironment).
403 Dem Schlüssel fehlt die Berechtigung (scopeMissing), der Shop ist dafür noch nicht freigegeben (registrationNotApproved) oder die API ist für deinen Shop noch nicht freigeschaltet (apiNotEnabled).
404 Keine solche bezahlte Bestellung mit Positionen von dir (orderNotFound).
409 Die Bestellung ist nicht mehr bezahlt, z. B. erstattet (orderNotShippable), oder keine deiner Positionen ist mehr „In Bearbeitung“ (nothingToShip).
422 Ungültige Angaben (invalidCarrier, invalidTrackingNumber, invalidTrackingUrl, invalidBody) oder Positionen, die sich nicht versenden lassen (lineNotFound, lineNotShippable, lineInOtherShipment) – dann wurde nichts versendet.
429 Mehr als 120 Anfragen pro Minute und Schlüssel (rateLimited). Siehe Header Retry-After.

نسخه‌ها و تماس

API نسخه‌بندی شده است (/api/v1). فیلدها و فراخوانی‌های تازه در همان v1 اضافه می‌شوند – پس فیلدهایی را که نمی‌شناسید نادیده بگیرید. هر تغییری که اتصال‌های موجود را از کار بیندازد فقط در v2 می‌آید و مدت‌ها پیش از آن اعلام می‌شود.

پرسش‌ها دربارهٔ اتصال: info@eveyamin.com.

پشتیبانی فنی

اطلاعات بالا باید برای تیم فنی شما کافی باشد تا یکپارچه‌سازی را کامل کند. اگر به پشتیبانی بیشتری نیاز دارید، شریک فناوری ما با کمال میل در یکپارچه‌سازی به شما کمک می‌کند.