Method: orders.patch

Actualiza el pedido de 3p a AOG. Muestra INVALID_ARGUMENT si el ID del pedido está vacío o no es igual a un pedido existente.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
orderUpdate.order.merchantOrderId

string

Obligatorio: ID de pedido interno asignado por el comercio. Este ID debe ser único y se requiere para las operaciones posteriores de actualización de pedidos. Este ID se puede establecer en el googleOrderId proporcionado o cualquier otro valor único. Ten en cuenta que el ID que se muestra a los usuarios es userVisibleOrderId, que puede ser un valor diferente y más fácil de usar. La longitud máxima permitida es de 64 caracteres.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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
  }
}
Campos
header

object (OrderRequestHeader)

Encabezado de la solicitud de actualización del pedido.

orderUpdate.type
(deprecated)

enum (Type)

Obsoleto: Usa OrderUpdate.update_mask en su lugar. Si el tipo es SNAPSHOT, OrderUpdate.order debería ser el pedido completo. Si el tipo es ORDER_STATUS, este es el cambio de estado a nivel del pedido. Solo se recogen order.last_update_time y este estado vertical. Nota: type.ORDER_STATUS solo admite actualizaciones de estado de PurcahaseOrderExtension y no hay un plan para extender esta compatibilidad. En su lugar, recomendamos usar updateMask, ya que es más genérico, extensible y se puede usar en todas las verticales.

orderUpdate.order.googleOrderId

string

Es el ID de pedido asignado por Google.

orderUpdate.order.userVisibleOrderId

string

El ID visible para el usuario que hace referencia al pedido actual. Este ID debe ser coherente con el que se muestra para este pedido en otros contextos, como sitios web, aplicaciones y correo electrónico.

orderUpdate.order.userVisibleStateLabel
(deprecated)

string

Obsoleto: usa el estado OrderExtensions en su lugar. Etiqueta visible para el usuario para el estado de este pedido.

orderUpdate.order.buyerInfo

object (UserInfo)

Información sobre el comprador.

orderUpdate.order.image

object (Image)

Imagen asociada con el pedido.

orderUpdate.order.createTime

string (Timestamp format)

Obligatorio: Fecha y hora en que se creó el pedido.

Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.lastUpdateTime

string (Timestamp format)

Fecha y hora en que se actualizó el pedido por última vez. Obligatorio para OrderUpdate.

Es una marca de tiempo en el formato RFC3339 UTC "Zulu", con precisión de nanosegundos. Ejemplo: "2014-10-02T15:01:23.045123456Z".
orderUpdate.order.transactionMerchant

object (Merchant)

Comercio que facilitó la confirmación de la compra. Puede ser diferente de la de un proveedor a nivel de la línea de pedido. Ejemplo: Pedido de Expedia con un elemento de una sola línea de ANA.

orderUpdate.order.contents

object (Contents)

Obligatorio: El contenido del pedido es un grupo de líneas de pedido.

orderUpdate.order.priceAttributes[]

object (PriceAttribute)

Precio, descuentos, impuestos, etc.

orderUpdate.order.followUpActions[]

object (Action)

Haz un seguimiento de las acciones a nivel del pedido.

orderUpdate.order.paymentData

object (PaymentData)

Datos relacionados con el pago del pedido.

orderUpdate.order.termsOfServiceUrl

string

Un vínculo a las condiciones del servicio que se aplican al pedido/pedido propuesto.

orderUpdate.order.note

string

Notas adjuntas a un pedido

orderUpdate.order.promotions[]

object (Promotion)

Son todas las promociones asociadas a este pedido.

orderUpdate.order.disclosures[]

object (Disclosure)

Divulgaciones asociadas con este pedido.

orderUpdate.order.vertical
(deprecated)

object

Obsoleto: Usa verticales en su lugar. Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en alguna. Esta vertical debe coincidir con el tipo de vertical a nivel de la línea de pedido. Valores posibles: google.actions.orders.v3.verticals.purchase.PurchaseOrderExtension google.actions.orders.v3.verticals.ticket.TicketOrderExtension

Un objeto que contiene campos de un tipo arbitrario. Un campo adicional "@type" contiene una URI que identifica el tipo. Ejemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.
orderUpdate.updateMask

string (FieldMask format)

Nota: Existen consideraciones o recomendaciones para los siguientes campos especiales: 1. order.last_update_time siempre se actualizará como parte de la solicitud de actualización. 2. Se ignorará order.create_time, order.google_order_id y order.merchant_order_id si se proporcionan como parte de updateMask.

Una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".
orderUpdate.userNotification

object (UserNotification)

Si se especifica, muestra una notificación al usuario con el título y el texto especificados. Especificar una notificación es una sugerencia para notificar y no se garantiza que genere una notificación.

orderUpdate.reason

string

Motivo del cambio o la actualización.

Campo de unión verticals. Estas propiedades se aplicarán a todas las líneas de pedido, a menos que se anulen en alguna. Esta vertical debe coincidir con el tipo de vertical a nivel de la línea de pedido. Las direcciones (verticals) solo pueden ser una de las siguientes opciones:
orderUpdate.order.purchase

object (PurchaseOrderExtension)

Orden de compra

orderUpdate.order.ticket

object (TicketOrderExtension)

Pedido de entrada

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Order.

OrderUpdate

Actualización de un pedido.

Representación JSON 
{
  "type": enum (Type),
  "order": {
    object (Order)
  },
  "updateMask": string,
  "userNotification": {
    object (UserNotification)
  },
  "reason": string
}
Campos
type
(deprecated)

enum (Type)

Obsoleto: Usa OrderUpdate.update_mask en su lugar. Si el tipo es SNAPSHOT, OrderUpdate.order debería ser el pedido completo. Si el tipo es ORDER_STATUS, este es el cambio de estado a nivel del pedido. Solo se recogen order.last_update_time y este estado vertical. Nota: type.ORDER_STATUS solo admite actualizaciones de estado de PurcahaseOrderExtension y no hay un plan para extender esta compatibilidad. En su lugar, recomendamos usar updateMask, ya que es más genérico, extensible y se puede usar en todas las verticales.
order

object (Order)
updateMask

string (FieldMask format)

Nota: Existen consideraciones o recomendaciones para los siguientes campos especiales: 1. order.last_update_time siempre se actualizará como parte de la solicitud de actualización. 2. Se ignorará order.create_time, order.google_order_id y order.merchant_order_id si se proporcionan como parte de updateMask.

Una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".
userNotification

object (UserNotification)

Si se especifica, muestra una notificación al usuario con el título y el texto especificados. Especificar una notificación es una sugerencia para notificar y no se garantiza que genere una notificación.

reason

string

Motivo del cambio o la actualización.

Tipo

Obsoleto: Usa OrderUpdate.update_mask en su lugar. Permitir las actualizaciones de un pedido

Enumeraciones
TYPE_UNSPECIFIED Tipo sin especificar; no se debe configurar de forma explícita.
ORDER_STATUS Solo actualiza el estado del pedido.
SNAPSHOT Instantánea del pedido de actualización.

UserNotification

Notificación opcional al usuario que se mostrará como parte de la actualización del pedido.

Representación JSON 
{
  "title": string,
  "text": string
}
Campos
title

string

Es el título de la notificación al usuario. La longitud máxima permitida es de 30 caracteres.

text

string

El contenido de la notificación. La longitud máxima permitida es de 100 caracteres.