Method: orders.patch

Обновить заказ с 3p на AOG. Возвращает INVALID_ARGUMENT, если идентификатор заказа пуст или не равен существующему заказу.

HTTP-запрос

PATCH https://actions.googleapis.com/v3/orders/{orderUpdate.order.merchantOrderId}

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
orderUpdate.order.merchantOrderId

string

Обязательно: внутренний идентификатор заказа, присвоенный продавцом. Этот идентификатор должен быть уникальным и необходим для последующих операций обновления заказа. Этот идентификатор может быть установлен в соответствии с предоставленным googleOrderId или любым другим уникальным значением. Обратите внимание, что идентификатор, предоставляемый пользователям, — это userVisibleOrderId, который может иметь другое, более удобное для пользователя значение. Максимально допустимая длина — 64 символа.

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "header": {
    object (OrderRequestHeader)
  },
  "orderUpdate": {
    "type": enum (Type),
    "order": {
      "googleOrderId": string,
      "userVisibleOrderId": string,
      "userVisibleStateLabel": string,
      "buyerInfo": {
        object (UserInfo)
      },
      "image": {
        object (Image)
      },
      "createTime": string,
      "lastUpdateTime": string,
      "transactionMerchant": {
        object (Merchant)
      },
      "contents": {
        object (Contents)
      },
      "priceAttributes": [
        {
          object (PriceAttribute)
        }
      ],
      "followUpActions": [
        {
          object (Action)
        }
      ],
      "paymentData": {
        object (PaymentData)
      },
      "termsOfServiceUrl": string,
      "note": string,
      "promotions": [
        {
          object (Promotion)
        }
      ],
      "disclosures": [
        {
          object (Disclosure)
        }
      ],
      "vertical": {
        "@type": string,
        field1: ...,
        ...
      },

      // Union field verticals can be only one of the following:
      "purchase": {
        object (PurchaseOrderExtension)
      },
      "ticket": {
        object (TicketOrderExtension)
      }
      // End of list of possible types for union field verticals.
    },
    "updateMask": string,
    "userNotification": {
      object (UserNotification)
    },
    "reason": string
  }
}
Поля
header

object ( OrderRequestHeader )

Заголовок запроса на обновление.

orderUpdate.type
(deprecated)

enum ( Type )

Устарело: вместо этого используйте OrderUpdate.update_mask. Если тип = SNAPSHOT, OrderUpdate.order должен содержать весь заказ. Если тип = ORDER_STATUS, это изменение статуса уровня заказа. Подхватываются только order.last_update_time и этот вертикальный статус. Примечание. type.ORDER_STATUS поддерживает только обновления статуса PurcahaseOrderExtension, и расширение этой поддержки не планируется. Вместо этого мы рекомендуем использовать updateMask, поскольку он более универсальный, расширяемый и может использоваться для всех вертикалей.

orderUpdate.order.googleOrderId

string

Google присвоил идентификатор заказа.

orderUpdate.order.userVisibleOrderId

string

Идентификатор пользователя, ссылающийся на текущий заказ. Этот идентификатор должен соответствовать идентификатору, отображаемому для этого заказа в других контекстах, включая веб-сайты, приложения и электронную почту.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Устарело: вместо этого используйте статус OrderExtensions. Видимая пользователем метка состояния этого заказа.

orderUpdate.order.buyerInfo

object ( UserInfo )

Информация о покупателе.

orderUpdate.order.image

object ( Image )

Изображение, связанное с заказом.

orderUpdate.order.createTime

string ( Timestamp format)

Обязательно: дата и время создания заказа.

Временная метка в формате RFC3339 UTC «Зулу» с точностью до наносекунд. Пример: "2014-10-02T15:01:23.045123456Z" .

orderUpdate.order.lastUpdateTime

string ( Timestamp format)

Дата и время последнего обновления заказа. Требуется для OrderUpdate.

Временная метка в формате RFC3339 UTC «Зулу» с точностью до наносекунд. Пример: "2014-10-02T15:01:23.045123456Z" .

orderUpdate.order.transactionMerchant

object ( Merchant )

Продавец, который облегчил оформление заказа. Это может отличаться от поставщика уровня позиции. Пример: заказ Expedia с позицией от ANA.

orderUpdate.order.contents

object ( Contents )

Обязательно: содержимое заказа, которое представляет собой группу позиций.

orderUpdate.order.priceAttributes[]

