واجهة البائعين البرمجية

اربط نظام إدارة المخزون أو برنامج متجرك أو مورّد الدروبشيبينغ مباشرةً بمتجرك على ⁦eveyamin⁩: أنشئ المنتجات وحدّثها، وزامن المخزون خلال ثوانٍ، واجلب الطلبات المدفوعة، وأبلغ عن الشحنات.

إنشاء مفتاح API ملف OpenAPI English version

البدء

واجهة البائعين البرمجية هي واجهة 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 كل فئة مع مقاساتها وكل لون. تصحّح الواجهة الفروق الصغيرة بنفسها (weiss ← Weiß، 200x200 ← 200 x 200 cm) وتذكرها كملاحظات. اربط الأسماء الخاصة بنظام مخزونك مرة واحدة في استيراد CSV؛ وتسري هذه المطابقة على الواجهة البرمجية أيضًا.

الحدود

البند	الحد
طلبات API لكل مفتاح	120 في الدقيقة، ثم 429 مع `Retry-After`
حجم الطلب	1024 KB
أسطر لكل استدعاء مخزون	500
متغيرات لكل منتج	500
صور لكل منتج	20
منتجات في الصفحة الواحدة	100
طلبات في الصفحة الواحدة	100

كل رد بصيغة JSON ولا يُخزَّن مؤقتًا أبدًا. والاستدعاءات من المتصفح (CORS) غير مسموح بها.

المنتجات

يتكون المنتج من بياناته ومن متغيراته (اللون × المقاس). القواعد هي قواعد نموذج المنتج واستيراد CSV: ما يرفضانه ترفضه الواجهة البرمجية أيضًا – وبالرموز نفسها. وأسماء الحقول هي أسماء أعمدة قالب 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») ثم تُنشر.

الصور

تُنزَّل الصور أثناء الاستدعاء. إذا استغرق ذلك وقتًا طويلًا ترد الواجهة بـ 202 مع مهمة (Location: /api/v1/jobs/{id}). استعلم عن المهمة حتى تصبح fertig (منتهية)؛ ولا يُحفظ المنتج إلا بعد وصول صوره.
يُنزَّل كل عنوان صورة مرة واحدة. لذا تحتاج الصورة المعدّلة إلى عنوان جديد، مثلًا مع ?v=2.
إذا وصل طلب أحدث للمنتج نفسه تصبح المهمة المفتوحة ersetzt (مستبدَلة).

المخزون في استدعاء المنتج

بالنسبة إلى المتغيرات المعروضة للبيع بالفعل، لا يغيّر استدعاء المنتج المخزون – فهذه مهمة استدعاء المخزون. وتعود قيمة lagerbestand المختلفة كملاحظة stockIgnored. أما المنتجات الجديدة والمتغيرات الجديدة فتأخذ المخزون المرسل.

المؤرشفة والمحظورة والمبيعة بالمتر

استعد المنتجات المؤرشفة من لوحة التحكم؛ ويرد كلٌّ من PUT وPOST بـ 409 productArchived. المنتجات المحظورة: 409 productBlocked. والمنتجات المبيعة بالمتر (الأقمشة) ليست في الواجهة البرمجية بعد: 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 – استلمه نظامك. وحتى 100 دفعة واحدة عبر POST /orders/acknowledge.
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.
أنشئ منتجات عبر الواجهة البرمجية وقدّم طلبات اختبار.

طلب اختبار

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	لم تُفعَّل الواجهة البرمجية لمتجرك بعد.
`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	المنتجات التي تُباع بالمتر غير متاحة في الواجهة البرمجية بعد.
`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 صالحًا (8 أو 12 أو 13 أو 14 رقمًا مع رقم تحقق صحيح).
`ambiguousMatch`	409	«…» يطابق أكثر من منتج موجود (رقم المنتج …).
`parentSkuLocked`	409	للمنتج … بالفعل Übergeordnete SKU «…». غيّر Übergeordnete SKU الموجود من نموذج المنتج.
`parentSkuOfOther`	409	«…» يخص بالفعل منتجك …، لكن eveyamin-Artikelnummer يخص …. يُرجى استخدام Übergeordnete SKU آخر.
`categoryFixed`	ملاحظة	اعتُمدت الفئة بصيغة «…».
`colorFixed`	ملاحظة	اعتُمد اللون «…» بصيغة «…».
`sizeFixed`	ملاحظة	اعتُمد المقاس «…» بصيغة «…».
`imageFailed`	ملاحظة	لم تُعتمد الصورة (…): …

المرجع

كل الاستدعاءات بمعاملاتها وحقولها، مولَّدة مباشرةً من الواجهة نفسها؛ والأوصاف بالألمانية مثل الواجهة البرمجية. ولأدوات 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/v1). تُضاف الحقول والاستدعاءات الجديدة ضمن v1 – لذا تجاهل الحقول التي لا تعرفها. وكل ما قد يعطّل الربط القائم لا يأتي إلا في v2، ويُعلن عنه مسبقًا بوقت كافٍ.

أسئلة حول الربط: info@eveyamin.com.

الدعم الفني

يُفترض أن تمكّن المعلومات الواردة أعلاه فريقك التقني من إتمام عملية التكامل. وإذا احتجت إلى دعم إضافي، فإن شريكنا التقني يسعده مساعدتك في التكامل.