Order

Entidad de pedido. Nota: 1. Todas las cadenas de todos los niveles deben tener menos de 1,000 caracteres, a menos que se especifique lo contrario. 2. Todos los campos repetidos en todos los niveles deben tener un tamaño inferior a 50, a menos que se especifique lo contrario. 3. Si se especifican, todas las marcas de tiempo de todos los niveles deben ser marcas de tiempo válidas.

Representación JSON 
{
  "googleOrderId": string,
  "merchantOrderId": 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.
}
Campos
googleOrderId

string

Es el ID de pedido asignado por Google.
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 128 caracteres.
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.
userVisibleStateLabel
(deprecated)

string

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

object (UserInfo)

información sobre el comprador.
image

object (Image)

Imagen asociada con el pedido.
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".
lastUpdateTime

string (Timestamp format)

y la 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".
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.
contents

object (Contents)

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

object (PriceAttribute)

Precio, descuentos, impuestos, etc.
followUpActions[]

object (Action)

Haz un seguimiento de las acciones a nivel del pedido.
paymentData

object (PaymentData)

Datos relacionados con el pago del pedido.
termsOfServiceUrl

string

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

string

Notas adjuntas a un pedido
promotions[]

object (Promotion)

Son todas las promociones asociadas a este pedido.
disclosures[]

object (Disclosure)

Divulgaciones asociadas con este pedido.
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" }.
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:
purchase

object (PurchaseOrderExtension)

Orden de compra
ticket

object (TicketOrderExtension)

Pedido de entrada

Contenido

Envoltorio para líneas de pedido.

Representación JSON 
{
  "lineItems": [
    {
      object (LineItem)
    }
  ]
}
Campos
lineItems[]

object (LineItem)

Lista de líneas de pedido. Se requiere al menos 1 elemento de una sola línea y se permite un máximo de 50. Todas las líneas de pedido deben pertenecer a la misma vertical.

PaymentData

Son los datos de pago relacionados con un pedido.

Representación JSON 
{
  "paymentResult": {
    object (PaymentResult)
  },
  "paymentInfo": {
    object (PaymentInfo)
  }
}
Campos
paymentResult

object (PaymentResult)

Es el resultado del pago que usa el integrador para completar una transacción. Este campo se propagará con Actions on Google si Actions-on-Google administra la experiencia de confirmación de la compra.
paymentInfo

object (PaymentInfo)

Información de pago relacionada con el pedido que es útil para la interacción del usuario.

PaymentResult

El integrador usa el resultado del pago para completar una transacción.

Representación JSON 
{

  // Union field result can be only one of the following:
  "googlePaymentData": string,
  "merchantPaymentMethodId": string
  // End of list of possible types for union field result.
}
Campos
Campo de unión result. Se proporcionan los datos de Google Payments o una forma de pago de comerciante. Las direcciones (result) solo pueden ser una de las siguientes opciones:
googlePaymentData

string

Google proporcionó los datos de la forma de pago. Si tu procesador de pagos aparece como procesador de pagos compatible con Google aquí: https://developers.google.com/pay/api/ Navega a tu procesador de pagos a través del vínculo para obtener más información. De lo contrario, consulta la siguiente documentación para conocer los detalles de la carga útil. https://developers.google.com/pay/api/payment-data-cryptography
merchantPaymentMethodId

string

Forma de pago proporcionada por el comercio o por la acción elegida por el usuario.

PaymentInfo

Información de pago relacionada con el pedido realizado. Este proto captura información útil para la interacción del usuario.

Representación JSON 
{
  "paymentMethodDisplayInfo": {
    object (PaymentMethodDisplayInfo)
  },
  "paymentMethodProvenance": enum (PaymentMethodProvenance)
}
Campos
paymentMethodDisplayInfo

object (PaymentMethodDisplayInfo)

Es la información visible de la forma de pago que se usó para realizar la transacción.
paymentMethodProvenance

enum (PaymentMethodProvenance)

Procedencia de la forma de pago utilizada para la transacción. Es posible que el usuario haya registrado la misma forma de pago en Google y en el comercio.

PaymentMethodDisplayInfo

El integrador usa el resultado del pago para completar una transacción.

Representación JSON 
{
  "paymentType": enum (PaymentType),
  "paymentMethodDisplayName": string
}
Campos
paymentType

enum (PaymentType)

Es el tipo de pago.
paymentMethodDisplayName

string

Es el nombre visible del usuario de la forma de pago. Por ejemplo, cuenta corriente VISA **** 1234 **** 5678

