REST Resource: sellers.orders

المورد: الطلب

الطلب هو مجموعة من Lines تحدّد حالات عرض الإعلانات ومواضع عرضها.

تمثيل JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  },
  "cancellationReason": enum (CancellationReason)
}
الحقول
name

string

اسم مورد الطلب. التنسيق: Sellers/{seller}/orders/{order}
externalId

string

رقم تعريف يتم استخدامه لربط هذا الكيان بمصادر خارجية.
displayName

string

تمثّل هذه السمة الاسم المعروض للطلب.

يجب أن يكون بترميز UTF-8 بحيث لا يزيد حجمه عن 240 بايت.
description

string

حقل إضافي حر لوصف الطلب
state

enum (State)

النتائج فقط. حالة الطلب.

يمكن للبائع استخدام الطريقتَين المخصّصتَين التاليتَين: orders.completeOrderReservation وorders.completeOrderBooking لضبطهما على إحدى الطريقتَين التاليتَين:

  • STATE_RESERVATION_COMPLETE
  • STATE_BOOKING_COMPLETE.

ويضبط المشتري جميع حالات الطلبات الأخرى.
createTime

string (Timestamp format)

النتائج فقط. الطابع الزمني لإنشاء الطلب

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

النتائج فقط. آخر تعديل للطابع الزمني للطلب

طابع زمني بتنسيق RFC3339 حسب التوقيت العالمي المنسَّق (UTC) "زولو" بدقة نانوثانية وما يصل إلى تسعة أرقام كسرية. أمثلة: "2014-10-02T15:01:23Z" و"2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

معلومات المعلِن
cancellationReason

enum (CancellationReason)

النتائج فقط. سبب الإلغاء:

الحالة

حالة الطلب.

عمليات التعداد
STATE_UNSPECIFIED القيمة التلقائية عندما لا يتم تحديد حالة الطلب أو عندما تكون غير معروفة في هذا الإصدار.
STATE_PENDING_RESERVATION

يحتوي الطلب على:

  • سطر واحد أو أكثر في حالة الحجز المعلّق.
  • سطور صفرية أو أكثر في الحالة المحجوزة.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_RESERVATION_COMPLETE

يحتوي الطلب على:

  • سطر واحد أو أكثر إما محجوزًا أو مرفوضًا من قِبل ولايات البائعين.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_PENDING_BOOKING

يحتوي الطلب على:

  • سطر واحد أو أكثر إما في الحجز المُعلّق أو تم رفضه من قِبل ولايات البائعين.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_BOOKING_COMPLETE

يحتوي الطلب على:

  • سطر واحد أو أكثر إما محجوزًا أو مرفوضًا من قِبل ولايات البائعين.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_CANCELLED_BY_BUYER

يحتوي الطلب على:

  • سطر واحد أو أكثر إما مُلغاة من قِبل المشتري أو تم رفضها من قِبل ولايات البائعين.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_PENDING_RESERVATION_EXPIRED

يحتوي الطلب على:

  • انتهت صلاحية سطر واحد أو أكثر في الحجز المعلّق.
  • صفر أسطر في جميع الحالات الأخرى.
STATE_RESERVED_EXPIRED

يحتوي الطلب على:

  • سطر واحد أو أكثر في العناوين المحجوزة.
  • صفر أسطر في جميع الحالات الأخرى.

CancellationReason

تمثّل هذه السمة سبب الإلغاء في حال إلغاء الطلب.

عمليات التعداد
CANCELLATION_REASON_UNSPECIFIED القيمة التلقائية عندما لا يتم تحديد سبب الإلغاء أو عندما يكون غير معروف في هذا الإصدار.
CANCELLATION_REASON_BUYER_REQUESTED طلب المشتري إلغاء الطلب.
CANCELLATION_REASON_INVALID_ADVERTISER_INFO معلومات المعلن المقدّمة غير صالحة.

الطُرق

completeOrderBooking

 يكمل حجز الطلب.

completeOrderReservation

 يكمل حجز الطلب.

create

 ينشئ طلبًا جديدًا.

get

 لاسترداد طلب فردي.

list

 يسرد الطلبات.

patch

 لتعديل طلب حالي