object ( PriceAttribute )

Цена, скидки, налоги и так далее.

orderUpdate.order.followUpActions[]

object ( Action )

Последующие действия на уровне заказа.

orderUpdate.order.paymentData

object ( PaymentData )

Данные, связанные с оплатой заказа.

orderUpdate.order.termsOfServiceUrl

string

Ссылка на условия обслуживания, применимые к заказу/предложенному заказу.

orderUpdate.order.note

string

Примечания, прилагаемые к заказу.

orderUpdate.order.promotions[]

object ( Promotion )

Все акции, которые связаны с этим заказом.

orderUpdate.order.disclosures[]

object ( Disclosure )

Раскрытие информации, связанное с этим приказом.

orderUpdate.order.vertical
(deprecated)

object

Устарело: вместо этого используйте вертикали. Эти свойства будут применяться ко всем позициям, если они не будут переопределены в какой-либо позиции. Эта тематика должна соответствовать типу вертикали на уровне позиции. Возможные значения: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Объект, содержащий поля произвольного типа. Дополнительное поле "@type" содержит URI, идентифицирующий тип. Пример: { "id": 1234, "@type": "types.example.com/standard/id" } .

orderUpdate.updateMask

string ( FieldMask format)

Примечание. Существуют следующие соображения/рекомендации для следующих специальных полей: 1. order.last_update_time всегда будет обновляться как часть запроса на обновление. 2. order.create_time, order.google_order_id и order.merchant_order_id будут игнорироваться, если они указаны как часть updateMask.

Список полных имен полей, разделенных запятыми. Пример: "user.displayName,photo" .

orderUpdate.userNotification

object ( UserNotification )

Если указано, отображает пользователю уведомление с указанным заголовком и текстом. Указание уведомления — это предложение об уведомлении, которое не обязательно приведет к отправке уведомления.

orderUpdate.reason

string

Причина изменения/обновления.

verticals полей объединения. Эти свойства будут применяться ко всем позициям, если они не будут переопределены в какой-либо позиции. Эта тематика должна соответствовать типу вертикали на уровне позиции. verticals могут быть только одним из следующих:
orderUpdate.order.purchase

object ( PurchaseOrderExtension )

Заказ на покупку

orderUpdate.order.ticket

object ( TicketOrderExtension )

Заказ билетов

Тело ответа

В случае успеха тело ответа содержит экземпляр Order .

Обновление заказа

Обновление заказа.

JSON-представление 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Поля
type
(deprecated)

enum ( Type )

Устарело: вместо этого используйте OrderUpdate.update_mask. Если тип = SNAPSHOT, OrderUpdate.order должен содержать весь заказ. Если тип = ORDER_STATUS, это изменение статуса уровня заказа. Подхватываются только order.last_update_time и этот вертикальный статус. Примечание. type.ORDER_STATUS поддерживает только обновления статуса PurcahaseOrderExtension, и расширение этой поддержки не планируется. Вместо этого мы рекомендуем использовать updateMask, поскольку он более универсальный, расширяемый и может использоваться для всех вертикалей.

order

object ( Order )

updateMask

string ( FieldMask format)

Примечание. Существуют следующие соображения/рекомендации для следующих специальных полей: 1. order.last_update_time всегда будет обновляться как часть запроса на обновление. 2. order.create_time, order.google_order_id и order.merchant_order_id будут игнорироваться, если они указаны как часть updateMask.

Список полных имен полей, разделенных запятыми. Пример: "user.displayName,photo" .

userNotification

object ( UserNotification )

Если указано, отображает пользователю уведомление с указанным заголовком и текстом. Указание уведомления — это предложение об уведомлении, которое не обязательно приведет к отправке уведомления.

reason

string

Причина изменения/обновления.

Тип

Устарело: вместо этого используйте OrderUpdate.update_mask. Разрешено обновление заказа.

Перечисления
TYPE_UNSPECIFIED Тип не указан, не следует задавать это явно.
ORDER_STATUS Только обновлять статус заказа.
SNAPSHOT Обновить снимок заказа.

Уведомление пользователя

Необязательное уведомление пользователя, которое будет отображаться как часть обновления заказа.

JSON-представление 
{
  "title": string,
  "text": string
}
Поля
title

string

Заголовок уведомления пользователя. Максимально допустимая длина — 30 символов.

text

string

Содержание уведомления. Максимально допустимая длина — 100 символов.