Promoción

Promociones/ofertas que se agregaron al carrito.

Representación JSON 
{
  "coupon": string
}
Campos
coupon

string

Obligatorio: Se aplicó el código de cupón a esta oferta.

PurchaseOrderExtension

Extensión de pedido para la vertical de compras. Estas propiedades se aplican a todas las líneas de pedido dentro del pedido, a menos que se anulen en una línea de pedido.

Representación JSON 
{
  "status": enum (PurchaseStatus),
  "userVisibleStatusLabel": string,
  "type": enum (PurchaseType),
  "returnsInfo": {
    object (PurchaseReturnsInfo)
  },
  "fulfillmentInfo": {
    object (PurchaseFulfillmentInfo)
  },
  "extension": {
    "@type": string,
    field1: ...,
    ...
  },
  "purchaseLocationType": enum (PurchaseLocationType),
  "errors": [
    {
      object (PurchaseError)
    }
  ]
}
Campos
status

enum (PurchaseStatus)

Obligatorio: Estado general del pedido.
userVisibleStatusLabel

string

Etiqueta o cadena visible para el usuario para el estado. La longitud máxima permitida es de 50 caracteres.
type

enum (PurchaseType)

Obligatorio: Tipo de compra.
returnsInfo

object (PurchaseReturnsInfo)

Devolución de la información del pedido
fulfillmentInfo

object (PurchaseFulfillmentInfo)

Es la información de entrega del pedido.
extension

object

Cualquier campo adicional que se intercambie entre el comercio y Google

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" }.
purchaseLocationType

enum (PurchaseLocationType)

Ubicación de la compra (en la tienda o en línea)
errors[]

object (PurchaseError)

Opcional: Errores por los que se rechazó este pedido

PurchaseError

Errores por los que se puede rechazar una orden de compra.

Representación JSON 
{
  "type": enum (ErrorType),
  "description": string,
  "entityId": string,
  "updatedPrice": {
    object (PriceAttribute)
  },
  "availableQuantity": integer
}
Campos
type

enum (ErrorType)

Obligatorio: Representa el motivo detallado por el que el comercio rechaza un pedido.
description

string

Descripción adicional del error.
entityId

string

El ID de entidad que corresponde al error. Ejemplo que puede corresponder a LineItemId o ItemOptionId.
updatedPrice

object (PriceAttribute)

Es relevante en caso de un tipo de error de PRICE_CHANGED o INCORRECT_PRICE.
availableQuantity

integer

La cantidad está disponible ahora. Se aplica en el caso de AVAILABILITY_CHANGED.

TicketOrderExtension

Pedir contenido para pedidos de entradas como películas, deportes, etc.

Representación JSON 
{
  "ticketEvent": {
    object (TicketEvent)
  }
}
Campos
ticketEvent

object (TicketEvent)

El evento se aplica a todas las entradas de líneas de pedido.

TicketEvent

Representa un evento único.

Representación JSON 
{
  "type": enum (Type),
  "name": string,
  "description": string,
  "url": string,
  "location": {
    object (Location)
  },
  "eventCharacters": [
    {
      object (EventCharacter)
    }
  ],
  "startDate": {
    object (Time)
  },
  "endDate": {
    object (Time)
  },
  "doorTime": {
    object (Time)
  }
}
Campos
type

enum (Type)

Obligatorio: tipo de evento de entrada, p.ej., película, concierto.
name

string

Obligatorio: nombre del evento. Por ejemplo, si el evento es una película, este debe ser el nombre de la película.
description

string

descripción del evento.
url

string

Es la URL de la información del evento.
location

object (Location)

Es la ubicación donde se lleva a cabo el evento o se encuentra una organización.
eventCharacters[]

object (EventCharacter)

Son los personajes relacionados con este evento. Pueden ser directores o actores de un evento cinematográfico, o bien actores de un concierto, etcétera.
startDate

object (Time)

Hora de inicio
endDate

object (Time)

Hora de finalización
doorTime

object (Time)

Hora de entrada, que puede ser diferente de la hora de inicio del evento. p.ej., el evento comienza a las 9 a.m., pero el horario de entrada es a las 8:30 a.m.

EventCharacter

Un carácter de evento, p.ej., organizador, artista, etc.

Representación JSON 
{
  "type": enum (Type),
  "name": string,
  "image": {
    object (Image)
  }
}
Campos
type

enum (Type)

el tipo de carácter del evento, p.ej., es el actor o el director.
name

string

el nombre del personaje.
image

object (Image)

Imágenes del personaje.