تعديل بيانات المتجر

تعديل حقول محددة

لا تحتاج إلى إرسال جميع بيانات المنتج لتعديل وصفه. أرسل في طلب PATCH الحقول التي تعدّلها والحقول الأخرى المطلوبة لهذه العملية. تبقى بقية بيانات المنتج كما هي.

حقل محذوف من الطلب

تبقى قيمته دون تغيير.

null

يؤدي إرسال null إلى حذف القيمة إذا كان الحقل يسمح بذلك. راجع وصف العملية.

سلسلة فارغة

تعني "" نصًا فارغًا. وهي تختلف عن null، ولا تقبلها جميع الحقول.

في هذا المثال نحذف وصف المنتج باللغة الألمانية. يبقى اسم المنتج وأوصافه باللغات الأخرى كما هي.

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request PATCH \
  --url 'https://shop.onshopently.com/api/v1/products/example?locale=de' \
  --header 'Authorization: Bearer EXAMPLE_ACCESS_TOKEN' \
  --header 'Idempotency-Key: example-product-clear-translation' \
  --header 'Content-Type: application/json' \
  --data-raw '{"description":null,"expected_version":1}'

{
  "data": {
    "deleted": false,
    "id": "example",
    "version": 2
  },
  "meta": {
    "request_id": "example"
  }
}

إذا لم يصلك رد

عدم وصول الرد لا يعني بالضرورة أن التعديل لم يُحفظ. ربما انقطع الاتصال بعد حفظ التعديل.

عند حفظ البيانات، أضف الترويسة Idempotency-Key بقيمة فريدة. إذا لم تتلقَّ استجابة وأعدت محاولة التغيير نفسه، فاستخدم المفتاح والعنوان والطريقة ومحتوى الطلب نفسها.

إذا كانت API قد حفظت نتيجة هذا الطلب بالفعل، فستعيدها دون تنفيذ التغيير مرة أخرى. استخدم مفتاحًا جديدًا لتغيير مختلف.

تؤدي إعادة استخدام مفتاح لطلب مختلف إلى idempotency.key_reused.

إذا عدّل شخص آخر البيانات نفسها

اجلب البيانات الحالية قبل تغييرها. إذا كانت العملية تتطلب expected_version، فأدخل الإصدار الذي تلقيته في هذا الحقل.

إذا غيّر شخص آخر البيانات في هذه الأثناء، فسترفض API الحفظ. اجلبها مجددًا وتحقق من أن التغيير المقصود ما زال مناسبًا. بعد ذلك فقط أرسل طلبًا جديدًا بالإصدار الحالي.

قد يتطلب تغيير السعر أيضًا إصدار السعر أو المتغير أو قائمة الأسعار. ستجد الحقول المطلوبة في وصف العملية.